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 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,["# Method: folders.locations.checkOnboardingStatus\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n- [Authorization scopes](#body.aspect)\n- [IAM Permissions](#body.aspect_1)\n- [Examples](#examples)\n- [Try it!](#try-it)\n\n`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.\n\n### HTTP request\n\n`GET https://privilegedaccessmanager.googleapis.com/v1beta/{parent=folders/*/locations/*}:checkOnboardingStatus`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nIf successful, the response body contains an instance of [CheckOnboardingStatusResponse](/iam/docs/reference/pam/rest/v1beta/CheckOnboardingStatusResponse).\n\n### Authorization scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/cloud-platform`\n\nFor more information, see the [Authentication Overview](https://cloud.google.com/docs/authentication/).\n\n### IAM Permissions\n\nRequires the following [IAM](https://cloud.google.com/iam/docs) permission on the `parent` resource:\n\n- `privilegedaccessmanager.locations.checkOnboardingStatus`\n\nFor more information, see the [IAM documentation](https://cloud.google.com/iam/docs)."]]
