Skip to main content

Members

Manage team members and their roles.

GET /api/teams/{id}/members​

Get all team members.

Response:

{
  "_links": {
    "self": { "href": "/api/teams/{id}/members" }
  },
  "_embedded": {
    "inf:member": [
      {
        "teamId": "team:analytics",
        "userId": "john.doe",
        "role": "admin",
        "joinedAt": "2024-01-15T10:00:00Z",
        "_embedded": {
          "inf:user": {
            "username": "john.doe",
            "displayName": "John Doe"
          }
        }
      }
    ]
  },
  "start": 0,
  "count": 1,
  "total": 1
}

GET /api/teams/{id}/members/{username}​

Get a specific member.

PUT /api/teams/{id}/members/{username}​

Add or update a team member.

Permissions: Team admin

Request Body:

{
  "role": "dataWizard"
}

Roles:

  • admin - Team administrator
  • publisher - Content publisher
  • dataWizard - Data manager
  • designer - Report designer
  • memberPlus - Extended member
  • member - Basic member

Response:

Returns membership object.

DELETE /api/teams/{id}/members/{username}​

Remove a member from the team.

Permissions: Team admin

Response:

204 No Content on success.

PATCH /api/memberships​

Bulk update memberships.

Request Body:

{
  "add": [
    { "teamId": "team:analytics", "userId": "jane.doe", "role": "member" }
  ],
  "remove": [
    { "teamId": "team:analytics", "userId": "old.user" }
  ],
  "update": [
    { "teamId": "team:analytics", "userId": "john.doe", "role": "admin" }
  ]
}

Response:

{
  "added": 1,
  "removed": 1,
  "updated": 1
}

Use Case:

Efficiently manage multiple membership changes in one request.