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
[[["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."],[[["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."]]],[]]
