Skip to main content

ListScopes

Retrieves the list of scopes.

import { cloudApi, serviceClients, Session } from "@yandex-cloud/nodejs-sdk";

const ListApiKeyScopesRequest =
cloudApi.iam.api_key_service.ListApiKeyScopesRequest;

(async () => {
const authToken = process.env["YC_OAUTH_TOKEN"];
const session = new Session({ oauthToken: authToken });
const client = session.client(serviceClients.ApiKeyServiceClient);

const result = await client.listScopes(
ListApiKeyScopesRequest.fromPartial({
// pageSize: 0,
// pageToken: "pageToken"
})
);
console.log(result);
})();

ListApiKeyScopesRequest

pageSize : 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.

pageToken : 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

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