Contact UsGet started

Identity and Access Management API, gRPC: ApiKeyService.ListScopes

Written by
Updated at November 26, 2024

Retrieves the list of scopes.

gRPC request

rpc ListScopes (ListApiKeyScopesRequest) returns (ListApiKeyScopesResponse)

ListApiKeyScopesRequest

{
  "page_size": "int64",
  "page_token": "string"
}

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 ListApiKeyScopesResponse.next_page_token
that can be used to get the next page of results in subsequent list requests.
Default value: 100.

page_token

string

Page token. To get the next page of results, set page_token to the
ListApiKeyScopesResponse.next_page_token returned by a previous list request.

ListApiKeyScopesResponse

{
  "scopes": [
    "string"
  ],
  "next_page_token": "string"
}

Field

Description

scopes[]

string

List of scopes

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 ListApiKeyScopesRequest.page_size, use the next_page_token as the value
for the ListApiKeyScopesRequest.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.
Previous
ListOperations
Next
Overview