Identity and Access Management API, REST: Role.Get

Written by

Updated at October 17, 2024

Returns the specified Role resource.

To get the list of available Role resources, make a List request.

HTTP request

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

Field

Description

roleId

string

Required field. ID of the Role resource to return.
To get the role ID, use a RoleService.List request.

HTTP Code: 200 - OK

{
  "id": "string",
  "description": "string"
}

A Role resource. For more information, see Roles.

Field

Description

string

ID of the role.

description

string

Description of the role. 0-256 characters long.