Skip to main content
POST
/
tenant-auth
/
v1
/
users
/
invite
Invite a user to the tenant via email
curl --request POST \
  --url https://api.swarmd.ai/tenant-auth/v1/users/invite \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "email": "<string>",
  "firstName": "<string>",
  "lastName": "<string>",
  "groupIds": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ]
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "tenantId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "email": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "permissions": [
    {
      "entity": "USERS",
      "permission": "READ"
    }
  ],
  "firstName": "<string>",
  "lastName": "<string>",
  "groupIds": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ]
}

Authorizations

Authorization
string
header
required

JWT token (USER, AGENT, or SERVICE auth)

Body

application/json
email
string
required
firstName
string
required
Maximum string length: 255
lastName
string
required
Maximum string length: 255
groupIds
string<uuid>[]

Response

201 - */*

Created

id
string<uuid>
required
tenantId
string<uuid>
required
email
string
required
createdAt
string<date-time>
required
permissions
object[]
required
firstName
string
lastName
string
groupIds
string<uuid>[]