Method: folders.locations.checkOnboardingStatus
locations.checkOnboardingStatus reports the onboarding status for a project/folder/organization. Any findings reported by this API need to be fixed before PAM can be used on the resource.
HTTP request
GET https://privilegedaccessmanager.googleapis.com/v1/{parent=folders/*/locations/*}:checkOnboardingStatus
The URL uses gRPC Transcoding syntax.
Path parameters
| Parameters |
parent |
string
Required. The resource for which the onboarding status should be checked. Should be in one of the following formats:
projects/{project-number|project-id}/locations/{region}folders/{folder-number}/locations/{region}organizations/{organization-number}/locations/{region}
|
Request body
The request body must be empty.
Response body
If successful, the response body contains an instance of CheckOnboardingStatusResponse.
Authorization scopes
Requires the following OAuth scope:
https://www.googleapis.com/auth/cloud-platform
For more information, see the Authentication Overview.
IAM Permissions
Requires the following IAM permission on the parent resource:
privilegedaccessmanager.locations.checkOnboardingStatus
For more information, see the IAM documentation.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-05-21 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-05-21 UTC."],[[["This webpage details the `locations.checkOnboardingStatus` API, which is used to determine the onboarding status of a project, folder, or organization, with any reported issues needing resolution before PAM can be used."],["The API endpoint is a `GET` request structured as `https://privilegedaccessmanager.googleapis.com/v1/{parent=folders/*/locations/*}:checkOnboardingStatus`, and utilizes gRPC Transcoding syntax."],["The required path parameter, `parent`, specifies the resource to be checked and must follow one of the provided formats for projects, folders, or organizations."],["The API request requires an empty request body, and the successful response will contain a `CheckOnboardingStatusResponse` instance."],["To use this API, the caller must possess the `privilegedaccessmanager.locations.checkOnboardingStatus` IAM permission on the specified parent resource and have the `https://www.googleapis.com/auth/cloud-platform` OAuth scope."]]],[]]
