The Update SCIM operation updates existing users based on the values provided. PUT can be used to update all user attributes whilst PATCH can be used to update partial user attributes.

Examples:

  1. Request to update a user by Condeco ID
  2. Update with PATCH [Single-valued properties]

Update example 1

Request to update a user by Condeco ID

Request

PUT "https://<CONDECO-SCIM-Domain>/scim/api/V1/users/162"
{
  "schemas": [
    "urn:ietf:params:scim:schemas:core:2.0:User"
  ],
  "externalId": "JohnSmith123",
  "userName": "John.Smith",
  "active": true,
  "name": {
    "familyName": "Smith",
    "givenName": "John"
  },
  "emails": [
    {
      "primary": true,
      "value": "John.Smith@sampledomain.com"
    }
  ],
  "phoneNumbers": []
}

Response

HTTP/1.1 200 OK

{
  "schemas": [
    "urn:ietf:params:scim:schemas:core:2.0:User"
  ],
  "id": "162",
  "externalId": "JohnSmith123",
  "meta": {
        "resourceType": "User",
        "created": "2020-11-02T14:12:04.827",
        "location": "https://<CONDECO-SCIM-Domain>/scim/api/V1/users/162"
  },
  "userName": "John.Smith",
  "active": true,
  "name": {
    "familyName": "Smith",
    "givenName": "John"
  },
  "emails": [
    {
      "primary": true,
      "value": "John.Smith@sampledomain.com"
    }
  ],
  "phoneNumbers": []
}

Update example 2

Update with PATCH [Single-valued properties]

Request

PATCH "https://<CONDECO-SCIM-Domain>/scim/api/V1/users/162"
{
	"schemas": ["urn:ietf:params:scim:api:messages:2.0:PatchOp"],
	"Operations": [
            {
    		"op": "Replace",
    		"path": "phoneNumbers[primary eq true].value",
    		"value": "John.Smith@sampledomain.com"
    	    },
    	    {
    		"op": "Replace",
    		"path": "name.familyName",
    		"value": "Doe"
    	    }
	]
}

Response

HTTP/1.1 204 No Content

Feedback

Was this helpful?

Yes No
You indicated this topic was not helpful to you ...
Could you please leave a comment telling us why? Thank you!
Thanks for your feedback.

Post your comment on this topic.

Please do not use this for support questions.
Condeco Support

Post Comment