Sign in
Groups

Add a user to a group

Adds the specified user to the given group. If the user does not already have access to the tenant, tenant access will be created automatically.

put/api/v1/{tenant}/groups/{id}/members/{userId}

Request

  • Base URL: / (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /api/v1/{tenant}/groups/{id}/members/{userId}
  • Auth: one of:
    • HTTP bearer
    • HTTP basic

Path parameters

idstring required

The ID of the group

userIdstring required

The ID of the user to add to the group

tenantstring required

Response

User was successfully added to the group

idstring
usernamestring
displayNamestring

Example response

{
  "displayName": "displayName",
  "groups": [
    {
      "external": true,
      "name": "name",
      "id": "id",
      "membership": "OWNER"
    },
    {
      "external": true,
      "name": "name",
      "id": "id",
      "membership": "OWNER"
    }
  ],
  "id": "id",
  "username": "username"
}

Changes

No recorded changes to this operation across all 7 revisions of this API.