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

Creodock API

Все операции
PATCHИнтерфейс CreodockИдемпотентная команда

Изменить название, описание и права пользовательской роли

Системные роли и роль владельца неизменяемы. Изменение действует со следующего backend-запроса.

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

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

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

  • Изменяет существующий ресурс. Передавайте только актуальные данные объекта.
  • Поддерживает Idempotency-Key: повторяйте запрос с тем же ключом после сетевого сбоя.

Параметры

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

ПолеГдеТипОписание
organizationIdОбязательно
pathstring · uuid
ID рабочей области. Возьмите его из URL рабочей области или ответа списка рабочих областей.
roleIdОбязательно
pathstring · uuid
Идентификатор ресурса в пути запроса: roleId.
Idempotency-KeyОбязательно
headerstring
Уникальный ключ команды. Используйте UUID и сохраняйте тот же ключ при безопасном повторе запроса.Минимальная длина: 16 · Максимальная длина: 128

Тело запроса

Обязательно для этой операции.

application/json
ПолеТипОписание
descriptionНеобязательно
string
Развёрнутое описание.Пример: string
nameНеобязательно
string
Отображаемое название.Пример: string
permissionsНеобязательно
array
Поле «permissions» в структуре запроса или ответа.Пример: ["orders.assigned.read"]

Ответы

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

200

Роль обновлена

403

Problem Details response

application/json

Схема: Problem

404

Problem Details response

application/json

Схема: Problem

409

Problem Details response

application/json

Схема: Problem

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

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

СтатусЧто означаетПовторЧто делать
403Недостаточно правНетИспользуйте ключ или роль с требуемым доступом.
404Объект не найден или скрыт правилами доступаНетПроверьте ID и принадлежность рабочей области.
409Конфликт состояния или версииПосле чтенияПолучите актуальный объект и повторите изменение.

Формат 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": "Выберите формат." }
  ]
}