Skip to main content
POST
/
api
/
svc
/
v1
/
users
/
register
Register Users
curl --request POST \
  --url https://{controlPlaneURL}/api/svc/v1/users/register \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "email": "<string>",
  "sendInviteEmail": false,
  "skipIfUserExists": false,
  "dryRun": false,
  "acceptInviteClientURL": "<control plane url>/invite-accept",
  "accountId": "<string>"
}
'
{}

Authorizations

​
Authorization
string
header
required

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

Body

application/json
​
email
string
required

Email of the user

​
sendInviteEmail
boolean
default:false

Send invite email if user does not exist

​
skipIfUserExists
boolean
default:false

Fail if user exists

​
dryRun
boolean
default:false

Dry run

​
acceptInviteClientURL
string

Url to redirect when invite is accepted

Example:

"<control plane url>/invite-accept"

​
accountId
string

Account ID to add the user to

Response

The users have been successfully registered.

The response is of type RegisterUsersResponse · object.