Skip to content

Применить инвайт-токен

Использовать инвайт-токен#

Ручка#

POST /invite/v1/use_invite_token

Полный адрес в сети#

Среда URL
🧪 Dev https://gateway.devterra.ru/admin/invite/v1/use_invite_token
🚀 Prod https://mobile-api.terraprod.ru/admin/invite/v1/use_invite_token

Пример тела запроса#

{
    "inviteToken": "...",
}
Столбец Тип Описание Обязательность
inviteToken string Инвайт-токен ✅

Пример тела ответа#

{
    "inviteToken": {
        "createdAt": "2024-11-05T18:30:00+03:00",
        "deletedAt": "2024-11-06T18:30:00+03:00",
        "entityID": 1,
        "expirationTime": "2024-11-06T19:30:00+03:00",
        "inviteToken": "...",
        "oneOff": true,
        "tokenAnotherRole": 1,
        "tokenAnotherRoleName": "TOKEN_ADMINISTRATOR",
        "tokenRole": 1,
        "tokenRoleName": "TOKEN_REGISTRATION_ON_EVENT",
        "tokenStatus": 0,
        "tokenStatusName": "TOKEN_IS_ALIVE",
        "updatedAt": "2024-11-06T19:45:00+03:00",
        "userUUID": "8a87d1a5-5bce-4361-a2e6-8b5517c81212"
    }
}
Столбец Тип Описание Обязательность
createdAt string Время создания токена ❌
deletedAt string Время удаления токена ❌
entityID int32 Идентификатор сущности к которой будет привязан инвайт ✅
expirationTime string Кол-во минут, которое инвайт будет жить ✅
inviteToken string Инвайт-токен ✅
oneOff bool Многоразовый или нет ✅
tokenAnotherRole int32 Пользовательская роль инвайта ✅
tokenAnotherRoleName string Название пользовательской роли ✅
tokenRole int32 Обозначение к какому сервису относится инвайт ✅
tokenRoleName string Название сервиса ✅
tokenStatus int32 Статус токена использован ли, истёк ли срок действия и т. д. ✅
tokenStatusName string Название статуса ✅
updatedAt string Время обновления токена ❌
userUUID *string Уникальный идентификатор пользователя ❌