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
Root Schema : schema
Type:
objectUser update request from upstream spoke system
Show Source
-
Operations(required): array
Operations
-
profile(required): string
User profile as per BuyingExample:
Subscriber
Nested Schema : Operation
Type:
Show Source
object-
operation(required): string
Allowed Values:
[ "replace", "remove", "add" ]type of update operationExample:replace -
path(required): string
path of field to be updatedExample:
scimAttributes:name -
value: object
value
value to be updated
Nested Schema : value
Type:
objectvalue to be updated
Example:
{
"familyName":"Jensen",
"givenName":"Barbara",
"middleName":"Jane",
"honorificPrefix":"Ms.",
"honorificSuffix":"III"
}Response
Supported Media Types
- application/json
- application/json;charset=utf-8
200 Response
User updated succesfully in target IDM
Root Schema : UserResponseObject
Type:
Show Source
object-
customAttributes: object
customAttributes
Additional Properties Allowed:
trueCustom attributes, extenstions to core SCIM 2 schema used in the target IAM. -
id: string
Unique identification of the user as created in the target systemExample:
User_ID1 -
profile: string
User profile as per BuyingExample:
Subscriber -
scimAttributes: object
scimAttributes
Additional Properties Allowed:
trueCore SCIM 2 attributes as per RFC7643
Nested Schema : customAttributes
Type:
objectAdditional Properties Allowed:
trueCustom 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:
objectAdditional Properties Allowed:
trueCore 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
Root Schema : Error
Type:
objectUsed 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
401 Response
Authorization failure. The authorization header is invalid or missing
Root Schema : Error
Type:
objectUsed 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
403 Response
Operation is not permitted based on the supplied authorization.
Root Schema : Error
Type:
objectUsed 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
405 Response
PATCH Operation is not supported in target IDP.
Root Schema : Error
Type:
objectUsed 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
500 Response
Internal Server Error
Root Schema : Error
Type:
objectUsed 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
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": "test@example.com",
"type": "work",
"primary": true
}
]
},
"customAttributes": {
"userKey": "123456"
}
}