gcloud pam check-onboarding-status

NAME
gcloud pam check-onboarding-status - check Privileged Access Manager onboarding status for a resource
SYNOPSIS
gcloud pam check-onboarding-status(--location=LOCATION :--folder=FOLDER--organization=ORGANIZATION)[GCLOUD_WIDE_FLAG]
DESCRIPTION
Check Privileged Access Manager (PAM) onboarding status for aproject/organization/folder location.
EXAMPLES
The following command checks the PAM onboarding status for a project namedsample-project and in locationglobal:
gcloudpamcheck-onboarding-status--project=sample-project--location=global

The following command checks the PAM onboarding status for a folder with IDFOLDER_ID and in locationglobal:

gcloudpamcheck-onboarding-status--folder=FOLDER_ID--location=global

The following command checks the PAM onboarding status for an organization withIDORGANIZATION_ID and in locationglobal:

gcloudpamcheck-onboarding-status--organization=ORGANIZATION_ID--location=global
REQUIRED FLAGS
Location resource - The project/organization/folder location for which theonboarding status is to be checked. The arguments in this group can be used tospecify the attributes of this resource. (NOTE) Some attributes are not givenarguments in this group but can be set in other ways.

To set theproject attribute:

  • provide the argument--location on the command line with a fullyspecified name;
  • provide the argument--project on the command line;
  • set the propertycore/project. This resource can be one of thefollowing types: [privilegedaccessmanager.projects.locations,privilegedaccessmanager.folders.locations,privilegedaccessmanager.organizations.locations].

This must be specified.

--location=LOCATION
ID of the location or fully qualified identifier for the location.

To set thelocation attribute:

  • provide the argument--location on the command line.

This flag argument must be specified if any of the other arguments in this groupare specified.

--folder=FOLDER
The name of the folder

To set thefolder attribute:

  • provide the argument--location on the command line with a fullyspecified name;
  • provide the argument--folder on the command line. Must bespecified for resource of type [privilegedaccessmanager.folders.locations].
--organization=ORGANIZATION
The name of the organization

To set theorganization attribute:

  • provide the argument--location on the command line with a fullyspecified name;
  • provide the argument--organization on the command line. Must bespecified for resource of type[privilegedaccessmanager.organizations.locations].
GCLOUD WIDE FLAGS
These flags are available to all commands:--access-token-file,--account,--billing-project,--configuration,--flags-file,--flatten,--format,--help,--impersonate-service-account,--log-http,--project,--quiet,--trace-token,--user-output-enabled,--verbosity.

Run$gcloud help for details.

API REFERENCE
This command uses theprivilegedaccessmanager/v1 API. The fulldocumentation for this API can be found at:https://cloud.google.com/iam/docs/pam-overview
NOTES
These variants are also available:
gcloudalphapamcheck-onboarding-status
gcloudbetapamcheck-onboarding-status

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-05-07 UTC.