Skip to main content

Group

SCIM Group resource as defined in RFC 7643 Section 4.2. Represents a group of users.

displayNamestringrequired

A human-readable name for the group. REQUIRED

externalIdstring

Identifier for the group as defined by the provisioning client. Allows the client to maintain their own identifier.

idstring

Unique identifier for the group. Assigned by the service provider. MUST be unique across the entire set of resources. Immutable.

members object[]

Members of the group (users or nested groups)

  • Array [
  • $refstring<uri>

    The URI of the corresponding User or Group resource

    displaystring

    A human-readable name for the member

    typestring

    The type of member

    Possible values: [User, Group]

    valuestring

    The identifier of the member (user or group ID)

  • ]
  • meta object

    Resource metadata as defined in RFC 7643 Section 3.1

    createdstring<date-time>

    The timestamp when the resource was created

    lastModifiedstring<date-time>

    The timestamp when the resource was last modified

    locationstring<uri>

    The URI of the resource

    resourceTypestring

    The name of the resource type (e.g., User, Group)

    versionstring

    The version of the resource. Used for ETag-based versioning. Weak ETags are prefixed with W/

    schemasstring[]required

    The schema URIs that define this resource

    Possible values: [urn:ietf:params:scim:schemas:core:2.0:Group]

    Group
    {
    "displayName": "string",
    "externalId": "string",
    "id": "string",
    "members": [
    {
    "$ref": "string",
    "display": "string",
    "type": "User",
    "value": "string"
    }
    ],
    "meta": {
    "created": "2024-07-29T15:51:28.071Z",
    "lastModified": "2024-07-29T15:51:28.071Z",
    "location": "string",
    "resourceType": "string",
    "version": "string"
    },
    "schemas": [
    "urn:ietf:params:scim:schemas:core:2.0:Group"
    ]
    }