auth

Invite User

POST

/api/auth/{company_name}/invite

Invite User

curl --request POST \
  --url '/api/auth/{company_name}/invite' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "email": "jsmith@example.com",
  "group_path": "<string>",
  "role": "Administrator",
  "url": "<string>"
}
'

{
  "created": "2023-11-07T05:31:56Z",
  "email": "jsmith@example.com",
  "expires": "2023-11-07T05:31:56Z",
  "group_path": "<string>",
  "id": "5eb7cf5a86d9755df3a6c593",
  "public_id": "<string>",
  "role": "Administrator",
  "url": "<string>"
}

Authorizations

Authorizationstringheaderrequired

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

company_namestringrequired

Body

emailstringrequired

group_pathstringrequired

roleenum<string>required

Available options: Administrator, Editor, Operator, SubGroupAdministrator, SubGroupEditor, SubGroupOperator, SubGroupRestrictedOperator, ShareLinkOperator

urlstringrequired

Minimum string length: 1

Response

Successful Response

createdstringrequired

emailstringrequired

expiresstringrequired

group_pathstringrequired

idstringrequired

Required string length: 24 - 24

Pattern: ^[0-9a-f]{24}$

Example: 5eb7cf5a86d9755df3a6c593

public_idstringrequired

roleenum<string>required

Available options: Administrator, Editor, Operator, SubGroupAdministrator, SubGroupEditor, SubGroupOperator, SubGroupRestrictedOperator, ShareLinkOperator

urlstringrequired

Minimum string length: 1