Service Provider Config Parameters
The Service Provider Configuration object schema includes the following attributes.
Attribute | Description | Type |
|---|---|---|
schemas | Array of the ids of the schemas available through the Service Provider Configuration | Array |
id | Unique identifier of the schema | String |
patch | Determines whether users are able to send patch calls | Boolean |
bulk | Bulk and return operations settings Attributes: supported - Determines whether bulk returns are available during SCIM API calls maxOperations - The maximum number of users that can be returned per bulk API calls maxPayloadSize - The character limit for bulk API call returns | Object |
filter | Bulk and return operations settings Attributes: supported - Determines whether users are able to use a filter on GET calls maxResults - The maximum number of users that can be returned per API call | Object |
changePassword | Password change settings Attributes: supported - Determines whether a patch call can be sent to update a user’s password field. | Object |
sort | Sort settings Attributes: supported - Determines whether users are able to change the order results are listed in | Object |
etag | Etag support settings Attributes: supported - Determines whether users are able to use the etag feature. | Object |
authenticationSchemas | Array of the authentication schemas that will be accepted by SCIM API calls Attributes: type - What type of authentication token the authentication uses name - The name of the authentication schema as set by IETF standard description - The description of the authentication schema as set by IETF standard specUrl - The URL link to specifications for the authentication primary - Determines whether this is the default authentication type for SCIM calls | Array of Objects |
xmlDataFormat | xml format support options Attributes: supported - Determines whether SCIM user data can be sent in an xml file | Object |
Sample Service Provider Config Object
{
"schemas": [
"urn:scim:schemas:core:1.0"
],
"id": "urn:scim:schemas:core:1.0",
"patch": {
"supported": true
},
"bulk": {
"supported": false,
"maxOperations": 10000,
"maxPayloadSize": 10000000
},
"filter": {
"supported": true,
"maxResults": 1000
},
"changePassword": {
"supported": false
},
"sort": {
"supported": true
},
"etag": {
"supported": false
},
"authenticationSchemes": [
{
"type": "oauthbearertoken",
"name": "OAuth Bearer Token",
"description": "Authentication Scheme using the OAuth Bearer Token Standard",
"specUrl": "http://tools.ietf.org/html/draft-ietf-oauth-v2-bearer-01",
"primary": true
}
],
"xmlDataFormat": {
"supported": false
}
}