Jump to

• Request
• Response
• Examples

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

• id(required): string
  User ID provided by target IAM system maps to SCIM User resource "id" attribute

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• customAttributes: object customAttributes
  Additional Properties Allowed: true

  Custom attributes, extenstions to core SCIM 2 schema used in the target IAM.
• profile(required): string
  User profile as per Buying

  Example: Subscriber
• scimAttributes(required): object scimAttributes
  Additional Properties Allowed: true

  Core SCIM 2 attributes as per RFC7643

{
    "type":"object",
    "required":[
        "profile",
        "scimAttributes"
    ],
    "properties":{
        "profile":{
            "type":"string",
            "description":"User profile as per Buying",
            "example":"Subscriber"
        },
        "scimAttributes":{
            "type":"object",
            "additionalProperties":true,
            "description":"Core SCIM 2 attributes as per RFC7643",
            "example":{
                "userName":"[e-mail]",
                "displayName":"Babs Jensen",
                "nickName":"Babs",
                "name":{
                    "familyName":"Jensen",
                    "givenName":"Barbara",
                    "middleName":"Jane",
                    "honorificPrefix":"Ms.",
                    "honorificSuffix":"III"
                },
                "emails":[
                    {
                        "value":"[e-mail]",
                        "type":"work",
                        "primary":true
                    },
                    {
                        "value":"[e-mail]",
                        "type":"home"
                    }
                ]
            }
        },
        "customAttributes":{
            "type":"object",
            "description":"Custom attributes, extenstions to core SCIM 2 schema used in the target IAM.",
            "additionalProperties":true,
            "example":{
                "subscriberName":"BJEN",
                "subscriberAccount":{
                    "id":"SUB_1",
                    "type":"Account"
                }
            }
        }
    }
}

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":"[e-mail]",
    "displayName":"Babs Jensen",
    "nickName":"Babs",
    "name":{
        "familyName":"Jensen",
        "givenName":"Barbara",
        "middleName":"Jane",
        "honorificPrefix":"Ms.",
        "honorificSuffix":"III"
    },
    "emails":[
        {
            "value":"[e-mail]",
            "type":"work",
            "primary":true
        },
        {
            "value":"[e-mail]",
            "type":"home"
        }
    ]
}

Back to Top

Response

Supported Media Types

• application/json
• application/json;charset=utf-8

200 Response

User updated succesfully in target IDM

Body ()

Root Schema : UserResponseObject

Type: object

Show Source

• customAttributes: object customAttributes
  Additional Properties Allowed: true

  Custom attributes, extenstions to core SCIM 2 schema used in the target IAM.
• id: string
  Unique identification of the user as created in the target system

  Example: User_ID1
• profile: string
  User profile as per Buying

  Example: Subscriber
• scimAttributes: object scimAttributes
  Additional Properties Allowed: true

  Core SCIM 2 attributes as per RFC7643

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Unique identification of the user as created in the target system",
            "example":"User_ID1"
        },
        "profile":{
            "type":"string",
            "description":"User profile as per Buying",
            "example":"Subscriber"
        },
        "scimAttributes":{
            "type":"object",
            "additionalProperties":true,
            "description":"Core SCIM 2 attributes as per RFC7643",
            "example":{
                "userName":"[e-mail]",
                "displayName":"Babs Jensen",
                "nickName":"Babs",
                "name":{
                    "familyName":"Jensen",
                    "givenName":"Barbara",
                    "middleName":"Jane",
                    "honorificPrefix":"Ms.",
                    "honorificSuffix":"III"
                },
                "emails":[
                    {
                        "value":"[e-mail]",
                        "type":"work",
                        "primary":true
                    },
                    {
                        "value":"[e-mail]",
                        "type":"home"
                    }
                ]
            }
        },
        "customAttributes":{
            "type":"object",
            "description":"Custom attributes, extenstions to core SCIM 2 schema used in the target IAM.",
            "additionalProperties":true,
            "example":{
                "subscriberName":"BJEN",
                "subscriberAccount":{
                    "id":"SUB_1",
                    "type":"Account"
                }
            }
        }
    }
}

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":"[e-mail]",
    "displayName":"Babs Jensen",
    "nickName":"Babs",
    "name":{
        "familyName":"Jensen",
        "givenName":"Barbara",
        "middleName":"Jane",
        "honorificPrefix":"Ms.",
        "honorificSuffix":"III"
    },
    "emails":[
        {
            "value":"[e-mail]",
            "type":"work",
            "primary":true
        },
        {
            "value":"[e-mail]",
            "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

• @baseType: string
  When sub-classing, this defines the super-class.
• @schemaLocation: string (uri)
  A URI to a JSON-Schema file that defines additional attributes and relationships
• @type: string
  When sub-classing, this defines the sub-class entity name.
• code(required): string
  Application relevant detail, defined in the API or a common list.
• message: string
  More details and corrective actions related to the error which can be shown to a client user.
• reason(required): string
  Explanation of the reason for the error which can be shown to a client user.
• referenceError: string (uri)
  URI of documentation describing the error.
• status: string
  HTTP Error code extension

{
    "required":[
        "code",
        "reason"
    ],
    "type":"object",
    "description":"Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)",
    "properties":{
        "code":{
            "type":"string",
            "description":"Application relevant detail, defined in the API or a common list."
        },
        "reason":{
            "type":"string",
            "description":"Explanation of the reason for the error which can be shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"More details and corrective actions related to the error which can be shown to a client user."
        },
        "status":{
            "type":"string",
            "description":"HTTP Error code extension"
        },
        "referenceError":{
            "type":"string",
            "description":"URI of documentation describing the error.",
            "format":"uri"
        },
        "@baseType":{
            "type":"string",
            "description":"When sub-classing, this defines the super-class."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"A URI to a JSON-Schema file that defines additional attributes and relationships",
            "format":"uri"
        },
        "@type":{
            "type":"string",
            "description":"When sub-classing, this defines the sub-class entity name."
        }
    }
}

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

• @baseType: string
  When sub-classing, this defines the super-class.
• @schemaLocation: string (uri)
  A URI to a JSON-Schema file that defines additional attributes and relationships
• @type: string
  When sub-classing, this defines the sub-class entity name.
• code(required): string
  Application relevant detail, defined in the API or a common list.
• message: string
  More details and corrective actions related to the error which can be shown to a client user.
• reason(required): string
  Explanation of the reason for the error which can be shown to a client user.
• referenceError: string (uri)
  URI of documentation describing the error.
• status: string
  HTTP Error code extension

{
    "required":[
        "code",
        "reason"
    ],
    "type":"object",
    "description":"Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)",
    "properties":{
        "code":{
            "type":"string",
            "description":"Application relevant detail, defined in the API or a common list."
        },
        "reason":{
            "type":"string",
            "description":"Explanation of the reason for the error which can be shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"More details and corrective actions related to the error which can be shown to a client user."
        },
        "status":{
            "type":"string",
            "description":"HTTP Error code extension"
        },
        "referenceError":{
            "type":"string",
            "description":"URI of documentation describing the error.",
            "format":"uri"
        },
        "@baseType":{
            "type":"string",
            "description":"When sub-classing, this defines the super-class."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"A URI to a JSON-Schema file that defines additional attributes and relationships",
            "format":"uri"
        },
        "@type":{
            "type":"string",
            "description":"When sub-classing, this defines the sub-class entity name."
        }
    }
}

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

• @baseType: string
  When sub-classing, this defines the super-class.
• @schemaLocation: string (uri)
  A URI to a JSON-Schema file that defines additional attributes and relationships
• @type: string
  When sub-classing, this defines the sub-class entity name.
• code(required): string
  Application relevant detail, defined in the API or a common list.
• message: string
  More details and corrective actions related to the error which can be shown to a client user.
• reason(required): string
  Explanation of the reason for the error which can be shown to a client user.
• referenceError: string (uri)
  URI of documentation describing the error.
• status: string
  HTTP Error code extension

{
    "required":[
        "code",
        "reason"
    ],
    "type":"object",
    "description":"Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)",
    "properties":{
        "code":{
            "type":"string",
            "description":"Application relevant detail, defined in the API or a common list."
        },
        "reason":{
            "type":"string",
            "description":"Explanation of the reason for the error which can be shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"More details and corrective actions related to the error which can be shown to a client user."
        },
        "status":{
            "type":"string",
            "description":"HTTP Error code extension"
        },
        "referenceError":{
            "type":"string",
            "description":"URI of documentation describing the error.",
            "format":"uri"
        },
        "@baseType":{
            "type":"string",
            "description":"When sub-classing, this defines the super-class."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"A URI to a JSON-Schema file that defines additional attributes and relationships",
            "format":"uri"
        },
        "@type":{
            "type":"string",
            "description":"When sub-classing, this defines the sub-class entity name."
        }
    }
}

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

• @baseType: string
  When sub-classing, this defines the super-class.
• @schemaLocation: string (uri)
  A URI to a JSON-Schema file that defines additional attributes and relationships
• @type: string
  When sub-classing, this defines the sub-class entity name.
• code(required): string
  Application relevant detail, defined in the API or a common list.
• message: string
  More details and corrective actions related to the error which can be shown to a client user.
• reason(required): string
  Explanation of the reason for the error which can be shown to a client user.
• referenceError: string (uri)
  URI of documentation describing the error.
• status: string
  HTTP Error code extension

{
    "required":[
        "code",
        "reason"
    ],
    "type":"object",
    "description":"Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)",
    "properties":{
        "code":{
            "type":"string",
            "description":"Application relevant detail, defined in the API or a common list."
        },
        "reason":{
            "type":"string",
            "description":"Explanation of the reason for the error which can be shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"More details and corrective actions related to the error which can be shown to a client user."
        },
        "status":{
            "type":"string",
            "description":"HTTP Error code extension"
        },
        "referenceError":{
            "type":"string",
            "description":"URI of documentation describing the error.",
            "format":"uri"
        },
        "@baseType":{
            "type":"string",
            "description":"When sub-classing, this defines the super-class."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"A URI to a JSON-Schema file that defines additional attributes and relationships",
            "format":"uri"
        },
        "@type":{
            "type":"string",
            "description":"When sub-classing, this defines the sub-class entity name."
        }
    }
}

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": "[e-mail]",
    "nickName": "Babs",
    "name": {
      "familyName": "Jensen",
      "givenName": "Barbara",
      "middleName": "Jane",
      "honorificPrefix": "Ms.",
      "honorificSuffix": "III"
    },
    "emails": [
      {
        "value": "[e-mail]",
        "type": "work",
        "primary": true
      },
      {
        "value": "[e-mail]",
        "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":"[e-mail]",
         "nickName":"Babs",
         "name":{
            "familyName":"Jensen",
            "givenName":"Barbara",
            "middleName":"Jane",
            "honorificPrefix":"Ms.",
            "honorificSuffix":"III"
         },
         "emails":[
            {
               "value":"[e-mail]",
               "type":"work",
               "primary":true
            },
            {
               "value":"[e-mail]",
               "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