Group - Updates a group for a tenant

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

put
Authorizations
Path parameters
tenantIdstring · uuidRequired

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

groupIdstring · uuidRequired

The ID of the group to be updated.

Query parameters
versionstringOptional

The requested API version

Default: 1.0
Body

Class for representing update request for group model.

displayNamestring | nullableOptional

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.

descriptionstring | nullableOptional

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.

roleIdstring · uuid | nullableOptional

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.

Default: null
Responses
200

Success: The group has been successfully updated.

put
/tenants/{tenantId}/groups/{groupId}
PUT /tenants/{tenantId}/groups/{groupId} HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 91

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

PreviousGroup - Retrieves details of a group for a tenantNextGroup - Deletes a group for a tenant

Last updated