Identity and Access Management API, gRPC: RoleService

A set of methods for managing Role resources.

Call	Description
Get	Returns the specified Role resource.
List	Retrieves the list of Role resources.

Calls RoleService

Get

Returns the specified Role resource.
To get the list of available Role resources, make a List request.

rpc Get (GetRoleRequest) returns (Role)

GetRoleRequest

Field	Description
role_id	string Required. ID of the Role resource to return. To get the role ID, use a RoleService.List request. The maximum string length in characters is 50.

Role

Field	Description
id	string ID of the role.
description	string Description of the role. 0-256 characters long.

List

Retrieves the list of Role resources.

rpc List (ListRolesRequest) returns (ListRolesResponse)

ListRolesRequest

Field	Description
page_size	int64 The maximum number of results per page to return. If the number of available results is larger than page_size, the service returns a ListRolesResponse.next_page_token that can be used to get the next page of results in subsequent list requests. Default value: 100. The maximum value is 1000.
page_token	string Page token. To get the next page of results, set page_token to the ListRolesResponse.next_page_token returned by a previous list request. The maximum string length in characters is 2000.
filter	string A filter expression that filters resources listed in the response. The maximum string length in characters is 1000.

ListRolesResponse

Field	Description
roles[]	Role List of Role resources.
next_page_token	string This token allows you to get the next page of results for list requests. If the number of results is larger than ListRolesRequest.page_size, use the next_page_token as the value for the ListRolesRequest.page_token query parameter in the next list request. Each subsequent list request will have its own next_page_token to continue paging through the results.

Role

Field	Description
id	string ID of the role.
description	string Description of the role. 0-256 characters long.