SCIM Group Resource

The SCIM group resource object.

APIs.ioEngineeringPlatform

Properties

Name	Type	Description
schemas	array	The [SCIM schema URI](https://www.iana.org/assignments/scim/scim.xhtml).
id	string	The group's SCIM ID.
displayName	string	The group's display name.
members	array	A list of the group's members.
externalId	string	The group's external ID.
meta	object	The response's non-standard meta information.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/scimGroupResource",
  "title": "SCIM Group Resource",
  "description": "The SCIM group resource object.",
  "type": "object",
  "properties": {
    "schemas": {
      "type": "array",
      "description": "The [SCIM schema URI](https://www.iana.org/assignments/scim/scim.xhtml).",
      "items": {
        "type": "string",
        "example": "urn:ietf:params:scim:schemas:core:2.0:Group"
      }
    },
    "id": {
      "type": "string",
      "description": "The group's SCIM ID.",
      "example": "405775fe15ed41872a8eea4c8aa2b38cda9749812cc55c99"
    },
    "displayName": {
      "type": "string",
      "description": "The group's display name.",
      "example": "Test SCIMv2"
    },
    "members": {
      "type": "array",
      "description": "A list of the group's members.",
      "items": {
        "type": "object",
        "description": "Information about the group's members.",
        "properties": {
          "value": {
            "type": "string",
            "description": "The resource value.",
            "example": "23a35c2723d34c03b4c56443c09e7173"
          },
          "display": {
            "type": "string",
            "description": "The resource's display name.",
            "example": "[email protected]"
          }
        }
      }
    },
    "externalId": {
      "type": "string",
      "description": "The group's external ID.",
      "example": "1234"
    },
    "meta": {
      "type": "object",
      "description": "The response's non-standard meta information.",
      "properties": {
        "resourceType": {
          "type": "string",
          "description": "The resource type.",
          "example": "Group"
        },
        "created": {
          "type": "string",
          "format": "date-time",
          "description": "The date and time at which the group was created.",
          "example": "2022-02-22T04:24:13.000Z"
        },
        "lastModified": {
          "type": "string",
          "format": "date-time",
          "description": "The date and time at which the group was last modified.",
          "example": "2022-02-22T04:24:13.000Z"
        }
      }
    }
  }
}