Yandex Cloud
Search
Contact UsGet started
  • Pricing
  • Customer Stories
  • Documentation
  • Blog
  • All Services
  • System Status
    • Featured
    • Infrastructure & Network
    • Data Platform
    • Containers
    • Developer tools
    • Serverless
    • Security
    • Monitoring & Resources
    • ML Services
    • Business tools
  • All Solutions
    • By industry
    • By use case
    • Economics and Pricing
    • Security
    • Technical Support
    • Start testing with double trial credits
    • Cloud credits to scale your IT product
    • Gateway to Russia
    • Cloud for Startups
    • Center for Technologies and Society
    • Yandex Cloud Partner program
  • Pricing
  • Customer Stories
  • Documentation
  • Blog
© 2025 Direct Cursus Technology L.L.C.
Yandex Identity and Access Management
  • Secure use of Yandex Cloud
  • Access management
  • Pricing policy
  • Role reference
  • Terraform reference
    • API authentication
      • Overview
        • Overview
        • Get
        • List
  • Monitoring metrics
  • Audit Trails events
  • Release notes

In this article:

  • HTTP request
  • Query parameters
  • Response
  • Role
  1. API reference
  2. REST
  3. Role
  4. List

Identity and Access Management API, REST: Role.List

Written by
Yandex Cloud
Updated at August 8, 2025
  • HTTP request
  • Query parameters
  • Response
  • Role

Retrieves the list of Role resources.

HTTP requestHTTP request

GET https://iam.api.cloud.yandex.net/iam/v1/roles

Query parametersQuery parameters

Field

Description

pageSize

string (int64)

The maximum number of results per page to return. If the number of available
results is larger than pageSize,
the service returns a ListRolesResponse.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 ListRolesResponse.nextPageToken
returned by a previous list request.

filter

string

A filter expression that filters resources listed in the response.

ResponseResponse

HTTP Code: 200 - OK

{
  "roles": [
    {
      "id": "string",
      "description": "string"
    }
  ],
  "nextPageToken": "string"
}

Field

Description

roles[]

Role

List of Role resources.

nextPageToken

string

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

RoleRole

A Role resource. For more information, see Roles.

Field

Description

id

string

ID of the role.

description

string

Description of the role. 0-256 characters long.

Was the article helpful?

Previous
Get
Next
Overview
© 2025 Direct Cursus Technology L.L.C.