Method: roles.list

Lists every predefinedRole that IAM supports, or every custom role that is defined for an organization or project.

HTTP request

GET https://iam.googleapis.com/v1/roles

The URL usesgRPC Transcoding syntax.

Query parameters

Parameters
parent

string

Theparent parameter's value depends on the target resource for the request, namelyroles,projects, ororganizations. Each resource type'sparent value format is described below:

  • roles.list: An empty string. This method doesn't require a resource; it simply returns allpredefined roles in IAM. Example request URL:https://iam.googleapis.com/v1/roles

  • projects.roles.list:projects/{PROJECT_ID}. This method lists all project-levelcustom roles. Example request URL:https://iam.googleapis.com/v1/projects/{PROJECT_ID}/roles

  • organizations.roles.list:organizations/{ORGANIZATION_ID}. This method lists all organization-levelcustom roles. Example request URL:https://iam.googleapis.com/v1/organizations/{ORGANIZATION_ID}/roles

Note: Wildcard (*) values are invalid; you must specify a complete project ID or organization ID.

Authorization requires the followingIAM permission on the specified resourceparent:

  • iam.roles.list
pageSize

integer

Optional limit on the number of roles to include in the response.

The default is 300, and the maximum is 1,000.

pageToken

string

Optional pagination token returned in an earlier ListRolesResponse.

view

enum (RoleView)

Optional view for the returned Role objects. WhenFULL is specified, theincludedPermissions field is returned, which includes a list of all permissions in the role. The default value isBASIC, which does not return theincludedPermissions field.

showDeleted

boolean

Include Roles that have been deleted.

Request body

The request body must be empty.

Response body

If successful, the response body contains an instance ofListRolesResponse.

Authorization scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/iam
  • https://www.googleapis.com/auth/cloud-platform

For more information, see theAuthentication Overview.

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-21 UTC.