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/v1beta/{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 webpage details the `locations.checkOnboardingStatus` API, which is used to determine the onboarding status of a project, folder, or organization for the Privileged Access Manager (PAM)."],["The API request is a `GET` request to a specific URL endpoint, with the target resource's path specified in the `parent` parameter of the URL."],["The request body for this API must be empty, and the response will include the onboarding status information in the `CheckOnboardingStatusResponse` format."],["To successfully use this API, you need the `https://www.googleapis.com/auth/cloud-platform` OAuth scope and the `privilegedaccessmanager.locations.checkOnboardingStatus` IAM permission on the parent resource."],["Findings reported by this API need to be addressed before PAM can be used on the respective resource."]]],[]]
