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

Creodock API

Все операции
POSTПубличная операция

Создать: рабочая область

Создаёт рабочая область на основании переданного тела запроса.

OpenAPI: Enroll a new account through an email invitation; existing accounts require normal authenticated login including MFA

POSThttps://api.creodock.com/api/v1/invitations/{token}/accept
Кто вызывает
Публичная операция
Авторизация не требуется.
Доступ
Определяется ролью и принадлежностью объекта
Отдельный scope не объявлен в OpenAPI. Сервер проверяет роль и рабочую область.

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

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

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

Параметры

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

ПолеГдеТипОписание
tokenОбязательно
pathstring
Идентификатор ресурса в пути запроса: token.

Тело запроса

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

application/json

Схема: AcceptTeamInvitationInput

ПолеТипОписание
nameНеобязательно
string
Required and trimmed to 2–120 characters for new-account enrollment; ignored for existing authenticated recipients.
passwordОбязательно
string
New-account enrollment requires 15–72 UTF-8 bytes, checked server-side. Legacy existing-account input does not authenticate or replace credentials; a current normal login/MFA session is required.Минимальная длина: 1 · Максимальная длина: 72

Ответы

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

200

Membership created; a session token is returned only for new account enrollment

application/json
ПолеТипОписание
organizationIdОбязательно
string · uuid
ID рабочей области, которой принадлежит объект.
sessionTokenНеобязательно
string
Поле «sessionToken» в структуре запроса или ответа.
{
  "organizationId": "00000000-0000-0000-0000-000000000000",
  "sessionToken": "string"
}
401

Problem Details response

application/json

Схема: Problem

403

Problem Details response

application/json

Схема: Problem

404

Problem Details response

application/json

Схема: Problem

409

Problem Details response

application/json

Схема: Problem

410

Problem Details response

application/json

Схема: Problem

422

Problem Details response

application/json

Схема: Problem

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

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

СтатусЧто означаетПовторЧто делать
401Нет действующей авторизацииПосле авторизацииПроверьте ключ или пользовательскую сессию.
403Недостаточно правНетИспользуйте ключ или роль с требуемым доступом.
404Объект не найден или скрыт правилами доступаНетПроверьте ID и принадлежность рабочей области.
409Конфликт состояния или версииПосле чтенияПолучите актуальный объект и повторите изменение.
410Problem Details responseПо контракту операцииИспользуйте detail и traceId из ответа.
422Данные не прошли бизнес-проверкуПосле исправленияИсправьте поля, перечисленные в fieldErrors.

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