Yandex Cloud
  • Services
  • Solutions
  • Why Yandex Cloud
  • Blog
  • Pricing
  • Documentation
  • Contact us
Get started
Language / Region
Yandex project
© 2023 Yandex.Cloud LLC
Yandex Identity and Access Management
  • Getting started
    • How to manage access to resources
    • How to work with service accounts
  • Step-by-step instructions
    • All instructions
    • Handling secrets that are available in the public domain
    • Users
      • Adding users
      • Getting user ID or email
      • Deleting a user
    • Groups of users
      • Creating a group
      • Setting up group access bindings
      • Granting group permissions
    • Service accounts
      • Creating a service account
      • Updating a service account
      • Assigning roles to a service account
      • Setting up access rights for service accounts
      • Creating static access keys
      • Deleting static access keys
      • Getting the service account ID
      • Deleting a service account
    • Roles
      • Assigning roles
      • Viewing assigned roles
      • Revoking roles
    • IAM tokens
      • Getting an IAM token for a Yandex account
      • Getting an IAM token for a service account
      • Getting an IAM token for a federated account
    • Keys
      • Creating API keys
      • Deleting API keys
      • Creating authorized keys
      • Deleting authorized keys
  • Concepts
    • Overview
    • How access management works
      • Overview
      • Roles
      • System groups
      • Resources that roles can be assigned for
    • Authorization
      • Overview
      • IAM token
      • OAuth token
      • API key
      • Authorized keys
      • AWS-compatible access keys
    • Service accounts
    • Identity federations
    • Quotas and limits
  • How to use Yandex Cloud securely
  • Access management
  • Pricing policy
  • API reference
    • Authentication in the API
    • gRPC
      • Overview
      • ApiKeyService
      • IamTokenService
      • KeyService
      • RoleService
      • ServiceAccountService
      • UserAccountService
      • YandexPassportUserAccountService
      • AccessKeyService
      • CertificateService
      • FederationService
      • OperationService
    • REST
      • Overview
      • ApiKey
        • Overview
        • create
        • delete
        • get
        • list
        • listOperations
        • update
      • IamToken
        • Overview
        • create
        • createForServiceAccount
      • Key
        • Overview
        • create
        • delete
        • get
        • list
        • listOperations
        • update
      • Role
        • Overview
        • get
        • list
      • ServiceAccount
        • Overview
        • create
        • delete
        • get
        • list
        • listAccessBindings
        • listOperations
        • setAccessBindings
        • update
        • updateAccessBindings
      • UserAccount
        • Overview
        • get
      • YandexPassportUserAccount
        • Overview
        • getByLogin
      • Operation
        • Overview
        • get
      • AccessKey
        • Overview
        • list
        • get
        • delete
        • update
        • listOperations
        • create
      • Federation
        • Overview
        • list
        • get
        • listUserAccounts
        • delete
        • addUserAccounts
        • update
        • listOperations
        • create
      • Certificate
        • Overview
        • list
        • get
        • delete
        • update
        • listOperations
        • create
  • Questions and answers
    • General questions
    • Logging in and accessing resources
    • All questions on one page
  1. API reference
  2. gRPC
  3. RoleService

Identity and Access Management API, gRPC: RoleService

Written by
Yandex Cloud
  • Calls RoleService
  • Get
    • GetRoleRequest
    • Role
  • List
    • ListRolesRequest
    • ListRolesResponse
    • Role

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.

Was the article helpful?

Language / Region
Yandex project
© 2023 Yandex.Cloud LLC
In this article:
  • Calls RoleService
  • Get
  • GetRoleRequest
  • Role
  • List
  • ListRolesRequest
  • ListRolesResponse
  • Role