Skip to main content
POST
/
iam
/
clients
/
invite_user
Python
from gcore import Gcore

client = Gcore(
    api_key="My API Key",
)
user_invite = client.iam.users.invite(
    client_id=0,
    email="dev@stainless.com",
    user_role={},
)
print(user_invite.user_id)
{
  "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
required

Status of the invitation.

​
user_id
integer
required

Invited user ID.