Group - Updates a group for a tenant

Updates an existing group under a specific tenant in the system.

PUT/tenants/{tenantId}/groups/{groupId}

Authorization

Bearer

Path parameters

tenantId*string (uuid)

Enter the ID of the existing tenant under which the group will be updated.

groupId*string (uuid)

Enter the ID of the group to be updated.

Query parameters

Body

application/jsontext/jsonapplication/*+json

displayNamenullable string

A public property of type string that has both a getter and a setter method, which allows for getting and setting the value of the DisplayName property.

descriptionnullable string

A public property of type string that has both a getter and a setter method, which allows for getting and setting the value of the Description property.

roleIdnullable string (uuid)

A public property of type guid that has both a getter and a setter method, which allows for getting and setting the value of the GroupId property.

Response

200500

Success: The group has been successfully updated.

Body

text/plainapplication/jsontext/json

groupIdstring (uuid)

A public property of type guid that has both a getter and a setter method, which allows for getting and setting the value of the GroupId property.

tenantIdstring (uuid)

A public property of type guid that has both a getter and a setter method, which allows for getting and setting the value of the TenantId property.

roleIdnullable string (uuid)

A public property of type guid that has both a getter and a setter method, which allows for getting and setting the value of the GroupId property.

displayNamenullable string

A public property of type string that has both a getter and a setter method, which allows for getting and setting the value of the DisplayName property.

descriptionnullable string

A public property of type string that has both a getter and a setter method, which allows for getting and setting the value of the Description property.

Request

JavaScriptCurlPythonHTTP

const response = await fetch('/tenants/{tenantId}/groups/{groupId}', {
    method: 'PUT',
    headers: {
      "Authorization": "Bearer JWT",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200500

{
  "groupId": "123e4567-e89b-12d3-a456-426614174000",
  "tenantId": "123e4567-e89b-12d3-a456-426614174000",
  "roleId": "123e4567-e89b-12d3-a456-426614174000",
  "displayName": "text",
  "description": "text"
}