Webex · Example Payload

Webex Get Schema Using Group Schema Id Example

CallingCollaborationCommunicationEnterpriseMessagingVideo Conferencing

Webex Get Schema Using Group Schema Id Example is an example object payload from Webex, with 6 top-level fields. It illustrates the shape of data this provider's APIs accept or return.

Top-level fields

operationIdmethodpathsummaryrequestExamplesresponseExamples

Example Payload

Raw ↑
{
  "operationId": "Get Schema using Group Schema ID",
  "method": "GET",
  "path": "/Schemas/SCIM2/{schemaId}",
  "summary": "Get Schema using Group Schema ID",
  "requestExamples": [],
  "responseExamples": [
    {
      "status": "200",
      "contentType": "application/json",
      "example": {
        "id": "urn:ietf:params:scim:schemas:core:2.0:Group",
        "name": "Group",
        "description": "Group",
        "attributes": [
          {
            "name": "id",
            "type": "String",
            "multiValued": false,
            "description": "A unique identifier of this `Group` resource defined by the service provider.",
            "required": false,
            "caseExact": true,
            "mutability": "ReadOnly",
            "returned": "Default",
            "uniqueness": "Global"
          },
          {
            "name": "displayName",
            "type": "String",
            "multiValued": false,
            "description": "A human-readable name for the `Group`. REQUIRED.",
            "required": false,
            "caseExact": false,
            "mutability": "ReadWrite",
            "returned": "Default",
            "uniqueness": "None",
            "length": 512
          },
          {
            "name": "externalId",
            "type": "String",
            "multiValued": false,
            "description": "An identifier for the resource as defined by the provision client.",
            "required": false,
            "caseExact": false,
            "mutability": "ReadWrite",
            "returned": "Default",
            "uniqueness": "None",
            "length": 256
          },
          {
            "name": "members",
            "type": "String",
            "multiValued": true,
            "description": "A list of roles for the user that collectively represent who the user is.",
            "required": false,
            "caseExact": false,
            "mutability": "ReadWrite",
            "returned": "Default",
            "uniqueness": "None",
            "subAttributes": [
              {
                "name": "value",
                "type": "Reference",
                "referenceTypes": [
                  "external"
                ],
                "multiValued": false,
                "description": "The identifier of the member of this `Group`.",
                "required": false,
                "caseExact": false,
                "mutability": "Immutable",
                "returned": "Default",
                "uniqueness": "None"
              },
              {
                "name": "type",
                "type": "String",
                "multiValued": false,
                "description": "A label indicating the type of resource, e.g., 'Group', 'Machine', or 'Group'.",
                "required": false,
                "caseExact": false,
                "mutability": "Immutable",
                "returned": "Default",
                "canonicalValues": [
                  "Group",
                  "User",
                  "Machine"
                ],
                "uniqueness": "None"
              },
              {
                "name": "display",
                "type": "String",
                "multiValued": false,
                "description": "A human-readable name, primarily used for display purposes.",
                "required": false,
                "caseExact": false,
                "mutability": "ReadOnly",
                "returned": "Default",
                "uniqueness": "None"
              },
              {
                "name": "$ref",
                "type": "Reference",
                "referenceTypes": [
                  "User",
                  "Group",
                  "Machine"
                ],
                "multiValued": false,
                "description": "The URI corresponding to a SCIM resource that is a member of this `Group`.",
                "required": false,
                "caseExact": false,
                "mutability": "Immutable",
                "returned": "Default",
                "uniqueness": "None"
              }
            ],
            "size": 500
          }
        ]
      }
    }
  ]
}