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=projects/*/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 for the Privileged Access Manager (PAM).\u003c/p\u003e\n"],["\u003cp\u003eThe API request is a \u003ccode\u003eGET\u003c/code\u003e request to a specific URL endpoint, with the target resource's path specified in the \u003ccode\u003eparent\u003c/code\u003e parameter of the URL.\u003c/p\u003e\n"],["\u003cp\u003eThe request body for this API must be empty, and the response will include the onboarding status information in the \u003ccode\u003eCheckOnboardingStatusResponse\u003c/code\u003e format.\u003c/p\u003e\n"],["\u003cp\u003eTo successfully use this API, you need the \u003ccode\u003ehttps://www.googleapis.com/auth/cloud-platform\u003c/code\u003e OAuth scope and the \u003ccode\u003eprivilegedaccessmanager.locations.checkOnboardingStatus\u003c/code\u003e IAM permission on the parent resource.\u003c/p\u003e\n"],["\u003cp\u003eFindings reported by this API need to be addressed before PAM can be used on the respective resource.\u003c/p\u003e\n"]]],[],null,["# Method: projects.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=projects/*/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)."]]
