Create groups

POST /api/service/groups

Create one group in Atlan.

Body Required

Group to create.

  • group object
    • name string Required

      Unique name of the group to create. This should be all lowercase, without any spaces or special symbols other than an underscore (_).

    • attributes object Required
      • alias array[string] Required

        Name that should be displayed for the group in the UI.

      • description array[string]

        Description of the group.

      • isDefault array[string]

        When true, this group will be added automatically to any newly invited or created users.

      • channels array[object]
  • users array[string]

    Unique GUIDs of users to add to this group when it is created.


  • 200 object

    Successfully created group in Atlan. Note that this does not necessarily mean that any users were successfully associated with the group. To see those results, look at the users map in the response and review the status provided for each user therein.

    • group string

      Unique identifier (GUID) of the group that was created.

    • users object

      Map of user GUIDs to the result of associating that user with the group.

  • 400 object

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

POST /api/service/groups
curl \
 -X POST \
 -H "Authorization: Bearer $ACCESS_TOKEN" \
 -H "Content-Type: application/json" \
 -d '{"group":{"name":"human_resources","attributes":{"alias":["Human Resources"],"description":["Users in the human resources team."],"isDefault":["false"],"channels":[{}]}},"users":["53954c95-47f8-49b3-9812-23eb40fb07cc"]}'
Request example
  "group": {
    "name": "human_resources",
    "attributes": {
      "alias": [
        "Human Resources"
      "description": [
        "Users in the human resources team."
      "isDefault": [
      "channels": [
  "users": [
Response example (200)
  "group": "9e24070f-7ddb-4420-b015-bb6be3551407",
  "users": {
    "53954c95-47f8-49b3-9812-23eb40fb07cc": {
      "status": 200,
      "statusMessage": "success"
Response example (400)
  "code": 3500,
  "error": "keycloak error",
  "info": null,
  "message": "409 Conflict: Top level group named 'human_resources' already exists.",
  "requestId": "xtZnmycJKQYAUSFw1GPxiAlbJ9gdBela"