1. REST API Services for Oracle CPQ
  2. Tasks
  3. User Management
  4. SCIM Compliant

Add, Update or Remove User Information

patch

/rest/v16/scim/users/{id}

This endpoint performs an operation to add user information, update existing user information or remove existing user information for a specified user. The endpoint supports a single operation request or multiple operation requests performed sequentially.

Request

Supported Media Types
Path Parameters
Body ()
Root Schema : Patch request model
Type: object
Title: Patch request model
Request to update a user with minimal user payload
Show Source
Nested Schema : Operations
Type: array
Title: Operations
update patch operation
Show Source
Nested Schema : Collab queue operation properties
Type: object
Title: Collab queue operation properties
Show Source
  • Title: Description
    Description of the operation. This is only intended for human consumption and its format may change at any time.
  • Title: Submission time
    Approximate time when the operation was submitted, in ISO8601 format. This is NOT used to determine the ordering of operations within the queue.
  • Title: Submitter company name
    Company name of the user who submitted the operation.
  • Title: Submitter login name
    Login name of the user who submitted the operation.
  • Title: Operation uuid
    Unique identifier of the operation.
Back to Top

Response

Supported Media Types

Default Response

Response of the updated user.
Body ()
Root Schema : user-response
Type: object
Show Source
Nested Schema : Email
Type: array
Title: Email
Email of the User
Show Source
Nested Schema : enterpriseUser
Type: object
Show Source
Nested Schema : extensionUser
Type: object
Show Source
Nested Schema : metaData
Type: object
Show Source
Nested Schema : Name
Type: object
Title: Name
Full name of the user
Show Source
Nested Schema : Phone Numbers
Type: array
Title: Phone Numbers
Phone numbers of the User
Show Source
Nested Schema : Schemas
Type: array
Title: Schemas
Schemas used in the response
Show Source
Nested Schema : email
Type: object
Show Source
Nested Schema : addresses
Type: array
Show Source
Nested Schema : address
Type: object
Show Source
Nested Schema : Shipping/Billing Full name
Type: object
Title: Shipping/Billing Full name
Shipping/Billing Full name
Show Source
Nested Schema : phoneNumber
Type: object
Show Source
Back to Top

Examples

The following example shows how to add user information, update existing user information, or remove existing user information by submitting a PATCH request to the REST resource using cURL. For more information about cURL, see Use cURL. 

curl -X POST -i -H "Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQg" -H "Accept: application/json"
https://sitename.oracle.com/rest/v16/scim/users/559a595d-fa7b-43b1-853b-f4ff30b779de

Request Body Sample

{
  "schemas": ["urn:ietf:params:scim:api:messages:2.0:PatchOp"],
  "operations": [{
      "op": "replace",
      "value": {
        "active": true
      }
    }, {
      "op": "remove",
      "path": "phoneNumbers"
    }, {
      "op": "add",
      "path": "name",
      "value": {
        "familyName": "jones",
        "givenName": "lisa"
      }
    }, {
      "op": "replace",
      "path": "urn:ietf:params:scim:schemas:extension:oracle:2.0:CPQ:User",
      "value": {
        "userType": "FULLACCESS1",
        "addresses": [{
            "country": "UK",
            "name": {
              "familyName": "jones",
              "givenName": "lisa"
            }
          }
        ]
      }
    }, {
      "op": "remove",
      "path": "urn:ietf:params:scim:schemas:extension:oracle:2.0:CPQ:User.addresses.name.givenName"
    }, {
      "op": "add",
      "path": "urn:ietf:params:scim:schemas:extension:oracle:2.0:CPQ:User.addresses[type eq \"SHIP_TO\" and country eq \"UK\" ]",
      "value": [{
          "country": "JPN",
          "name": {
            "familyName": "jones",
            "givenName": "lisa"
          }
        }
      ]
    }
  ]
}

Response Body Sample

{   "schemas": [
        "urn:ietf:params:scim:schemas:extension:oracle:2.0:CPQ:User",
        "urn:ietf:params:scim:schemas:core:2.0:User",
        "urn:ietf:params:scim:schemas:extension:enterprise:2.0:User"
    ],
    "id": "559a595d-fa7b-43b1-853b-f4ff30b779de",
    "meta": {
        "resourceType": "User",
        "created": "2023-01-12T00:49:54.000Z",
        "lastModified": "2023-01-12T00:49:55.000Z",
        "version": "v15",
        "location": "http://sitename.oracle.com/rest/v16/scim/users/559a595d-fa7b-43b1-853b-f4ff30b779de"
    },
    "userName": "lisaJones",
    "emails": [
        {
            "value": "lisa.jones@companyemail.com",
            "type": "WORK",
            "primary": true
        }
    ],
    "active": true,
    "preferredLanguage": "en_US",
    "name": {
        "familyName": "jones",
        "givenName": "lisa"
    },
    "title": "FullAccess User",
    "timezone": "America/New_York",
    "urn:ietf:params:scim:schemas:extension:oracle:2.0:CPQ:User": {
        "userType": "FULL_ACCESS",
        "currency": "EUR",
        "dateFormat": 3,
        "numberFormat": 0,
        "units": 1,
        "enabledForSso": "SSO_ENABLED",
        "separateShipaddr": false,
        "addresses": [
            {
                "type": "BILL_TO",
                "name": {
                    "familyName": "jones",
                    "givenName": "lisa"
                },
                "address1": "2 waters park dr",
                "address2": "Po2 suite 240-2",
                "locality": "SanMateo",
                "companyName": "PO2",
                "region": "California",
                "postalCode": "94403",
                "country": "UK",
                "phone": "650-403-6322",
                "fax": "650-403-6322",
                "email": "lisa.jones@companyemail.com"
            },
            {
                "type": "SHIP_TO",
                                "name": {
                          "familyName": "jones",
                          "givenName": "lisa"
                },
                "address1": "2 waters park dr",
                "address2": "Po2 suite 240-2",
                "locality": "SanMateo",
                "companyName": "po2",
                "region": "California",
                "postalCode": "94403",
                "country": "JPN",
                "phone": "650-403-6322",
                "fax": "650-403-6322",
                "email": "lisa.jones@companyemail.com"
            }
        ],
        "isNotifyEmail": false,
        "isSuperUserPermEnabled": false,
        "isAccessAdminPermEnabled": false,
        "isProxyPermEnabled": false,
        "isNotifyFax": false,
        "isWebServicesOnly": false
    },
    "urn:ietf:params:scim:schemas:extension:enterprise:2.0:User": {
        "organization": "phoenix60388"
    }
}
Back to Top