Webex · Example Payload

Webex Update A User With Patch Example

CallingCollaborationCommunicationEnterpriseMessagingVideo Conferencing

Webex Update A User With Patch 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": "Update a user with PATCH",
  "method": "PATCH",
  "path": "/identity/scim/{orgId}/v2/Users/{userId}",
  "summary": "Update a user with PATCH",
  "requestExamples": [
    {
      "contentType": "application/json",
      "example": {
        "schemas": [
          "urn:ietf:params:scim:api:messages:2.0:PatchOp"
        ],
        "Operations": [
          {
            "op": "add",
            "path": "roles",
            "value": [
              {
                "value": "id_user_admin",
                "type": "cirole",
                "display": "Full Administrator."
              }
            ]
          }
        ]
      }
    }
  ],
  "responseExamples": [
    {
      "status": "200",
      "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": "user1Changed@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": "new displayName value",
        "nickName": "JoJo",
        "emails": [
          {
            "value": "user1@example.home.com",
            "type": "home",
            "display": "home email description"
          },
          {
            "value": "user1Changed@example.com",
            "type": "work",
            "primary": true
          }
        ],
        "userType": "user",
        "profileUrl": "https://jojowiki.com/Jonathan_Joestar",
        "title": "Sales manager",
        "preferredLanguage": "en_US",
        "locale": "en_US",
        "externalId": "externalIdNewValue",
        "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/\"88678579986\"",
          "created": "2023-01-11T17:38:31.605Z",
          "lastModified": "2023-02-02T11:38:31.009Z"
        }
      }
    }
  ]
}