Defines the schema for the Service Provider Configuration Object
API Endpoint | https://api.bigpanda.io/resources/v2.0/scim/ServiceProviderConfigs |
---|---|
Supported Methods | POST , GET , PATCH , DELETE |
Parameters
The Service Provider Configuration object schema includes the following attributes.
Attribute | Description | Type | Example |
---|---|---|---|
schemas | Array of the ids of the schemas available through the Service Provider Configuration | Array | "schemas": [ "urn:scim:schemas:core:1.0" ] |
id | Unique identifier of the schema | String | "id": "urn:scim:schemas:core:1.0" |
patch | Determines whether users are able to send patch calls | Boolean | "patch": { "supported": true} |
bulk | Bulk and return operations settings Attributes: supported - Determines whether bulk returns are available during SCIM API callsmaxOperations - The maximum number of users that can be returned per bulk API callsmaxPayloadSize - The character limit for bulk API call returns | Object | "bulk": { "supported": false, "maxOperations": 10000, "maxPayloadSize": 10000000 }" |
filter | Bulk and return operations settings Attributes: supported - Determines whether users are able to use a filter on GET callsmaxResults - The maximum number of users that can be returned per API call | Object | "filter": { "supported": true, "maxResults": 1000 } |
changePassword | Password change settings Attributes: supported - Determines whether a patch call can be sent to update a user’s password field. | Object | "changePassword": { "supported": false } |
sort | Sort settings Attributes: supported - Determines whether users are able to change the order results are listed in | Object | "sort": { "supported": true } |
etag | Etag support settings Attributes: supported - Determines whether users are able to use the etag feature. | Object | "etag": { "supported": false |
authenticationSchemas | Array of the authentication schemas that will be accepted by SCIM API calls Attributes: type - What type of authentication token the authentication usesname - The name of the authentication schema as set by IETF standarddescription - The description of the authentication schema as set by IETF standardspecUrl - The URL link to specifications for the authenticationprimary - Determines whether this is the default authentication type for SCIM calls | Array of Objects | "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 | xml format support options Attributes: supported - Determines whether SCIM user data can be sent in an xml file | Object | "xmlDataFormat": { "supported": false } |