.TH "GCLOUD_ALPHA_PAM_ENTITLEMENTS" 1



.SH "NAME"
.HP
gcloud alpha pam entitlements \- manage Privileged Access Manager entitlements



.SH "SYNOPSIS"
.HP
\f5gcloud alpha pam entitlements\fR \fICOMMAND\fR [\fIGCLOUD_WIDE_FLAG\ ...\fR]



.SH "DESCRIPTION"

\fB(ALPHA)\fR The \f5gcloud pam entitlements\fR command group lets you manage
Privileged Access Manager (PAM) entitlements.



.SH "EXAMPLES"

To create a new entitlement with a name of \f5sample\-entitlement\fR, in a
project named \f5sample\-project\fR, in location \f5global\fR, and the
entitlement configuration stored in a file named \f5sample\-entitlement.yaml\fR,
run:

.RS 2m
$ gcloud alpha pam entitlements create sample\-entitlement \e
  \-\-project=sample\-project \-\-location=global \e
  \-\-entitlement\-file=sample\-entitlement.yaml
.RE

To create a new entitlement with a name of \f5sample\-entitlement\fR, in a
folder with ID \f5\fIFOLDER_ID\fR\fR, in location \f5global\fR, and the
entitlement configuration stored in a file named \f5sample\-entitlement.yaml\fR,
run:

.RS 2m
$ gcloud alpha pam entitlements create sample\-entitlement \e
  \-\-folder=FOLDER_ID \-\-location=global \e
  \-\-entitlement\-file=sample\-entitlement.yaml
.RE

To create a new entitlement with a name of \f5sample\-entitlement\fR, in an
organization with ID \f5\fIORGANIZATION_ID\fR\fR, in location \f5global\fR, and
the entitlement configuration stored in a file named
\f5sample\-entitlement.yaml\fR, run:

.RS 2m
$ gcloud alpha pam entitlements create sample\-entitlement \e
  \-\-organization=ORGANIZATION_ID \-\-location=global \e
  \-\-entitlement\-file=sample\-entitlement.yaml
.RE

To update an entitlement with a name of \f5sample\-entitlement\fR, in a project
named \f5sample\-project\fR, in location \f5global\fR, and the new entitlement
configuration stored in a file named \f5sample\-entitlement.yaml\fR, run:

.RS 2m
$ gcloud alpha pam entitlements update sample\-entitlement \e
  \-\-project=sample\-project \-\-location=global \e
  \-\-entitlement\-file=sample\-entitlement.yaml
.RE

To update an entitlement with a name of \f5sample\-entitlement\fR, in a folder
with ID \f5\fIFOLDER_ID\fR\fR, in location \f5global\fR, and the new entitlement
configuration stored in a file named \f5sample\-entitlement.yaml\fR, run:

.RS 2m
$ gcloud alpha pam entitlements update sample\-entitlement \e
  \-\-folder=FOLDER_ID \-\-location=global \e
  \-\-entitlement\-file=sample\-entitlement.yaml
.RE

To update an entitlement with a name of \f5sample\-entitlement\fR, in an
organization with ID \f5\fIORGANIZATION_ID\fR\fR, in location \f5global\fR, and
the new entitlement configuration stored in a file named
\f5sample\-entitlement.yaml\fR, run:

.RS 2m
$ gcloud alpha pam entitlements update sample\-entitlement \e
  \-\-organization=ORGANIZATION_ID \-\-location=global \e
  \-\-entitlement\-file=sample\-entitlement.yaml
.RE

To describe an entitlement with a name of \f5sample\-entitlement\fR, in a
project named \f5sample\-project\fR, and in location \f5global\fR, run:

.RS 2m
$ gcloud alpha pam entitlements describe sample\-entitlement \e
  \-\-project=sample\-project \-\-location=global
.RE

To describe an entitlement with a name of \f5sample\-entitlement\fR, in a folder
with ID \f5\fIFOLDER_ID\fR\fR, and in location \f5global\fR, run:

.RS 2m
$ gcloud alpha pam entitlements describe sample\-entitlement \e
  \-\-folder=FOLDER_ID \-\-location=global
.RE

To describe an entitlement with a name of \f5sample\-entitlement\fR, in an
organization with ID \f5\fIORGANIZATION_ID\fR\fR, and in location \f5global\fR,
run:

.RS 2m
$ gcloud alpha pam entitlements describe sample\-entitlement \e
  \-\-organization=ORGANIZATION_ID \-\-location=global
.RE

To search for and list all entitlements for which you are a requester, in a
project named \f5sample\-project\fR, and in location \f5global\fR, run:

.RS 2m
$ gcloud alpha pam entitlements search \-\-project=sample\-project \e
  \-\-location=global \-\-caller\-access\-type=grant\-requester
.RE

To search for and list all entitlements for which you are an approver, in a
project named \f5sample\-project\fR, and in location \f5global\fR, run:

.RS 2m
$ gcloud alpha pam entitlements search \-\-project=sample\-project \e
  \-\-location=global \-\-caller\-access\-type=grant\-approver
.RE

To search for and list all entitlements for which you are a requester, in a
folder with ID \f5\fIFOLDER_ID\fR\fR, and in location \f5global\fR, run:

.RS 2m
$ gcloud alpha pam entitlements search \-\-folder=FOLDER_ID \e
  \-\-location=global \-\-caller\-access\-type=grant\-requester
.RE

To search for and list all entitlements for which you are an approver, in a
folder with ID \f5\fIFOLDER_ID\fR\fR, and in location \f5global\fR, run:

.RS 2m
$ gcloud alpha pam entitlements search \-\-folder=FOLDER_ID \e
  \-\-location=global \-\-caller\-access\-type=grant\-approver
.RE

To search for and list all entitlements for which you are a requester, in an
organization with ID \f5\fIORGANIZATION_ID\fR\fR, and in location \f5global\fR,
run:

.RS 2m
$ gcloud alpha pam entitlements search \e
  \-\-organization=ORGANIZATION_ID \-\-location=global \e
  \-\-caller\-access\-type=grant\-requester
.RE

To search for and list all entitlements for which you are an approver, in an
organization with ID \f5\fIORGANIZATION_ID\fR\fR, and in location \f5global\fR,
run:

.RS 2m
$ gcloud alpha pam entitlements search \e
  \-\-organization=ORGANIZATION_ID \-\-location=global \e
  \-\-caller\-access\-type=grant\-approver
.RE

To list all entitlements in a project named \f5sample\-project\fR and in
location \f5global\fR, run:

.RS 2m
$ gcloud alpha pam entitlements list \-\-project=sample\-project \e
  \-\-location=global
.RE

To list all entitlements in a folder with ID \f5\fIFOLDER_ID\fR\fR and in
location \f5global\fR, run:

.RS 2m
$ gcloud alpha pam entitlements list \-\-folder=FOLDER_ID \e
  \-\-location=global
.RE

To list all entitlements in an organization with ID \f5\fIORGANIZATION_ID\fR\fR
and in location \f5global\fR, run:

.RS 2m
$ gcloud alpha pam entitlements list \e
  \-\-organization=ORGANIZATION_ID \-\-location=global
.RE

To delete an entitlement with a name of \f5sample\-entitlement\fR, in a project
named \f5sample\-project\fR, and in location \f5global\fR, run:

.RS 2m
$ gcloud alpha pam entitlements delete sample\-entitlement \e
  \-\-project=sample\-project \-\-location=global
.RE

To delete an entitlement with a name of \f5sample\-entitlement\fR, in a folder
with ID \f5\fIFOLDER_ID\fR\fR, and in location \f5global\fR, run:

.RS 2m
$ gcloud alpha pam entitlements delete sample\-entitlement \e
  \-\-folder=FOLDER_ID \-\-location=global
.RE

To delete an entitlement with a name of \f5sample\-entitlement\fR, in an
organization with ID \f5\fIORGANIZATION_ID\fR\fR, and in location \f5global\fR,
run:

.RS 2m
$ gcloud alpha pam entitlements delete sample\-entitlement \e
  \-\-organization=ORGANIZATION_ID \-\-location=global
.RE

To export an entitlement with a name of \f5sample\-entitlement\fR, in a project
named \f5sample\-project\fR, and in location \f5global\fR to a local YAML file
named \f5sample\-entitlement.yaml\fR, run:

.RS 2m
$ gcloud alpha pam entitlements export sample\-entitlement \e
  \-\-project=sample\-project \-\-location=global \e
  \-\-destination=sample\-entitlement.yaml
.RE

To export an entitlement with a name of \f5sample\-entitlement\fR, in a folder
with ID \f5\fIFOLDER_ID\fR\fR, and in location \f5global\fR to a local YAML file
named \f5sample\-entitlement.yaml\fR, run:

.RS 2m
$ gcloud alpha pam entitlements export sample\-entitlement \e
  \-\-folder=FOLDER_ID \-\-location=global \e
  \-\-destination=sample\-entitlement.yaml
.RE

To export an entitlement with a name of \f5sample\-entitlement\fR, in an
organization with ID \f5\fIORGANIZATION_ID\fR\fR, and in location \f5global\fR
to a local YAML file named \f5sample\-entitlement.yaml\fR, run:

.RS 2m
$ gcloud alpha pam entitlements export sample\-entitlement \e
  \-\-organization=ORGANIZATION_ID \-\-location=global \e
  \-\-destination=sample\-entitlement.yaml
.RE



.SH "GCLOUD WIDE FLAGS"

These flags are available to all commands: \-\-help.

Run \fB$ gcloud help\fR for details.



.SH "COMMANDS"

\f5\fICOMMAND\fR\fR is one of the following:

.RS 2m
.TP 2m
\fBcreate\fR

\fB(ALPHA)\fR Create a new Privileged Access Manager (PAM) entitlement.

.TP 2m
\fBdelete\fR

\fB(ALPHA)\fR Delete a Privileged Access Manager (PAM) entitlement.

.TP 2m
\fBdescribe\fR

\fB(ALPHA)\fR Show details of a Privileged Access Manager (PAM) entitlement.

.TP 2m
\fBexport\fR

\fB(ALPHA)\fR Export a Privileged Access Manager (PAM) entitlement into a local
YAML file.

.TP 2m
\fBlist\fR

\fB(ALPHA)\fR List all Privileged Access Manager (PAM) entitlements under a
parent.

.TP 2m
\fBsearch\fR

\fB(ALPHA)\fR Search and list all Privileged Access Manager (PAM) entitlements
in a parent for which you are a requester/approver.

.TP 2m
\fBupdate\fR

\fB(ALPHA)\fR Update an existing Privileged Access Manager (PAM) entitlement.


.RE
.sp

.SH "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:

.RS 2m
$ gcloud pam entitlements
.RE

.RS 2m
$ gcloud beta pam entitlements
.RE