Invite users

POST /api/service/users

Invite one or many users in Atlan. Note that you will need the unique roleId GUID for your environment to distinguish between admin, member and guests. You can find these GUIDs in the response from the List roles operation.

Body Required

List of users to create.

  • users array[object]
    • email string Required

      Email address of the user to invite.

    • roleName string Required

      Unique name of the workspace role for the user.

      Values are $guest, $member, or $admin.

    • roleId string Required

      GUID of the workspace role for the user. This varies for every Atlan environment, so you will need to find your specific values using the List roles operation.


  • 200 object

    Successfully invited users to Atlan. (Response will always be an empty JSON object.)

  • 500 object

    Error when creating the users. For example, if the provided user already exists.

POST /api/service/users
curl \
 -X POST \
 -H "Authorization: Bearer $ACCESS_TOKEN" \
 -H "Content-Type: application/json" \
 -d '{"users":[{"email":"","roleName":"$member","roleId":"620172e0-81df-4d30-a8b3-f92a69badd04"}]}'
Request example
  "users": [
      "email": "",
      "roleName": "$member",
      "roleId": "620172e0-81df-4d30-a8b3-f92a69badd04"
Response example (200)
Response example (500)
  "": "409 Conflict: User exists with the same email"