POST
/organization/groups/{group_id}Update a group
Updates a group's display name in the organization. Supply name as a string between 1 and 255 characters. The response includes the group's identifier, updated name, creation timestamp, and SCIM management status.
- IdempotentThe SDK sends
Idempotency-Key, so a retried request is only applied once.
group_idstringrequired
The identifier of the group to update.
New attributes to set on the group.
namestringrequired
New display name for the group.
200Returns the updated group with its identifier, name, creation timestamp, and SCIM management status.
idstringrequired
Identifier for the group.
namestringrequired
Updated display name for the group.
created_atintegerrequired
Unix timestamp (in seconds) when the group was created.
is_scim_managedbooleanrequired
Whether the group is managed through SCIM and controlled by your identity provider.
400Returned when the request parameters are invalid or the requested operation cannot be performed.
errorobjectrequired
403Returned when the authenticated user does not have permission to perform the operation.
errorobjectrequired
Details about the permission error.
404Returned when the endpoint is unavailable or a requested group, user, or project is not found.
errorobjectrequired
429Returned when the request is rejected because a rate limit was exceeded.
errorobjectrequired
500Returned when a server error prevents the group operation from completing.
errorobjectrequired
Error handling
A 400 is returned when the request parameters are invalid or the operation cannot be performed; a 403 when the authenticated user lacks permission; a 404 when the endpoint is unavailable or the group is not found; a 429 when the rate limit is exceeded; and a 500 when a server error prevents the operation. The group_id path parameter must identify the group to update. The body must include name, which must contain between 1 and 255 characters.