Webex · Example Payload
Webex Get User Schema Example
CallingCollaborationCommunicationEnterpriseMessagingVideo Conferencing
Webex Get User 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 User Schema",
"method": "GET",
"path": "/Schemas/SCIM2/User",
"summary": "Get User Schema",
"requestExamples": [],
"responseExamples": [
{
"status": "200",
"contentType": "application/json",
"example": {
"urn:scim:schemas:extension:cisco:webexidentity:2.0:User": {
"id": "urn:scim:schemas:extension:cisco:webexidentity:2.0:User",
"name": "EnterpriseUser",
"description": "Enterprise User",
"attributes": [
{
"name": "accountStatus",
"type": "String",
"multiValued": true,
"description": "Account status of the user.",
"required": false,
"caseExact": false,
"mutability": "ReadWrite",
"returned": "Default",
"canonicalValues": [
"compliance-transient",
"pending-transient",
"marked_deleted",
"transient",
"fraud-transient",
"fraud",
"pending",
"active",
"disabled",
"suspended"
],
"uniqueness": "None"
},
{
"name": "authProvider",
"type": "String",
"multiValued": false,
"description": "Authentication provider for the user. Base on organization configuration",
"required": false,
"caseExact": false,
"mutability": "ReadWrite",
"returned": "Default",
"canonicalValues": [
"facebook",
"O365",
"google",
"cco"
],
"uniqueness": "None"
},
{
"name": "teamsClusterId",
"type": "String",
"multiValued": false,
"description": "teamsClusterId of the organization user belongs to.",
"required": false,
"caseExact": false,
"mutability": "ReadOnly",
"returned": "Default",
"uniqueness": "None"
},
{
"name": "isTeamsOnJabberEnabled",
"type": "Boolean",
"multiValued": false,
"description": "Whether user is enabled teams in Jabber.",
"required": false,
"caseExact": false,
"mutability": "ReadWrite",
"returned": "Default",
"uniqueness": "None"
},
{
"name": "isUCCallOnJabberEnabled",
"type": "Boolean",
"multiValued": false,
"description": "Whether user is enabled On UC Call in Jabber.",
"required": false,
"caseExact": false,
"mutability": "ReadWrite",
"returned": "Default",
"uniqueness": "None"
},
{
"name": "mfaEnabled",
"type": "Boolean",
"multiValued": false,
"description": "Whether user is enabled for MFA.",
"required": false,
"caseExact": false,
"mutability": "ReadWrite",
"returned": "Default",
"uniqueness": "None"
},
{
"name": "macAddresses",
"type": "String",
"multiValued": true,
"description": "macAddresses assigned to this user.",
"required": false,
"caseExact": false,
"mutability": "ReadWrite",
"returned": "Default",
"uniqueness": "None",
"size": 50
},
{
"name": "licenseID",
"type": "String",
"multiValued": true,
"description": "licenseIDs assigned to this user. Webex Identity does not interpret the format or semantics of the value.",
"required": false,
"caseExact": false,
"mutability": "ReadWrite",
"returned": "Default",
"uniqueness": "None",
"size": 1000
},
{
"name": "userSettings",
"type": "String",
"multiValued": true,
"description": "Settings value for the user. Webex Identity does not interpret the format or semantics of the value.",
"required": false,
"caseExact": false,
"mutability": "ReadWrite",
"returned": "Default",
"uniqueness": "None",
"size": 1000
},
{
"name": "userPreferences",
"type": "String",
"multiValued": true,
"description": "User preference. Webex Identity does not interpret the format or semantics of the value.",
"required": false,
"caseExact": false,
"mutability": "ReadWrite",
"returned": "Default",
"uniqueness": "None",
"size": 1000
},
{
"name": "sipAddresses",
"type": "Complex",
"multiValued": true,
"description": "SipAddress values for the User.",
"required": false,
"caseExact": false,
"mutability": "ReadWrite",
"returned": "Default",
"uniqueness": "None",
"subAttributes": [
{
"name": "value",
"type": "String",
"multiValued": false,
"description": "The value of sipAddresses.",
"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": [
"enterprise",
"cloud-calling",
"personal-room"
],
"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": 2000
},
{
"name": "trainSiteNames",
"type": "String",
"multiValued": true,
"description": "List of CI-enabled sites the user belongs to.",
"required": false,
"caseExact": false,
"mutability": "ReadWrite",
"returned": "Default",
"uniqueness": "None",
"size": 2000
},
{
"name": "managedSites",
"type": "Complex",
"multiValued": true,
"description": "Used to identify that the user is site admin of a site.",
"required": false,
"caseExact": false,
"mutability": "ReadWrite",
"returned": "Default",
"uniqueness": "None",
"subAttributes": [
{
"name": "siteName",
"type": "String",
"multiValued": false,
"description": "Site name",
"required": true,
"caseExact": true,
"mutability": "ReadWrite",
"returned": "Default",
"uniqueness": "None",
"length": 512
},
{
"name": "role",
"type": "String",
"multiValued": false,
"description": "Role in the site for the user.",
"required": true,
"caseExact": false,
"mutability": "ReadWrite",
"returned": "Default",
"uniqueness": "None",
"length": 64
}
],
"size": 2000
},
{
"name": "linkedTrainSiteNames",
"type": "String",
"multiValued": true,
"description": "List of none CI-enabled WebEx sites that the user is linked to through account linking process.",
"required": false,
"caseExact": false,
"mutability": "ReadWrite",
"returned": "Default",
"uniqueness": "None",
"size": 2000
},
{
"name": "primaryLinkedTrainSiteName",
"type": "String",
"multiValued": false,
"description": "If set, Webex Identity will send user to the train site to login. Value is the name of the train site.",
"required": false,
"caseExact": false,
"mutability": "ReadWrite",
"returned": "Default",
"uniqueness": "None",
"length": 128
},
{
"name": "toBeConverted",
"type": "String",
"multiValued": false,
"description": "To be converted value.",
"required": false,
"caseExact": false,
"mutability": "ReadOnly",
"returned": "Default",
"uniqueness": "None",
"length": 254
},
{
"name": "managedOrgs",
"type": "Complex",
"multiValued": true,
"description": "Organizations that the user can manage.",
"required": false,
"caseExact": false,
"mutability": "ReadWrite",
"returned": "Default",
"uniqueness": "None",
"subAttributes": [
{
"name": "orgId",
"type": "String",
"multiValued": false,
"description": "Identity of the organization",
"required": false,
"caseExact": false,
"mutability": "ReadWrite",
"returned": "Default",
"uniqueness": "None",
"length": 64
},
{
"name": "role",
"type": "String",
"multiValued": false,
"description": "Role in the target organization for the user.",
"required": false,
"caseExact": false,
"mutability": "ReadWrite",
"returned": "Default",
"uniqueness": "None",
"length": 64
}
],
"size": 2000
},
{
"name": "managedGroups",
"type": "Complex",
"multiValued": true,
"description": "Organizations that the user can manage.",
"required": false,
"caseExact": false,
"mutability": "ReadWrite",
"returned": "Default",
"uniqueness": "None",
"subAttributes": [
{
"name": "orgId",
"type": "String",
"multiValued": false,
"description": "Identity of the organization",
"required": false,
"caseExact": false,
"mutability": "ReadWrite",
"returned": "Default",
"uniqueness": "None",
"length": 64
},
{
"name": "groupId",
"type": "String",
"multiValued": false,
"description": "Identity of the group",
"required": false,
"caseExact": false,
"mutability": "ReadWrite",
"returned": "Default",
"uniqueness": "None",
"length": 64
},
{
"name": "role",
"type": "String",
"multiValued": false,
"description": "Role in the target group for the user.",
"required": false,
"caseExact": false,
"mutability": "ReadWrite",
"returned": "Default",
"uniqueness": "None",
"length": 64
}
],
"size": 2000
},
{
"name": "extLinkedAccts",
"type": "Complex",
"multiValued": true,
"description": "External linked account for the user.",
"required": false,
"caseExact": false,
"mutability": "ReadWrite",
"returned": "Default",
"uniqueness": "None",
"subAttributes": [
{
"name": "providerID",
"type": "String",
"multiValued": false,
"description": "Identity for the external linked account provider.",
"required": false,
"caseExact": false,
"mutability": "ReadWrite",
"returned": "Default",
"uniqueness": "None",
"length": 64
},
{
"name": "accountGUID",
"type": "String",
"multiValued": false,
"description": "Identifier of the external account, this should be set to a unique identifier from the external source, CI does not enforce format or semantics of this attribute (as long as it is a string).",
"required": false,
"caseExact": false,
"mutability": "ReadWrite",
"returned": "Default",
"uniqueness": "None",
"length": 512
},
{
"name": "status",
"type": "String",
"multiValued": false,
"description": "External linked account status.",
"required": false,
"caseExact": false,
"mutability": "ReadWrite",
"returned": "Default",
"uniqueness": "None",
"length": 64
}
],
"size": 2000
},
{
"name": "loginIds",
"type": "Complex",
"multiValued": true,
"description": "LoginIds for a partner-upn user",
"required": false,
"caseExact": false,
"mutability": "ReadWrite",
"returned": "Default",
"uniqueness": "None",
"subAttributes": [
{
"name": "value",
"type": "String",
"multiValued": false,
"description": "UserName of the user",
"required": false,
"caseExact": false,
"mutability": "ReadWrite",
"returned": "Default",
"uniqueness": "None",
"length": 512
},
{
"name": "format",
"type": "String",
"multiValued": false,
"description": "Format of the user",
"required": false,
"caseExact": false,
"mutability": "ReadWrite",
"returned": "Default",
"uniqueness": "None",
"length": 512
},
{
"name": "type",
"type": "String",
"multiValued": false,
"description": "Type of the user",
"required": false,
"caseExact": false,
"mutability": "ReadWrite",
"returned": "Default",
"uniqueness": "None",
"length": 256
},
{
"name": "status",
"type": "String",
"multiValued": false,
"description": "Status of the user",
"required": false,
"caseExact": false,
"mutability": "ReadWrite",
"returned": "Default",
"uniqueness": "None",
"length": 64
},
{
"name": "lastValidated",
"type": "String",
"multiValued": false,
"description": "TimeStamp for the entry",
"required": false,
"caseExact": false,
"mutability": "ReadWrite",
"returned": "Default",
"uniqueness": "None",
"length": 512
}
],
"size": 2000
},
{
"name": "avatarSyncEnabled",
"type": "Boolean",
"multiValued": false,
"description": "Whether user is enabled for avatar Sync.",
"required": false,
"caseExact": false,
"mutability": "ReadOnly",
"returned": "Default",
"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": "pronouns",
"type": "Complex",
"multiValued": false,
"description": "The pronouns of the user.",
"required": false,
"caseExact": false,
"mutability": "ReadWrite",
"returned": "Default",
"uniqueness": "None",
"subAttributes": [
{
"name": "value",
"type": "String",
"multiValued": false,
"description": "The value of pronouns.",
"required": false,
"caseExact": false,
"mutability": "ReadWrite",
"returned": "Default",
"uniqueness": "None"
},
{
"name": "visibility",
"type": "String",
"multiValued": false,
"description": "The visibility of pronouns. Can be Hidden, Internal, Everyone or global.",
"required": false,
"caseExact": false,
"mutability": "ReadWrite",
"returned": "Default",
"canonicalValues": [
"Everyone",
"Internal",
"Hidden",
"Global"
],
"uniqueness": "None"
}
]
},
{
"name": "userNameType",
"type": "String",
"multiValued": false,
"description": "Format of username. Possible Values : Email, PartnerUPN, Phone",
"required": false,
"caseExact": false,
"mutability": "ReadWrite",
"returned": "Default",
"canonicalValues": [
"phone",
"partner-upn",
"email"
],
"uniqueness": "None"
},
{
"name": "extensionAttribute1",
"type": "String",
"multiValued": true,
"description": "The extensionAttributes of the user.",
"required": false,
"caseExact": false,
"mutability": "ReadWrite",
"returned": "Default",
"uniqueness": "None",
"size": 100
},
{
"name": "extensionAttribute2",
"type": "String",
"multiValued": true,
"description": "The extensionAttributes of the user.",
"required": false,
"caseExact": false,
"mutability": "ReadWrite",
"returned": "Default",
"uniqueness": "None",
"size": 100
},
{
"name": "extensionAttribute3",
"type": "String",
"multiValued": true,
"description": "The extensionAttributes of the user.",
"required": false,
"caseExact": false,
"mutability": "ReadWrite",
"returned": "Default",
"uniqueness": "None",
"size": 100
},
{
"name": "extensionAttribute4",
"type": "String",
"multiValued": true,
"description": "The extensionAttributes of the user.",
"required": false,
"caseExact": false,
"mutability": "ReadWrite",
"returned": "Default",
"uniqueness": "None",
"size": 100
},
{
"name": "extensionAttribute5",
"type": "String",
"multiValued": true,
"description": "The extensionAttributes of the user.",
"required": false,
"caseExact": false,
"mutability": "ReadWrite",
"returned": "Default",
"uniqueness": "None",
"size": 100
},
{
"name": "extensionAttribute6",
"type": "String",
"multiValued": true,
"description": "The extensionAttributes of the user.",
"required": false,
"caseExact": false,
"mutability": "ReadWrite",
"returned": "Default",
"uniqueness": "None",
"size": 100
},
{
"name": "extensionAttribute7",
"type": "String",
"multiValued": true,
"description": "The extensionAttributes of the user.",
"required": false,
"caseExact": false,
"mutability": "ReadWrite",
"returned": "Default",
"uniqueness": "None",
"size": 100
},
{
"name": "extensionAttribute8",
"type": "String",
"multiValued": true,
"description": "The extensionAttributes of the user.",
"required": false,
"caseExact": false,
"mutability": "ReadWrite",
"returned": "Default",
"uniqueness": "None",
"size": 100
},
{
"name": "extensionAttribute9",
"type": "String",
"multiValued": true,
"description": "The extensionAttributes of the user.",
"required": false,
"caseExact": false,
"mutability": "ReadWrite",
"returned": "Default",
"uniqueness": "None",
"size": 100
},
{
"name": "extensionAttribute10",
"type": "String",
"multiValued": true,
"description": "The extensionAttributes of the user.",
"required": false,
"caseExact": false,
"mutability": "ReadWrite",
"returned": "Default",
"uniqueness": "None",
"size": 100
},
{
"name": "extensionAttribute11",
"type": "String",
"multiValued": true,
"description": "The extensionAttributes of the user.",
"required": false,
"caseExact": false,
"mutability": "ReadWrite",
"returned": "Default",
"uniqueness": "None",
"size": 100
},
{
"name": "extensionAttribute12",
"type": "String",
"multiValued": true,
"description": "The extensionAttributes of the user.",
"required": false,
"caseExact": false,
"mutability": "ReadWrite",
"returned": "Default",
"uniqueness": "None",
"size": 100
},
{
"name": "extensionAttribute13",
"type": "String",
"multiValued": true,
"description": "The extensionAttributes of the user.",
"required": false,
"caseExact": false,
"mutability": "ReadWrite",
"returned": "Default",
"uniqueness": "None",
"size": 100
},
{
"name": "extensionAttribute14",
"type": "String",
"multiValued": true,
"description": "The extensionAttributes of the user.",
"required": false,
"caseExact": false,
"mutability": "ReadWrite",
"returned": "Default",
"uniqueness": "None",
"size": 100
},
{
"name": "extensionAttribute15",
"type": "String",
"multiValued": true,
"description": "The extensionAttributes of the user.",
"required": false,
"caseExact": false,
"mutability": "ReadWrite",
"returned": "Default",
"uniqueness": "None",
"size": 100
},
{
"name": "externalAttribute1",
"type": "Complex",
"multiValued": true,
"description": "The externalAttributes of the user.",
"required": false,
"caseExact": false,
"mutability": "ReadWrite",
"returned": "Default",
"uniqueness": "None",
"subAttributes": [
{
"name": "value",
"type": "String",
"multiValued": false,
"description": "The value of external attribute.",
"required": false,
"caseExact": true,
"mutability": "ReadWrite",
"returned": "Default",
"uniqueness": "None"
},
{
"name": "source",
"type": "String",
"multiValued": false,
"description": "The source of external attribute.",
"required": false,
"caseExact": true,
"mutability": "ReadWrite",
"returned": "Default",
"uniqueness": "None"
}
],
"size": 100
},
{
"name": "externalAttribute2",
"type": "Complex",
"multiValued": true,
"description": "The externalAttributes of the user.",
"required": false,
"caseExact": false,
"mutability": "ReadWrite",
"returned": "Default",
"uniqueness": "None",
"subAttributes": [
{
"name": "value",
"type": "String",
"multiValued": false,
"description": "The value of external attribute.",
"required": false,
"caseExact": true,
"mutability": "ReadWrite",
"returned": "Default",
"uniqueness": "None"
},
{
"name": "source",
"type": "String",
"multiValued": false,
"description": "The source of external attribute.",
"required": false,
"caseExact": true,
"mutability": "ReadWrite",
"returned": "Default",
"uniqueness": "None"
}
],
"size": 100
},
{
"name": "externalAttribute3",
"type": "Complex",
"multiValued": true,
"description": "The externalAttributes of the user.",
"required": false,
"caseExact": false,
"mutability": "ReadWrite",
"returned": "Default",
"uniqueness": "None",
"subAttributes": [
{
"name": "value",
"type": "String",
"multiValued": false,
"description": "The value of external attribute.",
"required": false,
"caseExact": true,
"mutability": "ReadWrite",
"returned": "Default",
"uniqueness": "None"
},
{
"name": "source",
"type": "String",
"multiValued": false,
"description": "The source of external attribute.",
"required": false,
"caseExact": true,
"mutability": "ReadWrite",
"returned": "Default",
"uniqueness": "None"
}
],
"size": 100
},
{
"name": "externalAttribute4",
"type": "Complex",
"multiValued": true,
"description": "The externalAttributes of the user.",
"required": false,
"caseExact": false,
"mutability": "ReadWrite",
"returned": "Default",
"uniqueness": "None",
"subAttributes": [
{
"name": "value",
"type": "String",
"multiValued": false,
"description": "The value of external attribute.",
"required": false,
"caseExact": true,
"mutability": "ReadWrite",
"returned": "Default",
"uniqueness": "None"
},
{
"name": "source",
"type": "String",
"multiValued": false,
"description": "The source
# --- truncated at 32 KB (102 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/webex/refs/heads/main/examples/webex-get-user-schema-example.json