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/v1beta/{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."],[[["\u003cp\u003eThe \u003ccode\u003elocations.checkOnboardingStatus\u003c/code\u003e API endpoint is used to determine the onboarding status of a project, folder, or organization, which must be resolved prior to using PAM on the resource.\u003c/p\u003e\n"],["\u003cp\u003eThe HTTP request to check the onboarding status is a \u003ccode\u003eGET\u003c/code\u003e request to the specified URL, which uses gRPC Transcoding syntax, and requires a \u003ccode\u003eparent\u003c/code\u003e path parameter.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eparent\u003c/code\u003e parameter is a string representing the resource, in formats like \u003ccode\u003eprojects/{project-number|project-id}/locations/{region}\u003c/code\u003e, \u003ccode\u003efolders/{folder-number}/locations/{region}\u003c/code\u003e, or \u003ccode\u003eorganizations/{organization-number}/locations/{region}\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eThe request body for checking the onboarding status must be empty, and a successful response will include an instance of \u003ccode\u003eCheckOnboardingStatusResponse\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eThis API requires the OAuth scope \u003ccode\u003ehttps://www.googleapis.com/auth/cloud-platform\u003c/code\u003e and the IAM permission \u003ccode\u003eprivilegedaccessmanager.locations.checkOnboardingStatus\u003c/code\u003e on the \u003ccode\u003eparent\u003c/code\u003e resource.\u003c/p\u003e\n"]]],[],null,[]]
