gcloud pam entitlements describe

NAME
gcloud pam entitlements describe - show details of a Privileged Access Manager entitlement
SYNOPSIS
gcloud pam entitlements describe(ENTITLEMENT :--folder=FOLDER--location=LOCATION--organization=ORGANIZATION)[GCLOUD_WIDE_FLAG]
DESCRIPTION
Show details of a Privileged Access Manager (PAM) entitlement.
EXAMPLES
The following command describes an entitlement with a name ofsample-entitlement, in a project namedsample-project,and in locationglobal:
gcloudpamentitlementsdescribesample-entitlement--project=sample-project--location=global

The following command describes an entitlement with a name ofsample-entitlement, in a folder with IDFOLDER_ID, and in locationglobal:

gcloudpamentitlementsdescribesample-entitlement--folder=FOLDER_ID--location=global

The following command describes an entitlement with a name ofsample-entitlement, in an organization with IDORGANIZATION_ID, and in locationglobal:

gcloudpamentitlementsdescribesample-entitlement--organization=ORGANIZATION_ID--location=global
POSITIONAL ARGUMENTS
Entitlement resource - Name of the entitlement to describe. The arguments inthis group can be used to specify the attributes of this resource. (NOTE) Someattributes are not given arguments in this group but can be set in other ways.

To set theproject attribute:

  • provide the argumententitlement 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.entitlements,privilegedaccessmanager.folders.locations.entitlements,privilegedaccessmanager.organizations.locations.entitlements].

This must be specified.

ENTITLEMENT
ID of the entitlement or fully qualified identifier for the entitlement.

To set theentitlement attribute:

  • provide the argumententitlement on the command line.

This positional argument must be specified if any of the other arguments in thisgroup are specified.

--folder=FOLDER
The name of the folder

To set thefolder attribute:

  • provide the argumententitlement 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.entitlements].
--location=LOCATION
The resource location

To set thelocation attribute:

  • provide the argumententitlement on the command line with a fullyspecified name;
  • provide the argument--location on the command line.
--organization=ORGANIZATION
The name of the organization

To set theorganization attribute:

  • provide the argumententitlement 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.entitlements].
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:
gcloudalphapamentitlementsdescribe
gcloudbetapamentitlementsdescribe

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.