Skip to main content
POST
/
iam
/
clients
/
invite_user
Invite new user
curl --request POST \
  --url https://api.gcore.com/iam/clients/invite_user \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "email": "jsmith@example.com",
  "user_role": {
    "id": 1,
    "name": "Administrators"
  },
  "client_id": 123,
  "lang": "de",
  "name": "<string>"
}
'
{
  "status": "sent",
  "user_id": 19449
}

Authorizations

​
Authorization
string
header
required

API key for authentication. Make sure to include the word apikey, followed by a single space and then your token. Example: apikey 1234$abcdef

Body

application/json
​
email
string<email>
required

User email.

​
user_role
object
required
​
client_id
integer
required

ID of account.

​
lang
enum<string>

User's language. Defines language of the control panel and email messages.

Available options:
de,
en,
ru,
zh,
az
​
name
string

User name.

Response

OK.

​
status
string

Status of the invitation.

​
user_id
integer

Invited user ID.