Webex · Example Payload
Webex Create A User Example
CallingCollaborationCommunicationEnterpriseMessagingVideo Conferencing
Webex Create A User 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": "Create a user",
"method": "POST",
"path": "/identity/scim/{orgId}/v2/Users",
"summary": "Create a user",
"requestExamples": [
{
"contentType": "application/json",
"example": {
"schemas": [
"urn:ietf:params:scim:schemas:core:2.0:User",
"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User",
"urn:scim:schemas:extension:cisco:webexidentity:2.0:User"
],
"userName": "user1@example.com",
"userType": "user",
"title": "Sales manager",
"active": true,
"preferredLanguage": "en_US",
"locale": "en_US",
"timezone": "America/Los_Angeles",
"profileUrl": "https://jojowiki.com/Jonathan_Joestar",
"externalId": "externalIdValue",
"displayName": "Mr. Jonathan Jane Joestar, III",
"nickName": "JoJo",
"name": {
"givenName": "Sarah",
"familyName": "Henderson",
"middleName": "Jane",
"honorificPrefix": "Mr.",
"honorificSuffix": "III"
},
"roles": [
{
"value": "id_full_admin",
"type": "cirole",
"display": "Full administrator"
}
],
"phoneNumbers": [
{
"value": "400 123 1234",
"type": "work",
"display": "work phone number",
"primary": true
}
],
"photos": [
{
"value": "https://photos.example.com/profilephoto/72930000000Ccne/F",
"type": "photo",
"display": "photo description",
"primary": true
}
],
"addresses": [
{
"type": "work",
"streetAddress": "100 Universal City Plaza",
"locality": "Hollywood",
"region": "CA",
"postalCode": "91608",
"country": "US"
}
],
"emails": [
{
"value": "user1@example.home.com",
"type": "home",
"display": "home email description",
"primary": false
}
],
"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User": {
"costCenter": "costCenter 123",
"organization": "Cisco webexidentity",
"division": "division 456",
"department": "department 789",
"employeeNumber": "518-8888-888",
"manager": {
"value": "b5717a4a-0169-43b2-ac3c-db20ba4e72cd"
}
},
"urn:scim:schemas:extension:cisco:webexidentity:2.0:User": {
"accountStatus": "active",
"sipAddresses": [
{
"value": "sipAddress value1",
"type": "enterprise",
"display": "sipAddress1 description",
"primary": true
}
],
"managedOrgs": [
{
"orgId": "75fe2995-24f5-4831-8d2c-1c2f8255912e",
"role": "id_full_admin"
}
],
"managedGroups": [
{
"orgId": "0ae87ade-8c8a-4952-af08-318798958d0c",
"groupId": "3936af3e-15ff-43d1-9ef5-66c569ef34f5",
"role": "location_admin"
}
],
"extensionAttribute*": [],
"externalAttribute*": [
{
"source": "Source.1_7ddf1f2c-2985-4c37-a450-d58bbc201750",
"value": "externalAttribute1_value"
}
]
}
}
}
],
"responseExamples": [
{
"status": "201",
"contentType": "application/json",
"example": {
"schemas": [
"urn:ietf:params:scim:schemas:core:2.0:User",
"urn:scim:schemas:extension:cisco:webexidentity:2.0:User",
"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User"
],
"id": "3426a8e3-d414-4bf0-a493-4f6787632a13",
"userName": "user1@example.com",
"active": true,
"roles": [
{
"value": "id_full_admin",
"type": "cirole",
"display": "Full administrator"
}
],
"name": {
"familyName": "Joestar",
"givenName": "Jonathan",
"middleName": "Jane",
"honorificPrefix": "Mr.",
"honorificSuffix": "III"
},
"displayName": "Mr. Jonathan Jane Joestar, III",
"nickName": "JoJo",
"emails": [
{
"value": "user1@example.home.com",
"type": "home",
"display": "home email description"
},
{
"value": "user1@example.com",
"type": "work",
"primary": true
}
],
"userType": "user",
"profileUrl": "https://jojowiki.com/Jonathan_Joestar",
"title": "Sales manager",
"preferredLanguage": "en_US",
"locale": "en_US",
"externalId": "externalIdValue",
"timezone": "America/Los_Angeles",
"phoneNumbers": [
{
"value": "400 123 1234",
"type": "work",
"primary": true,
"display": "work phone number"
}
],
"photos": [
{
"value": "https://photos.example.com/profilephoto/72930000000Ccne/F",
"type": "photo",
"primary": true,
"display": "photo description"
}
],
"addresses": [
{
"type": "work",
"streetAddress": "100 Universal City Plaza",
"locality": "Hollywood",
"region": "CA",
"postalCode": "91608",
"country": "US"
}
],
"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User": {
"employeeNumber": "518-8888-888",
"costCenter": "costCenter 123",
"organization": "Cisco webexidentity",
"division": "division 456",
"department": "department 789",
"manager": {
"value": "b5717a4a-0169-43b2-ac3c-db20ba4e72cd",
"displayName": "Identity Administrator",
"example": "https://integration.webexapis.com/identity/scim/0ae87ade-8c8a-4952-af08-318798958d0c/v2/Users/b5717a4a-0169-43b2-ac3c-db20ba4e72cd"
}
},
"urn:scim:schemas:extension:cisco:webexidentity:2.0:User": {
"accountStatus": [
"active"
],
"sipAddresses": [
{
"value": "sipAddress value1",
"type": "enterprise",
"primary": true,
"display": "sipAddress1 description"
}
],
"managedOrgs": [
{
"orgId": "75fe2995-24f5-4831-8d2c-1c2f8255912e",
"role": "id_full_admin"
}
],
"managedGroups": [
{
"orgId": "75fe2995-24f5-4831-8d2c-1c2f8255912e",
"groupId": "d178e396-aa06-42cd-ab98-5124eb3b1926",
"role": "id_full_admin"
}
],
"externalAttribute1": [
{
"source": "Source.1_7ddf1f2c-2985-4c37-a450-d58bbc201750",
"value": "externalAttribute1_value"
}
],
"externalAttribute2": [
{
"source": "Source.2_7ddf1f2c-2985-4c37-a450-d58bbc201750",
"value": "externalAttribute2_value"
}
],
"extensionAttribute1": [
"extensionAttribute1_Item1",
"extensionAttribute1_Item2"
],
"extensionAttribute2": [
"extensionAttribute2_Item1",
"extensionAttribute2_Item2",
"extensionAttribute2_Item3"
],
"meta": {
"organizationId": "0ae87ade-8c8a-4952-af08-318798958d0c"
}
},
"meta": {
"resourceType": "User",
"location": "http://integration.webexapis.com/identity/scim/0ae87ade-8c8a-4952-af08-318798958d0c/v2/Users/3426a8e3-d414-4bf0-a493-4f6787632a13",
"version": "W/\"76678575420\"",
"created": "2023-01-11T17:38:31.605Z",
"lastModified": "2023-01-11T17:38:31.605Z"
}
}
}
]
}