Перейти к основному содержимому

Роли (RBAC)

Список ролей​

Метод возвращает список ролей организации с их разрешениями (RBAC).

Требует доступ: org.roles.read.

Запрос​

Метод: GET URL: https://b2b.selfwork.ru/openapi/v2/organisation/{organisationId}/roles

Path Parameters​

ПараметрТипОбязательныйОписание
organisationIdstring (uuid)ДаИдентификатор организации

Пример запроса​

curl --location "https://b2b.selfwork.ru/openapi/v2/organisation/550e8400-e29b-41d4-a716-446655440000/roles" \
--header "accept: application/json" \
--header "Authorization: Bearer ВАШ_API_КЛЮЧ"

Пример успешного ответа​

{
"requestId": "97c5678a-8c6a-4688-8452-68ab606fe049",
"result": [
{
"id": "019d06af-5e5d-7313-b8ba-df1640767435",
"code": "OWNER",
"name": "Владелец",
"description": "Владелец организации. Полный доступ.",
"permissions": ["org.read", "org.update", "org.members.read"]
}
],
"success": true
}

Описание полей ответа​

ПолеТипОписание
requestIdstringУникальный идентификатор запроса
successbooleanСтатус выполнения запроса
resultarrayМассив объектов ролей (RoleInfoDto)
result[].idstring (uuid)UUID роли
result[].codestringТехническое название роли
result[].namestringЧеловекочитаемое название роли
result[].descriptionstringОписание роли
result[].permissionsarray[string]Список разрешений роли

 

Деталка роли​

Метод возвращает детальную информацию о конкретной роли организации, включая её разрешения (RBAC).

Требует доступ: org.roles.read.

Запрос​

Метод: GET URL: https://b2b.selfwork.ru/openapi/v2/organisation/{organisationId}/roles/{roleId}

Path Parameters​

ПараметрТипОбязательныйОписание
organisationIdstring (uuid)ДаИдентификатор организации
roleIdstringДаИдентификатор роли

Пример запроса​

curl --location "https://b2b.selfwork.ru/openapi/v2/organisation/550e8400-e29b-41d4-a716-446655440000/roles/019d06af-5e5d-7313-b8ba-df1640767435" \
--header "accept: application/json" \
--header "Authorization: Bearer ВАШ_API_КЛЮЧ"

Пример успешного ответа​

{
"requestId": "97c5678a-8c6a-4688-8452-68ab606fe049",
"result": {
"id": "019d06af-5e5d-7313-b8ba-df1640767435",
"code": "OWNER",
"name": "Владелец",
"description": "Владелец организации. Полный доступ.",
"permissions": ["org.read", "org.update", "org.members.read"]
},
"success": true
}

Описание полей ответа​

ПолеТипОписание
requestIdstringУникальный идентификатор запроса
successbooleanСтатус выполнения запроса
resultobjectОбъект роли (RoleInfoDto)
result.idstring (uuid)UUID роли
result.codestringТехническое название роли
result.namestringЧеловекочитаемое название роли
result.descriptionstringОписание роли
result.permissionsarray[string]Список разрешений роли