Webex · Example Payload
Webex Get Group Schema Example
CallingCollaborationCommunicationEnterpriseMessagingVideo Conferencing
Webex Get Group Schema 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
{
"operationId": "Get Group Schema",
"method": "GET",
"path": "/Schemas/SCIM2/Group",
"summary": "Get Group Schema",
"requestExamples": [],
"responseExamples": [
{
"status": "200",
"contentType": "application/json",
"example": {
"urn:ietf:params:scim:schemas:core:2.0:Group": {
"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
}
]
},
"urn:scim:schemas:extension:cisco:webexidentity:2.0:Group": {
"id": "urn:scim:schemas:extension:cisco:webexidentity:2.0:Group",
"name": "Cisco Group",
"description": "Cisco Group",
"attributes": [
{
"name": "usage",
"type": "String",
"multiValued": false,
"description": "The identifier of this `Group`.",
"required": false,
"caseExact": false,
"mutability": "ReadWrite",
"returned": "Default",
"canonicalValues": [
"location",
"distribution",
"policy"
],
"uniqueness": "None"
},
{
"name": "provisionSource",
"type": "String",
"multiValued": false,
"description": "The type of the account provision source.",
"required": false,
"caseExact": false,
"mutability": "ReadOnly",
"returned": "Default",
"canonicalValues": [
"SCIM",
"AD",
"AAD",
"BROADWORKS",
"OKTA"
],
"uniqueness": "None"
},
{
"name": "owners",
"type": "String",
"multiValued": true,
"description": "The owners of this group.",
"required": false,
"caseExact": false,
"mutability": "ReadWrite",
"returned": "Default",
"uniqueness": "None",
"subAttributes": [
{
"name": "value",
"type": "String",
"multiValued": false,
"description": "The value of owners.",
"required": false,
"caseExact": false,
"mutability": "ReadWrite",
"returned": "Default",
"uniqueness": "None"
},
{
"name": "display",
"type": "String",
"multiValued": false,
"description": "A human-readable name, primarily used for display purposes.",
"required": false,
"caseExact": false,
"mutability": "ReadWrite",
"returned": "Default",
"uniqueness": "None"
},
{
"name": "primary",
"type": "Boolean",
"multiValued": false,
"description": "A Boolean value indicating the 'primary' or preferred attribute value for this attribute. The primary attribute value 'true' must appear no more than once.",
"required": false,
"caseExact": false,
"mutability": "ReadWrite",
"returned": "Default",
"uniqueness": "None"
}
],
"size": 30
},
{
"name": "managedBy",
"type": "String",
"multiValued": true,
"description": "The resources that have delegated roles on this `Group`.",
"required": false,
"caseExact": false,
"mutability": "ReadWrite",
"returned": "Default",
"uniqueness": "None",
"subAttributes": [
{
"name": "orgId",
"type": "String",
"multiValued": false,
"description": "The organization identifier of the resource.",
"required": false,
"caseExact": false,
"mutability": "Immutable",
"returned": "Default",
"uniqueness": "None",
"length": 64
},
{
"name": "type",
"type": "String",
"multiValued": false,
"description": "The resource type.",
"required": false,
"caseExact": false,
"mutability": "Immutable",
"returned": "Default",
"canonicalValues": [
"Group",
"User",
"Machine"
],
"uniqueness": "None"
},
{
"name": "id",
"type": "String",
"multiValued": false,
"description": "The identifier of the resource.",
"required": false,
"caseExact": false,
"mutability": "Immutable",
"returned": "Default",
"uniqueness": "None"
},
{
"name": "role",
"type": "String",
"multiValued": false,
"description": "The delegated role.",
"required": false,
"caseExact": false,
"mutability": "ReadWrite",
"returned": "Default",
"uniqueness": "None",
"length": 64
}
],
"size": 30
},
{
"name": "inheritances",
"type": "String",
"multiValued": true,
"description": "Inheritance supported by this group.",
"required": false,
"caseExact": false,
"mutability": "ReadWrite",
"returned": "Default",
"uniqueness": "None",
"subAttributes": [
{
"name": "type",
"type": "String",
"multiValued": false,
"description": "The resource type.",
"required": false,
"caseExact": false,
"mutability": "Immutable",
"returned": "Default",
"canonicalValues": [
"role"
],
"uniqueness": "None"
},
{
"name": "value",
"type": "String",
"multiValued": false,
"description": "The value.",
"required": false,
"caseExact": false,
"mutability": "Immutable",
"returned": "Default",
"canonicalValues": [
"id_user_admin",
"id_readonly_admin",
"id_device_admin",
"id_full_admin"
],
"uniqueness": "None"
},
{
"name": "nested",
"type": "String",
"multiValued": false,
"description": "The boolean value if field is nested.",
"required": false,
"caseExact": false,
"mutability": "Immutable",
"returned": "Default",
"uniqueness": "None"
},
{
"name": "scope",
"type": "String",
"multiValued": false,
"description": "The scope.",
"required": false,
"caseExact": false,
"mutability": "Immutable",
"returned": "Default",
"uniqueness": "None"
}
],
"size": 10
},
{
"name": "memberFilter",
"type": "String",
"multiValued": true,
"description": "The memberFilter for the `Group`.",
"required": false,
"caseExact": false,
"mutability": "ReadWrite",
"returned": "Default",
"uniqueness": "None",
"subAttributes": [
{
"name": "value",
"type": "String",
"multiValued": false,
"description": "The value of memberFilter.",
"required": false,
"caseExact": false,
"mutability": "ReadWrite",
"returned": "Default",
"uniqueness": "None"
},
{
"name": "display",
"type": "String",
"multiValued": false,
"description": "A human-readable name, primarily used for display purposes.",
"required": false,
"caseExact": false,
"mutability": "ReadWrite",
"returned": "Default",
"uniqueness": "None"
},
{
"name": "type",
"type": "String",
"multiValued": false,
"description": "A label indicating the attribute's function.",
"required": false,
"caseExact": false,
"mutability": "ReadWrite",
"returned": "Default",
"canonicalValues": [
"user"
],
"uniqueness": "None"
},
{
"name": "primary",
"type": "Boolean",
"multiValued": false,
"description": "A Boolean value indicating the 'primary' or preferred attribute value for this attribute. The primary attribute value 'true' must appear no more than once.",
"required": false,
"caseExact": false,
"mutability": "ReadWrite",
"returned": "Default",
"uniqueness": "None"
}
],
"size": 1
},
{
"name": "groupType",
"type": "String",
"multiValued": false,
"description": "The type of the `Group`.",
"required": false,
"caseExact": false,
"mutability": "ReadWrite",
"returned": "Default",
"canonicalValues": [
"unique_flat_static",
"dynamic",
"flat_static",
"nested_static"
],
"uniqueness": "None"
}
]
}
}
}
]
}