4b3471151a8b

latestOpenAPI 3.1.02026-08-1084336455.2 KB

Users

Invite User

Authorization scope: user:edit

Invite new user 1. Create new user with temp password 2. Send email with redirect url that includes the password inside the token

post/v1/accounts/{account_id}/users/invite_user

Path parameters

account_idstring required

Request body

user_namestring required

The user name

user_emailstring required

The user email

environmentsobject required

The environments with roles per env

allow_login_passwordboolean required

Indicates if the user is allowed to login with password

is_adminboolean nullable

Indicates if the user is a admin

allow_login_googleboolean nullable

Indicates if the user is allowed to login with google

allow_login_ssoboolean nullable

Indicates if the user is allowed to login with sso

is_re_inviteboolean nullable

Indicates if the invitation is a re invite

Example request

{
  "environments": {
    "6271166896834700109da341": {
      "role": "developer"
    },
    "6271166896834700109da342": {
      "role": "connection_viewer"
    }
  },
  "allow_login_password": true,
  "allow_login_google": true,
  "allow_login_sso": true,
  "is_re_invite": true
}

Response

Successful Response