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 2025-05-21 UTC."],[[["\u003cp\u003eThis webpage details the \u003ccode\u003elocations.checkOnboardingStatus\u003c/code\u003e 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.\u003c/p\u003e\n"],["\u003cp\u003eThe API endpoint is a \u003ccode\u003eGET\u003c/code\u003e request structured as \u003ccode\u003ehttps://privilegedaccessmanager.googleapis.com/v1/{parent=folders/*/locations/*}:checkOnboardingStatus\u003c/code\u003e, and utilizes gRPC Transcoding syntax.\u003c/p\u003e\n"],["\u003cp\u003eThe required path parameter, \u003ccode\u003eparent\u003c/code\u003e, specifies the resource to be checked and must follow one of the provided formats for projects, folders, or organizations.\u003c/p\u003e\n"],["\u003cp\u003eThe API request requires an empty request body, and the successful response will contain a \u003ccode\u003eCheckOnboardingStatusResponse\u003c/code\u003e instance.\u003c/p\u003e\n"],["\u003cp\u003eTo use this API, the caller must possess the \u003ccode\u003eprivilegedaccessmanager.locations.checkOnboardingStatus\u003c/code\u003e IAM permission on the specified parent resource and have the \u003ccode\u003ehttps://www.googleapis.com/auth/cloud-platform\u003c/code\u003e OAuth scope.\u003c/p\u003e\n"]]],[],null,[]]
