Method: projects.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=projects/*/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 API endpoint `locations.checkOnboardingStatus` checks the onboarding status of a project, folder, or organization, which must be resolved before using PAM."],["The HTTP request is a `GET` method targeting a specific resource path, formatted as `https://privilegedaccessmanager.googleapis.com/v1/{parent=projects/*/locations/*}:checkOnboardingStatus`."],["The `parent` path parameter is required and defines the resource (project, folder, or organization) to check, adhering to specified formats."],["The request body must be empty for this API call, and the response will be an instance of `CheckOnboardingStatusResponse`."],["To successfully use this API you will require the OAuth scope `https://www.googleapis.com/auth/cloud-platform`, and the IAM permission `privilegedaccessmanager.locations.checkOnboardingStatus`."]]],[]]
