Rename group
Relative path: /v1/groups/{groupUuid}:rename
Update group's display name.
Request body
Display Schema instead of an Example or vice-versa
Type |
Required |
Example |
Schema |
---|---|---|---|
application/json |
No |
{ "displayName": "string" } |
{
"$ref": "GroupsRenameGroupBody",
"displayName": {
"type": "string",
"description": "New display name for the group."
}
} |
Parameters in path
Name |
Type |
Required |
Description |
---|---|---|---|
groupUuid |
string |
Yes |
Reference of group for which the name is changed. type: Group |
Responses
Display Schema instead of an Example or vice-versa
Code |
Description |
Example |
Schema |
---|---|---|---|
200 |
Successful response. |
{ "group": { "description": "string", "displayName": "string", "linkedEntityType": "GROUP_ENTITY_TYPE_UNSPECIFIED", "parentGroupUuid": "string", "uuid": "string", "ownerUuid": "string" } } |
{ "$ref": "v1RenameGroupResponse", "group": { "$ref": "v1Group", "description": { "type": "string", "description": "Group description. Free text." }, "displayName": { "type": "string", "description": "User friendly name of the group." }, "linkedEntityType": { "$ref": "v1GroupEntityType", "type": "string", "description": "Possible entities that Group represents. GROUP_ENTITY_TYPE_UNSPECIFIED: fallback GROUP_ENTITY_TYPE_CUSTOMER: Group representing [company] GROUP_ENTITY_TYPE_MSP: Group representing [MSP] GROUP_ENTITY_TYPE_SITE: Group representing [site] GROUP_ENTITY_TYPE_HOUSEHOLD: Group representing [household]", "default": "GROUP_ENTITY_TYPE_UNSPECIFIED", "enum": [ "GROUP_ENTITY_TYPE_UNSPECIFIED", "GROUP_ENTITY_TYPE_CUSTOMER", "GROUP_ENTITY_TYPE_MSP", "GROUP_ENTITY_TYPE_SITE", "GROUP_ENTITY_TYPE_HOUSEHOLD" ] }, "parentGroupUuid": { "type": "string", "description": "Reference to parent group in tree structure. type: Group" }, "uuid": { "type": "string", "description": "Unique identifier of the entity. Must be collision free - two identifiers created anywhere in the world must not collide within entity parent scope. Unless a member of aggregate, the entity scope is always global. Although most of the times compliant with RFC 4122: A Universally Unique IDentifier (UUID) URN Namespace, do not rely on it being a RFC UUID. Treat it as an opaque identifier. RFC UUID can be recognized by being formatted according to template xxxxxxxx-xxxx-Mxxx-Nxxx-xxxxxxxxxxxx, as explained on wikipedia. UUID is used for referencing an entity, even across domains. Example: '123e4567-e89b-12d3-a456-426614174000'" }, "ownerUuid": { "type": "string", "description": "Identifier of tenant who owns this object. type: tenant_management.v1.Tenant" } } } |
202 |
Response took too long; request cached. Response can be retrieved later using the response-id header. |
null |
[] |
400 |
One of the errors: 1. Bad or missing authorization. 2. Validation error. Invalid argument provided. |
null |
[] |
401 |
Token has expired or is invalid. |
null |
[] |
403 |
Access denied. Check permissions. |
null |
[] |
404 |
Requested resource not found. |
null |
[] |
429 |
Rate limit reached. Try again later. |
null |
[] |
500 |
Internal server failure. Try again later. |
null |
[] |
502 |
Internal server failure. Try again later. |
null |
[] |
503 |
Environment under maintenance. Try again later. |
null |
[] |
504 |
Action took too long; timeout reached |
null |
[] |