Jump to

• Request
• Response
• Examples

Update user in the target IDM

patch

/userManagement/v1/user/{id}

This operation updates the existing user 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

User update request from upstream spoke system

Show Source

• Operations(required): array Operations
• profile(required): string
  User profile as per Buying

  Example: Subscriber

{
    "description":"User update request from upstream spoke system",
    "required":[
        "Operations",
        "profile"
    ],
    "properties":{
        "profile":{
            "type":"string",
            "description":"User profile as per Buying",
            "example":"Subscriber"
        },
        "Operations":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Operation"
            }
        }
    }
}

Nested Schema : Operations

Type: array

Show Source

• Array of: object Operation

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Operation"
    }
}

Nested Schema : Operation

Type: object

Show Source

• operation(required): string
  Allowed Values: [ "replace", "remove", "add" ]

  type of update operation

  Example: replace
• path(required): string
  path of field to be updated

  Example: scimAttributes:name
• value: object value
  value to be updated

{
    "type":"object",
    "required":[
        "operation",
        "path"
    ],
    "properties":{
        "operation":{
            "type":"string",
            "enum":[
                "replace",
                "remove",
                "add"
            ],
            "description":"type of update operation",
            "example":"replace"
        },
        "path":{
            "type":"string",
            "description":"path of field to be updated",
            "example":"scimAttributes:name"
        },
        "value":{
            "type":"object",
            "description":"value to be updated",
            "example":{
                "familyName":"Jensen",
                "givenName":"Barbara",
                "middleName":"Jane",
                "honorificPrefix":"Ms.",
                "honorificSuffix":"III"
            }
        }
    }
}

Nested Schema : value

Type: object

value to be updated

Example:

{
    "familyName":"Jensen",
    "givenName":"Barbara",
    "middleName":"Jane",
    "honorificPrefix":"Ms.",
    "honorificSuffix":"III"
}

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."
        }
    }
}

405 Response

PATCH Operation is not supported in target IDP.

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 update a workspace client by submitting a PATCH request on the REST resource using cURL.

cURL Command

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

Example of Request Body

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

{
  "profile": "subscriber",
  "Operations": [
    {
      "operation": "replace",
      "path": "scimAttributes:name",
      "value": {
        "givenName": "veerendra",
        "familyName": "patil"
      }
    },
    {
      "operation": "add",
      "path": "customAttributes:userKey",
      "value": "123456"
    },
    {
      "operation": "remove",
      "path": "customAttributes:workspace"
    }
  ]
}

Example of Response Body

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

{
  "profile": "subscriber",
  "scimAttributes": {
    "userName": "anything",
    "name": {
      "givenName": "veerendra",
      "familyName": "patil",
      "formatted": "veerendra patil"
    },
    "emails": [
      {
        "value": "[e-mail]",
        "type": "work",
        "primary": true
      }
    ]
  },
  "customAttributes": {
    "userKey": "123456"
  }
}

Back to Top