Method: projects.locations.checkOnboardingStatus

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/v1/{parent=projects/*/locations/*}:checkOnboardingStatus

The URL usesgRPC Transcoding syntax.

Path parameters

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 ofCheckOnboardingStatusResponse.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see theAuthentication Overview.

IAM Permissions

Requires the followingIAM permission on theparent resource:

  • privilegedaccessmanager.locations.checkOnboardingStatus

For more information, see theIAM documentation.

Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2025-09-26 UTC.