Update a group with a full payload

Replaces a specific group by supplying the complete SCIM Group resource payload. Use this endpoint when synchronizing full group state from identity providers. For example, to update a group's displayName and metadata, send PUT /scim/v2/Groups/76a01ceb-1cdf-4cfe-a02d-a20c702052c4 with the full group JSON including schemas and displayName. Any missing fields in the request will be updated to null or result in a failed request.

Terminology

  • SCIM: System for Cross-domain Identity Management, a standard protocol for managing identities across systems - GUID: Globally Unique Identifier format (xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx) used for group IDs - HTTP: Hypertext Transfer Protocol; HTTP 404 indicates the groupId was not found - RFC 7644: IETF standard for SCIM 2.0 full resource replacement (PUT) semantics
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
uuid
required
^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$

The unique identifier (GUID - Globally Unique Identifier) of the group. Must be a valid UUID format (xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx). Obtain this value from GET /scim/v2/Groups or group management operations.

Body Params

Complete SCIM Group resource payload that replaces all existing group metadata.

string
required
length ≥ 1

Human-readable name for the group used for display in user interfaces and group management operations. Required when replacing the full group resource.

schemas
array of strings
required
length ≥ 1

SCIM schema identifiers array indicating this resource follows the core Group schema as defined in SCIM 2.0 specification (RFC 7643).

schemas*
Allowed:
Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/scim+json