1. REST API for Oracle Digital Experience for Communications Industry Fabric
  2. Tasks
  3. User Management

Replace user attribute values in the target IDM

put

/userManagement/v1/user/{id}

This operation replaces user attribute values in the target IDM.

Request

Path Parameters
Supported Media Types
Request Body - application/json ()
Root Schema : schema
Type: object
Show Source
Nested Schema : customAttributes
Type: object
Additional Properties Allowed: true
Custom attributes, extenstions to core SCIM 2 schema used in the target IAM.
Example:
{
    "subscriberName":"BJEN",
    "subscriberAccount":{
        "id":"SUB_1",
        "type":"Account"
    }
}
Nested Schema : scimAttributes
Type: object
Additional Properties Allowed: true
Core SCIM 2 attributes as per RFC7643
Example:
{
    "userName":"bjensen@example.com",
    "displayName":"Babs Jensen",
    "nickName":"Babs",
    "name":{
        "familyName":"Jensen",
        "givenName":"Barbara",
        "middleName":"Jane",
        "honorificPrefix":"Ms.",
        "honorificSuffix":"III"
    },
    "emails":[
        {
            "value":"bjensen@example.com",
            "type":"work",
            "primary":true
        },
        {
            "value":"babs@jensen.org",
            "type":"home"
        }
    ]
}
Back to Top

Response

Supported Media Types

200 Response

User updated succesfully in target IDM
Body ()
Root Schema : UserResponseObject
Type: object
Show Source
Nested Schema : customAttributes
Type: object
Additional Properties Allowed: true
Custom attributes, extenstions to core SCIM 2 schema used in the target IAM.
Example:
{
    "subscriberName":"BJEN",
    "subscriberAccount":{
        "id":"SUB_1",
        "type":"Account"
    }
}
Nested Schema : scimAttributes
Type: object
Additional Properties Allowed: true
Core SCIM 2 attributes as per RFC7643
Example:
{
    "userName":"bjensen@example.com",
    "displayName":"Babs Jensen",
    "nickName":"Babs",
    "name":{
        "familyName":"Jensen",
        "givenName":"Barbara",
        "middleName":"Jane",
        "honorificPrefix":"Ms.",
        "honorificSuffix":"III"
    },
    "emails":[
        {
            "value":"bjensen@example.com",
            "type":"work",
            "primary":true
        },
        {
            "value":"babs@jensen.org",
            "type":"home"
        }
    ]
}

400 Response

Request validation failed
Body ()
Root Schema : Error
Type: object
Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)
Show Source

401 Response

Authorization failure. The authorization header is invalid or missing
Body ()
Root Schema : Error
Type: object
Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)
Show Source

403 Response

Operation is not permitted based on the supplied authorization.
Body ()
Root Schema : Error
Type: object
Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)
Show Source

500 Response

Internal Server Error
Body ()
Root Schema : Error
Type: object
Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)
Show Source
Back to Top

Examples

The following example shows how to create or update an user by submitting a PUT request on the REST resource using cURL.

cURL Command

curl -H 'Authorization: Bearer <Token>' -X PUT https://{FABRIC_HOST}/userManagement/v1/user/{id} -H "Content-Type: application/json" -D @create_update_usermanagement.json| json_pp

Example of Request Body

The following shows an example of the request body in JSON format.

{
  "profile": "Subscriber",
  "scimAttributes": {
    "userName": "bjensen@example.com",
    "nickName": "Babs",
    "name": {
      "familyName": "Jensen",
      "givenName": "Barbara",
      "middleName": "Jane",
      "honorificPrefix": "Ms.",
      "honorificSuffix": "III"
    },
    "emails": [
      {
        "value": "bjensen@example.com",
        "type": "work",
        "primary": true
      },
      {
        "value": "babs@jensen.org",
        "type": "home"
      }
    ]
  },
  "customAttributes": {
    "userKey": "BJEN1"
  }
}

Example of Response Body

  1. The following shows an example of the response body in JSON format.

    {
   "id":"User_ID1",
   "profile":"Subscriber",
   "scimAttributes":{
      "userName":"bjensen@example.com",
      "nickName":"Babs",
      "name":{
         "familyName":"Jensen",
         "givenName":"Barbara",
         "middleName":"Jane",
         "honorificPrefix":"Ms.",
         "honorificSuffix":"III"
      },
      "emails":[
         {
            "value":"bjensen@example.com",
            "type":"work",
            "primary":true
         },
         {
            "value":"babs@jensen.org",
            "type":"home"
         }
      ]
   },
   "customAttributes":{
      "userKey": "BJEN1"
   }
}

  2. SCIM configuration not found.

    The following shows an example of the response body in JSON format.

    {
  "code": "CXI_SCIM_0002",
  "message": "SCIM configuration not found",
  "reason": "SCIM configuration not found",
  "status": "",
  "referenceError": ""
}

  3. No associated configuration for the passed user profile.

    The following shows an example of the response body in JSON format.

    {
  "code": "CXI_SCIM_0003",
  "message": "Configuration not found for user profile",
  "reason": "Configuration not found for user profile",
  "status": "",
  "referenceError": ""
}

  4. Request validation failed as a required attribute is missing in the request.

    The following shows an example of the response body in JSON format.

    {
  "code": "CXI_SCIM_0004",
  "message": "Required attribute missing in the request",
  "reason": "Required attribute missing in the request",
  "status": "",
  "referenceError": ""
}

  5. Target IAM is down or unreachable.

    The following shows an example of the response body in JSON format.

    {
  "code": "CXI_SCIM_0005",
  "message": "Target IAM system not reachable",
  "reason": "Target IAM system not reachable",
  "status": "",
  "referenceError": ""
}
Back to Top