Updates an existing User.
PUT {{baseUrl}}/Users/:userId?attributes=<string>&excludedAttributes=<string>&lookupByName=<boolean>
The endpoint used to update a User resource. Attributes to include in the response can be specified with the 'attributes' query parameter. Attributes to exclude from the response can be specified with the 'excludedAttributes' query parameter. The core schema is urn:ietf:params:scim:schemas:core:2.0:User. There are fields marked as 'returned only by request' that are a part of the secondary schema urn:ietf:params:scim:schemas:sailpoint:1.0:User. In order to see any of those fields returned, you must provide those attributes in the 'attributes' query parameter.
In order for Lifecycle Events to have access to previous Identity values, a new IdentityArchive object is created and saved to the database. This feature is turned on by default and could have an impact on the overall performance of the SCIM update. It is not expected for the impact of this change to be noticeable, but in cases where it is, and when configured Lifecycle Events are not dependent on the previous Identity attributes, the creation of the IdentityArchive object during a SCIM update is configurable. By default, the IdentityArchive creation during a SCIM update is enabled. To disable the creation of the IdentityArchive object during SCIM updates, the following attribute can be set on the SystemConfiguration object:
<entry key=scimTriggerSnapshots
value=false
>
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
attributes | string | The User attributes to include in the response. The query parameter value is a comma-separated list of fields to be returned in the response for each User.<br/><br/>Example: attributes=name,userName<br/><br/> The attributes provided will be the only ones returned in the response, with the exception of id, schemas, and meta, which are always returned for a User. | |
excludedAttributes | string | The User attributes to exclude from the response. The query parameter value is a comma-separated list of fields to be excluded from the response for each User.<br/><br/>Example: excludedAttributes=name,userName<br/><br/> The attributes provided will be the only ones excluded from the response, with the exception of id, schemas, and meta, which are always returned for a User. | |
lookupByName | string | A boolean value that determines if the User resource will be looked up by userName instead of userId (value in path parameter 'userId'). Setting this query parameter to true will cause the value pulled from the 'userId' path parameter to be treated as a userName when searching for the resource.<br/><br/>Example: scim/v2/Users/Mock.User?lookupByName=true |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Content-Type | string | ||
Accept | string |
RESPONSES
status: OK
{"id":"c0b4568a4fe7458c434ee77d1fbt156b","userName":"Mock.User","name":{"formatted":"Ms. Barbara J Jensen, III","familyName":"Jensen","givenName":"Barbara"},"displayName":"Barbara Jensen","userType":"employee","active":true,"emails":[{"type":"work","value":"Barbara.Jensen@example.com","primary":true},{"type":"work","value":"Barbara.Jensen@example.com","primary":true}],"urn:ietf:params:scim:schemas:sailpoint:1.0:User":{"accounts":[{"displayName":"Bob.Smith","value":"c0a7778b7ef71e79817ee74e6a1f0444","$ref":"http://localhost:8080/iiq/scim/v2/Accounts/c0a7778b7ef71e79817ee74e6a1f0444"},{"displayName":"Bob.Smith","value":"c0a7778b7ef71e79817ee74e6a1f0444","$ref":"http://localhost:8080/iiq/scim/v2/Accounts/c0a7778b7ef71e79817ee74e6a1f0444"}],"entitlements":[{"value":"groupmbr","display":"HelpDesk","type":"Permission","application":"ADMockApp","accountName":"CN=Barbara Jensen,OU=Taipei,OU=Asia-Pacific,DC=example,DC=com","$ref":"http://localhost:8080/iiq/scim/v2/Entitlements/c0a7777a7f74744d817e74fc12362c67"},{"value":"groupmbr","display":"HelpDesk","type":"Permission","application":"ADMockApp","accountName":"CN=Barbara Jensen,OU=Taipei,OU=Asia-Pacific,DC=example,DC=com","$ref":"http://localhost:8080/iiq/scim/v2/Entitlements/c0a7777a7f74744d817e74fc12362c67"}],"roles":[{"value":"detectedRoles","display":"User - IT","type":"it","acquired":"Assigned","application":"Active_Directory","accountName":"CN=Barbara Jensen,OU=Taipei,OU=Asia-Pacific,DC=example,DC=com","$ref":"http://localhost:8080/iiq/scim/v2/Roles/c0a7777a7f74744d817e74fc12362c67"},{"value":"detectedRoles","display":"User - IT","type":"it","acquired":"Assigned","application":"Active_Directory","accountName":"CN=Barbara Jensen,OU=Taipei,OU=Asia-Pacific,DC=example,DC=com","$ref":"http://localhost:8080/iiq/scim/v2/Roles/c0a7777a7f74744d817e74fc12362c67"}],"capabilities":["Lorem dolor","aliquip in in"],"riskScore":125,"isManager":false,"administrator":{"displayName":"Bob Smith","value":"c0a7777a7f74744d817e74fc12362c67O","$ref":"http://localhost:8080/iiq/scim/v2/Users/c0a7777a7f74744d817e74fc12362c67"},"softwareVersion":"7.3","empId":"1b2a3c","dn":"cn=Bob Smith,ou=services","region":"Americas","regionOwner":{"displayName":"Joe Smith","value":"c0b4568a4fe7458c434ee77d1fbt156b","$ref":"http://localhost:8080/iiq/scim/v2/Users/c0b4568a4fe7458c434ee77d1fbt156b"},"location":"Singapore","locationOwner":{"displayName":"Bob Smith","value":"c0a7778b7ef71e79817ee74e6a1f0444","$ref":"http://localhost:8080/iiq/scim/v2/Users/c0a7778b7ef71e79817ee74e6a1f0444"},"Department":"Regional Operations","costcenter":["CC01","DD02"],"jobtitle":"Internal Audit Manager","lastRefresh":"2011-06-25T20:38:45.076Z"},"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User":{"manager":{"displayName":"Bob Smith","value":"c7a7347a7fe71e69077ee75f5d1f1237","$ref":"http://localhost:8080/iiq/scim/v2/Users/c7a7347a7fe71e69077ee75f5d1f1237"}},"meta":{"created":"2022-02-11T01:34:04.074-05:00","location":"http://localhost:8080/iiq/scim/v2/Users/c0b4568a4fe7458c434ee77d1fbt156b","lastModified":"2022-02-11T01:08:45.866-05:00","version":"W/\"1644561244074\"","resourceType":"User"},"schemas":["urn:ietf:params:scim:schemas:sailpoint:1.0:User","urn:ietf:params:scim:schemas:core:2.0:User","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User"]}