Skip to main content
POST
/
api
/
svc
/
v1
/
users
/
invite
Invite User
curl --request POST \
  --url https://{controlPlaneURL}/api/svc/v1/users/invite \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "acceptInviteClientUrl": "<control plane url>/invite-accept",
  "email": "<string>"
}'
{
  "link": "<string>"
}

Authorizations

​
Authorization
string
header
required

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

Body

application/json
​
acceptInviteClientUrl
string
required

Url to redirect when invite is accepted

Example:

"<control plane url>/invite-accept"

​
email
string
required

Email of user

Response

User has been successfully invited.

​
link
string
required
⌘I