- HTTP request
- Path parameters
- Request body
- Response body
- Authorization scopes
- IAM Permissions
- Examples
- Try it!
locations.checkOnboardingStatus
reports the onboarding status for a project, folder, or 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
The URL uses gRPC Transcoding syntax.
Path parameters
parent
string
Required. The resource for which the onboarding status should be checked. Should be in one of the following formats:
-
projects/{project-number|project-id}/locations/{region} -
folders/{folder-number}/locations/{region} -
organizations/{organization-number}/locations/{region}
Request body
The request body must be empty.
Response body
If successful, the response body contains an instance of CheckOnboardingStatusResponse
.
Authorization scopes
Requires the following OAuth scope:
-
https://www.googleapis.com/auth/cloud-platform
For more information, see the Authentication Overview .
IAM Permissions
Requires the following IAM
permission on the parent
resource:
-
privilegedaccessmanager.locations.checkOnboardingStatus
For more information, see the IAM documentation .
