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

Creodock API

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

Создать: аккаунт

Создаёт аккаунт на основании переданного тела запроса.

OpenAPI: Create a one-time TOTP enrollment secret

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

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

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

  • Создаёт ресурс или запускает команду, описанную в теле запроса.
  • Идемпотентность явно не объявлена в контракте: не повторяйте запрос автоматически.

Ответы

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

200

Enrollment material shown only until confirmation

application/json

Схема: TOTPEnrollment

ПолеТипОписание
otpauthUriОбязательно
string · uri
Поле «otpauthUri» в структуре запроса или ответа.
secretОбязательно
string
Поле «secret» в структуре запроса или ответа.
{
  "otpauthUri": "https://example.com/resource",
  "secret": "string"
}
401

Problem Details response

application/json

Схема: Problem

409

Problem Details response

application/json

Схема: Problem

503

Problem Details response

application/json

Схема: Problem

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

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

СтатусЧто означаетПовторЧто делать
401Нет действующей авторизацииПосле авторизацииПроверьте ключ или пользовательскую сессию.
409Конфликт состояния или версииПосле чтенияПолучите актуальный объект и повторите изменение.
503Сервис временно недоступенДаПовторите с экспоненциальной задержкой.

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