- NAME
-
- gcloud alpha iam roles describe - show metadata for a role
- SYNOPSIS
-
-
gcloud alpha iam roles describe
ROLE_ID
[--organization
=ORGANIZATION
|--project
=PROJECT_ID
] [GCLOUD_WIDE_FLAG …
]
-
- DESCRIPTION
-
(ALPHA)
This command shows metadata for a role.This command can fail for the following reasons:
- The role specified does not exist.
- The active user does not have permission to access the given role.
- EXAMPLES
-
To print metadata for the role
of the organizationspanner.databaseAdmin
, run:1234567
gcloud alpha iam roles describe roles/spanner.databaseAdmin --organization=1234567
To print metadata for the role
of the projectspanner.databaseAdmin
, run:myproject
gcloud alpha iam roles describe roles/spanner.databaseAdmin --project=myproject
To print metadata for a predefined role,
, run:spanner.databaseAdmin
gcloud alpha iam roles describe roles/spanner.databaseAdmin
- POSITIONAL ARGUMENTS
-
ROLE_ID
-
ID of the role to describe. Curated roles example: roles/viewer. Custom roles
example: CustomRole. For custom roles, you must also specify the
--organization
or--project
flag.
- FLAGS
-
-
At most one of these can be specified:
--organization
=ORGANIZATION
- Organization of the role you want to describe.
--project
=PROJECT_ID
-
Project of the role you want to describe.
The Google Cloud project ID to use for this invocation. If omitted, then the current project is assumed; the current project can be listed using
gcloud config list --format='text(core.project)'
and can be set usinggcloud config set project PROJECTID
.--project
and its fallbackcore/project
property play two roles in the invocation. It specifies the project of the resource to operate on. It also specifies the project for API enablement check, quota, and billing. To specify a different project for quota and billing, use--billing-project
orbilling/quota_project
property.
-
At most one of these can be specified:
- 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. - 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 iam roles describe
gcloud beta iam roles describe
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-06-25 UTC.