gcloud alpha pam check-onboarding-status

NAME

gcloud alpha pam check-onboarding-status - check Privileged Access Manager onboarding status for a resource

SYNOPSIS

gcloud alpha pam check-onboarding-status (--location=LOCATION : --folder=FOLDER --organization=ORGANIZATION) [GCLOUD_WIDE_FLAG …]

DESCRIPTION

(ALPHA) Check Privileged Access Manager (PAM) onboarding status for a project/organization/folder location.

EXAMPLES

The following command checks the PAM onboarding status for a project named sample-project and in location global:

gcloud alpha pam check-onboarding-status --project=sample-project --location=global

The following command checks the PAM onboarding status for a folder with ID FOLDER_ID and in location global:

gcloud alpha pam check-onboarding-status --folder=FOLDER_ID --location=global

The following command checks the PAM onboarding status for an organization with ID ORGANIZATION_ID and in location global:

gcloud alpha pam check-onboarding-status --organization=ORGANIZATION_ID --location=global

REQUIRED FLAGS

Location resource - The project/organization/folder location for which the onboarding status is to be checked. The arguments in this group can be used to specify the attributes of this resource. (NOTE) Some attributes are not given arguments in this group but can be set in other ways.

To set the project attribute:

• provide the argument --location on the command line with a fully specified name;
• provide the argument --project on the command line;
• set the property core/project. This resource can be one of the following 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 the location attribute:

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

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

--folder=FOLDER

The name of the folder

To set the folder attribute:

• provide the argument --location on the command line with a fully specified name;
• provide the argument --folder on the command line. Must be specified for resource of type [privilegedaccessmanager.folders.locations].

--organization=ORGANIZATION

The name of the organization

To set the organization attribute:

• provide the argument --location on the command line with a fully specified name;
• provide the argument --organization on the command line. Must be specified 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 the privilegedaccessmanager/v1alpha API. The full documentation for this API can be found at: https://cloud.google.com/iam/docs/pam-overview

NOTES

This command is currently in alpha and might change without notice. If this command fails with API permission errors despite specifying the correct project, you might be trying to access an API with an invitation-only early access allowlist. These variants are also available:

gcloud pam check-onboarding-status

gcloud beta pam check-onboarding-status