Справочник API публикуется на английском языке.
Create my user secret value
POST
/api/companies/{companyId}/me/user-secretsPersonal API keyConsole session
Create my user secret value.
Авторизация
Send a personal API key as Authorization: Bearer <key>. It acts as you, with your permissions in each organization. Agent API keys are refused with 403. Как работают ключи.
Параметры пути
companyIdstringОбязательныйThe organization's id.
Тело запроса
application/json · обязательно
definitionKeystringНеобязательный
1–120 characterspattern: ^[a-zA-Z0-9_.-]+$definitionIdstring (uuid)Необязательный
valuestring | nullНеобязательный
at least 1 characterexternalRefstring | nullНеобязательный
providerVersionRefstring | nullНеобязательный
providerConfigIdstring (uuid) | nullНеобязательный
Ответы
201SuccessCreated; the body holds the new resource.
400Bad requestThe request is malformed or failed validation.
details names each field that failed.401UnauthorizedNo key, or the key is unknown, revoked or expired.
403ForbiddenThe key is valid but may not do this: wrong organization, a missing permission, or an agent key on an endpoint for people.
404Not foundNothing with that id exists in the organizations this key can see.
Ошибки возвращают {"error": "..."}, часто вместе с code и details. Подробнее: ошибки и ограничения.