Webex · Schema

GetGroupResponse

CallingCollaborationCommunicationEnterpriseMessagingVideo Conferencing

Properties

Name Type Description
schemas array Input JSON schemas.
displayName string A human-readable name for the group.
id string A unique identifier for the group.
externalId string An identifier for the resource as defined by the provisioning client.
members array A list of members of this group.
meta object Response metadata.
urn:scim:schemas:extension:cisco:webexidentity:2.0:Group object The Cisco extention of SCIM 2
View JSON Schema on GitHub

JSON Schema

webex-getgroupresponse-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/GetGroupResponse",
  "title": "GetGroupResponse",
  "type": "object",
  "required": [
    "schemas",
    "displayName",
    "id",
    "meta"
  ],
  "properties": {
    "schemas": {
      "type": "array",
      "items": {
        "type": "string",
        "example": "urn:ietf:params:scim:schemas:core:2.0:Group,urn:scim:schemas:extension:cisco:webexidentity:2.0:Group"
      },
      "description": "Input JSON schemas."
    },
    "displayName": {
      "type": "string",
      "example": "[email protected]",
      "description": "A human-readable name for the group."
    },
    "id": {
      "type": "string",
      "example": "cb8f48e4-5db2-496b-b43d-83d8d5a2a4b3",
      "description": "A unique identifier for the group."
    },
    "externalId": {
      "type": "string",
      "example": "test",
      "description": "An identifier for the resource as defined by the provisioning client."
    },
    "members": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "type": {
            "type": "string",
            "example": "user",
            "description": "A label indicating the type of resource, for example user, machine, or group."
          },
          "value": {
            "type": "string",
            "example": "c5349664-9f3d-410b-8bd3-6c31f181f13d",
            "description": "The identifier of the member of this Group."
          },
          "display": {
            "type": "string",
            "example": "A user",
            "description": "A human-readable name for the group member."
          },
          "$ref": {
            "type": "string",
            "example": "https://example.com/v2/Users/c5349664-9f3d-410b-8bd3-6c31f181f13d",
            "description": "The URI corresponding to a SCIM resource that is a member of this Group."
          }
        }
      },
      "description": "A list of members of this group."
    },
    "meta": {
      "$ref": "#/components/schemas/MetaObject",
      "description": "Response metadata."
    },
    "urn:scim:schemas:extension:cisco:webexidentity:2.0:Group": {
      "type": "object",
      "required": [
        "usage",
        "provisionSource",
        "meta"
      ],
      "properties": {
        "usage": {
          "type": "string",
          "example": "location",
          "description": "The identifier of this group."
        },
        "owners": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "value": {
                "type": "string",
                "example": "c5349664-9f3d-410b-8bd3-6c31f181f13d",
                "description": "The identifier of the owner of this Group."
              }
            }
          },
          "description": "The owners of this group."
        },
        "managedBy": {
          "type": "array",
          "items": {
            "$ref": "#/components/schemas/ManagedByObject"
          },
          "description": "A list of delegates of this group."
        },
        "provisionSource": {
          "type": "string",
          "example": "AD",
          "description": "The identifier of the source."
        },
        "inheritances": {
          "type": "array",
          "items": {
            "$ref": "#/components/schemas/GroupInheritancesObject"
          },
          "description": "An array of inheritances"
        },
        "meta": {
          "type": "object",
          "required": [
            "organizationID"
          ],
          "properties": {
            "organizationID": {
              "type": "string",
              "example": "e9f9ab27-0459-4cd0-bd72-089bde5a7da6",
              "description": "The ID of the organization to which this group belongs."
            }
          },
          "description": "Response metadata."
        }
      },
      "description": "The Cisco extention of SCIM 2"
    }
  }
}