UserGroups - Declarative APIs

Put all users and user groups

Define all users and user groups with theirs properties.

put/api/v1/layout/usersAndUserGroups

Request

  • Base URL
    https://www.gooddata.ai
  • Auth
    none declared

Request body

Example request

{
  "userGroups": [
    {
      "id": "employees.all",
      "name": "admins",
      "parents": [
        {
          "id": "admins",
          "type": "userGroup"
        }
      ]
    }
  ],
  "users": [
    {
      "email": "user@example.com",
      "firstname": "John",
      "id": "employee123",
      "lastname": "Wick",
      "settings": [
        {
          "content": {},
          "type": "TIMEZONE"
        }
      ],
      "userGroups": [
        {
          "id": "admins",
          "type": "userGroup"
        }
      ]
    }
  ]
}

Response

Defined all users and user groups.

Changes

No recorded changes to this operation across all 1 revision of this API.