LegalStack

Приглашения

Приглашения пользователей в команду.

Список ожидающих приглашений

GET
/api/v1/security/invites
АвторизацияBearer <токен>

В: header

Тело ответа

application/json

curl -X GET "https://loading/api/v1/security/invites"
{
  "invites": [
    {
      "createdAt": "2019-08-24T14:15:22Z",
      "email": "string",
      "expiresAt": "2019-08-24T14:15:22Z",
      "id": "string",
      "role": "string"
    }
  ]
}

Создать приглашение

POST
/api/v1/security/invites
АвторизацияBearer <токен>

В: header

Тело запроса

application/json

TypeScript-определения

Используйте тип request body в TypeScript.

Тело ответа

application/json

curl -X POST "https://loading/api/v1/security/invites" \  -H "Content-Type: application/json" \  -d '{    "role": "owner"  }'
{
  "invite": {
    "createdAt": "2019-08-24T14:15:22Z",
    "email": "string",
    "expiresAt": "2019-08-24T14:15:22Z",
    "id": "string",
    "role": "string"
  },
  "inviteLink": "http://example.com"
}

Отменить приглашение

DELETE
/api/v1/security/invites/{id}
АвторизацияBearer <токен>

В: header

Параметры пути

id*string

Идентификатор приглашения

Тело ответа

application/json

curl -X DELETE "https://loading/api/v1/security/invites/string"
{
  "message": "string"
}

Получить приглашение по токену

GET
/api/v1/security/invites/{token}

Параметры пути

token*string

Токен приглашения из ссылки

Тело ответа

application/json

curl -X GET "https://loading/api/v1/security/invites/string"
{
  "email": "string",
  "expiresAt": "2019-08-24T14:15:22Z",
  "inviter": {
    "email": "string",
    "name": "string"
  },
  "role": "string",
  "team": {
    "id": "string",
    "name": "string",
    "slug": "string"
  }
}

Принять приглашение как новый пользователь

POST
/api/v1/security/invites/{token}/accept

Параметры пути

token*string

Токен приглашения из ссылки

Тело запроса

application/json

TypeScript-определения

Используйте тип request body в TypeScript.

Тело ответа

application/json

curl -X POST "https://loading/api/v1/security/invites/string/accept" \  -H "Content-Type: application/json" \  -d '{    "email": "string",    "firstName": "string",    "lastName": "string",    "password": "stringstringstr"  }'
{
  "accessToken": "string",
  "user": {
    "email": "string",
    "firstName": "string",
    "id": "string",
    "lastName": "string",
    "teamId": "string"
  }
}

Принять приглашение как существующий пользователь

POST
/api/v1/security/invites/{token}/join
АвторизацияBearer <токен>

В: header

Параметры пути

token*string

Токен приглашения из ссылки

Тело ответа

application/json

curl -X POST "https://loading/api/v1/security/invites/string/join"
{
  "accessToken": "string",
  "user": {
    "email": "string",
    "firstName": "string",
    "id": "string",
    "lastName": "string",
    "teamId": "string"
  }
}