Документация · v1

Creodock API

Все операции
GETИнтерфейс Creodock

Получить системные и пользовательские роли

Возвращает эффективные permissions, количество сотрудников, доступные действия и только те права, которые может выдать текущий пользователь.

GEThttps://api.creodock.com/api/v1/organizations/{organizationId}/roles
Кто вызывает
Интерфейс Creodock
Операция выполняется от имени вошедшего пользователя через защищённую cookie-сессию.
Доступ
Определяется ролью и принадлежностью объекта
Отдельный scope не объявлен в OpenAPI. Сервер проверяет роль и рабочую область.

Что произойдёт

Поведение, которое важно учесть до отправки запроса.

  • Не изменяет данные и подходит для безопасного повторного чтения.
  • Повторный запрос возвращает актуальное состояние ресурса.

Параметры

Где передать значение, обязательно ли оно и откуда его получить.

ПолеГдеТипОписание
organizationIdОбязательно
pathstring · uuid
ID рабочей области. Возьмите его из URL рабочей области или ответа списка рабочих областей.

Ответы

Все состояния ответа, объявленные этой операцией в OpenAPI.

200

Роли рабочей области

application/json

Схема: WorkspaceRolePage

ПолеТипОписание
dataОбязательно
WorkspaceRole[]
Элементы текущей страницы результата.
grantablePermissionsОбязательно
WorkspacePermission[]
Поле «grantablePermissions» в структуре запроса или ответа.
{
  "data": [
    {
      "active": true,
      "availableActions": [
        "edit"
      ],
      "description": "string",
      "id": "00000000-0000-0000-0000-000000000000",
      "kind": "system",
      "memberCount": 0,
      "name": "string",
      "permissions": [
        "orders.assigned.read"
      ],
      "systemKey": "owner",
      "version": 1
    }
  ],
  "grantablePermissions": [
    "orders.assigned.read"
  ]
}
403

Problem Details response

application/json

Схема: Problem

Ошибки и восстановление

Не только причина, но и конкретное действие для вызывающей стороны.

СтатусЧто означаетПовторЧто делать
403Недостаточно правНетИспользуйте ключ или роль с требуемым доступом.

Формат Problem Details

{
  "type": "https://api.creodock.com/problems/invalid-request",
  "title": "Данные не прошли проверку",
  "status": 422,
  "code": "invalid_request",
  "detail": "Проверьте отмеченные поля.",
  "traceId": "req_01J8M4Y6QX",
  "fieldErrors": [
    { "field": "items[0].formats", "code": "required", "message": "Выберите формат." }
  ]
}