Scope: system:users.write https://api.alladdin.com/api/v2/account/users

Sends an invitation email to the specified address and creates a pending membership for the account.

Request body

object email string<email> required

Email address of the user to invite

role_id string required

Role identifier to assign to the invited user

Request

import requests

url = "https://api.alladdin.com/api/v2/account/users"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
    "Accept": "application/json",
}

payload = {
    "email": "[email protected]",
    "role_id": "507f1f77bcf86cd799439011"
}
response = requests.post(url, headers=headers, json=payload)
print(response.json())

Responses

Response

{
  "id": "507f1f77bcf86cd799439011"
}

Success responses

201 Invitation created application/json object id string

Error responses

400 Bad request application/json 401 Invalid or missing API key application/json 403 Insufficient permissions application/json 409 User is already a member or has a pending invitation 422 No seats available for the requested role 429 Rate limit exceeded application/json

Next →Update account user role →