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

Creodock API

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

Войти в Creodock по email и паролю

Нормализует email, проверяет пароль и создаёт сессию с idle timeout 7 дней и absolute timeout 30 дней. Для неизвестного email и неверного пароля всегда возвращается одинаковая ошибка invalid_credentials. Стартовой рабочей областью становится самая ранняя активная membership.

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

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

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

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

Тело запроса

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

application/json

Схема: AccountLogin

ПолеТипОписание
emailОбязательно
string · email
Email в нормализованном виде.Максимальная длина: 320
passwordОбязательно
string
Поле «password» в структуре запроса или ответа.Минимальная длина: 1 · Максимальная длина: 72

Ответы

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

200

Сессия создана

application/json

Схема: AccountLoginResult

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

Password accepted; MFA is required before a session is created

application/json

Схема: MFAChallenge

ПолеТипОписание
challengeОбязательно
string
Поле «challenge» в структуре запроса или ответа.Минимальная длина: 32
codeОбязательно
string
Поле «code» в структуре запроса или ответа.
{
  "challenge": "string",
  "code": "string"
}
401

Problem Details response

application/json

Схема: Problem

403

Problem Details response

application/json

Схема: Problem

429

Problem Details response

application/json

Схема: Problem

503

Problem Details response

application/json

Схема: Problem

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

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

invalid_credentialsemail_verification_requiredpassword_reset_requiredlogin_rate_limitedmfa_dependency_unavailable
СтатусЧто означаетПовторЧто делать
401Нет действующей авторизацииПосле авторизацииПроверьте ключ или пользовательскую сессию.
403Недостаточно правНетИспользуйте ключ или роль с требуемым доступом.
429Превышен лимит запросовДаПодождите время из Retry-After.
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": "Выберите формат." }
  ]
}