Contact UsGet started

Identity and Access Management API, gRPC: ApiKeyService.ListScopes

Written by
Updated at October 17, 2024

Retrieves the list of scopes.

gRPC request

rpc ListScopes (ListApiKeyScopesRequest) returns (ListApiKeyScopesResponse)

ListApiKeyScopesRequest

{
  "pageSize": "int64",
  "pageToken": "string"
}

Field

Description

pageSize

int64

The maximum number of results per page to return. If the number of available
results is larger than pageSize,
the service returns a ListApiKeyScopesResponse.nextPageToken
that can be used to get the next page of results in subsequent list requests.
Default value: 100.

pageToken

string

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

ListApiKeyScopesResponse

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

Field

Description

scopes[]

string

List of scopes

nextPageToken

string

This token allows you to get the next page of results for list requests. If the number of results
is larger than ListApiKeyScopesRequest.pageSize, use the nextPageToken as the value
for the ListApiKeyScopesRequest.pageToken query parameter in the next list request.
Each subsequent list request will have its own nextPageToken to continue paging through the results.
Previous
ListOperations
Next
Overview