GOgooddata
project-users-management

Add a user to or disable from a project

To be able to add a user to or disable from a project, you must be an administrator of that project and the domain where the project belongs to.

Typically, the maximum number of users in a project is 10,000. If you need to exceed this limit, contact GoodData Support.

When adding a user, set its status to ENABLED and specify a user role ID. User roles and their IDs are project-specific. For more information about user roles, see User Roles.

To disable a user, set its status to DISABLED.

This API accepts arrays of objects. That is, you can add or disable more users to a project via one API call.

To get information about the specific user role IDs for a project, see Get roles for a project. If you are the domain administrator of the user, you can identify the user also by login instead of profile_id: use "self": "/gdc/account/profile/username@domain.com? in the links parameter.

post/gdc/projects/{project_id}/users

Request

  • Base URL
    https://secure.gooddata.com
  • Auth
    none declared

Path parameters

project_idstring required

The ID of the project whose users you want to manage.

Request body

OR

Example request

{
  "user": {
    "content": {
      "userRoles": [
        "/gdc/projects/{project_id}/roles/{role_id}"
      ]
    },
    "links": {
      "self": "/gdc/account/profile/p123",
      "roles": "/project/{project_id}/users/{user_id}/roles",
      "permissions": "/project/{project_id}/users/{user_id}/permissions",
      "projectRelUri": "/project/{project_id}/users/{user_id}",
      "invitations": "/account/profile/{user_id}/invitations",
      "projects": "/account/profile/{user_id}/projects"
    },
    "meta": {
      "title": "Some title",
      "category": "metadataType",
      "tags": "tag1 tag2",
      "author": "/gdc/account/profile/p123",
      "created": "2020-01-08 15:44:23",
      "contributor": "/gdc/account/profile/p123",
      "updated": "2020-01-08 15:44:23",
      "identifier": "identifier123",
      "summary": "Object summary",
      "uri": "/gdc/uri/self"
    }
  }
}

Response

_

Example response

{
  "projectUsersUpdateResult": {
    "successful": [
      "/gdc/account/profile/p123"
    ],
    "failed": [
      {
        "user": "/gdc/account/profile/p123",
        "message": "Maximum number of users for this project already reached."
      }
    ]
  }
}

Changes

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