.TH "GCLOUD_PAM_CHECK\-ONBOARDING\-STATUS" 1



.SH "NAME"
.HP
gcloud pam check\-onboarding\-status \- check Privileged Access Manager onboarding status for a resource



.SH "SYNOPSIS"
.HP
\f5gcloud pam check\-onboarding\-status\fR (\fB\-\-location\fR=\fILOCATION\fR\ :\ \fB\-\-folder\fR=\fIFOLDER\fR\ \fB\-\-organization\fR=\fIORGANIZATION\fR) [\fIGCLOUD_WIDE_FLAG\ ...\fR]



.SH "DESCRIPTION"

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



.SH "EXAMPLES"

The following command checks the PAM onboarding status for a project named
\f5sample\-project\fR and in location \f5global\fR:

.RS 2m
$ gcloud pam check\-onboarding\-status \-\-project=sample\-project \e
    \-\-location=global
.RE

The following command checks the PAM onboarding status for a folder with ID
\f5\fIFOLDER_ID\fR\fR and in location \f5global\fR:

.RS 2m
$ gcloud pam check\-onboarding\-status \-\-folder=FOLDER_ID \e
    \-\-location=global
.RE

The following command checks the PAM onboarding status for an organization with
ID \f5\fIORGANIZATION_ID\fR\fR and in location \f5global\fR:

.RS 2m
$ gcloud pam check\-onboarding\-status \e
    \-\-organization=ORGANIZATION_ID \-\-location=global
.RE



.SH "REQUIRED FLAGS"

.RS 2m
.TP 2m

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 \f5project\fR attribute:
.RS 2m
.IP "\(em" 2m
provide the argument \f5\-\-location\fR on the command line with a fully
specified name;
.IP "\(em" 2m
provide the argument \f5\-\-project\fR on the command line;
.IP "\(em" 2m
set the property \f5core/project\fR. This resource can be one of the following
types: [privilegedaccessmanager.projects.locations,
privilegedaccessmanager.folders.locations,
privilegedaccessmanager.organizations.locations].
.RE
.sp

This must be specified.


.RS 2m
.TP 2m
\fB\-\-location\fR=\fILOCATION\fR

ID of the location or fully qualified identifier for the location.

To set the \f5location\fR attribute:
.RS 2m
.IP "\(bu" 2m
provide the argument \f5\-\-location\fR on the command line.
.RE
.sp

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

.TP 2m
\fB\-\-folder\fR=\fIFOLDER\fR

The name of the folder

To set the \f5folder\fR attribute:
.RS 2m
.IP "\(bu" 2m
provide the argument \f5\-\-location\fR on the command line with a fully
specified name;
.IP "\(bu" 2m
provide the argument \f5\-\-folder\fR on the command line. Must be specified for
resource of type [privilegedaccessmanager.folders.locations].
.RE
.sp

.TP 2m
\fB\-\-organization\fR=\fIORGANIZATION\fR

The name of the organization

To set the \f5organization\fR attribute:
.RS 2m
.IP "\(bu" 2m
provide the argument \f5\-\-location\fR on the command line with a fully
specified name;
.IP "\(bu" 2m
provide the argument \f5\-\-organization\fR on the command line. Must be
specified for resource of type
[privilegedaccessmanager.organizations.locations].
.RE
.sp


.RE
.RE
.sp

.SH "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 \fB$ gcloud help\fR for details.



.SH "API REFERENCE"

This command uses the \fBprivilegedaccessmanager/v1\fR API. The full
documentation for this API can be found at:
https://cloud.google.com/iam/docs/pam\-overview



.SH "NOTES"

These variants are also available:

.RS 2m
$ gcloud alpha pam check\-onboarding\-status
.RE

.RS 2m
$ gcloud beta pam check\-onboarding\-status
.RE