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
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2024-09-17 UTC."],[[["The `locations.checkOnboardingStatus` 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."],["The HTTP request to check the onboarding status is a `GET` request to the specified URL, which uses gRPC Transcoding syntax, and requires a `parent` path parameter."],["The `parent` parameter is a string representing the resource, in formats like `projects/{project-number|project-id}/locations/{region}`, `folders/{folder-number}/locations/{region}`, or `organizations/{organization-number}/locations/{region}`."],["The request body for checking the onboarding status must be empty, and a successful response will include an instance of `CheckOnboardingStatusResponse`."],["This API requires the OAuth scope `https://www.googleapis.com/auth/cloud-platform` and the IAM permission `privilegedaccessmanager.locations.checkOnboardingStatus` on the `parent` resource."]]],[]]
