PATCH /v1/scim/Users/{id}
Updates specific attributes of an existing user in the SCIM system
Servers
- https://api.au.sumologic.com/api/
- https://api.ca.sumologic.com/api/
- https://api.de.sumologic.com/api/
- https://api.eu.sumologic.com/api/
- https://api.fed.sumologic.com/api/
- https://api.jp.sumologic.com/api/
- https://api.kr.sumologic.com/api/
- https://api.in.sumologic.com/api/
- https://api.sumologic.com/api/
- https://api.us2.sumologic.com/api/
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
id |
String | Yes |
Unique identifier of the SCIM user |
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
Resources[] |
Array | No |
List of SCIM user resources |
Resources[].id |
String | Yes |
Unique SCIM identifier for the user |
Resources[].userName |
String | Yes |
Unique identifier for the user (email) |
Resources[].schemas[] |
Array | Yes |
Defines the SCIM schemas for the user |
Resources[].name |
Object | Yes | |
Resources[].name.givenName |
String | Yes |
Given name of the user (firstName) |
Resources[].name.familyName |
String | Yes |
Family name of the user (lastName) |
Resources[].active |
Boolean | No |
True if the user is active |
Resources[].roles[] |
Array | Yes |
roles should exactly match with role names within sumologic. |
Resources[].meta |
Object | No |
Resource meta data of a user |
Resources[].meta.lastModified |
String | No |
Last modification timestamp in date-time format |
Resources[].meta.created |
String | No |
Creation timestamp in date-time format |
Resources[].meta.resourceType |
String | No |
The name of the resource type of the resource |
Resources[].emails[] |
Array | Yes |
Sumo logic accepts only one email address |
Resources[].emails[].type |
String | No | |
Resources[].emails[].value |
String | No | |
Resources[].emails[].primary |
Boolean | No |
Default value: true |
totalResults |
Integer | No |
Total number of users that match the filter criteria |
startIndex |
Integer | No |
The index of the first returned result Default value: 0 |
itemsPerPage |
Integer | No |
The number of results returned in this page |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.