Help Center/ IAM Identity Center/ API Reference/ API/ SCIM Metadata Management/ Querying the SP Configuration

Updated on 2025-11-27 GMT+08:00

Querying the SP Configuration

Function

This API is used to query the SCIM configuration in IAM Identity Center.

URI

GET /{tenant_id}/scim/v2/ServiceProviderConfig

**Table 1** Path parameters
Parameter	Mandatory	Type	Description
tenant_id	Yes	String	Globally unique ID of a tenant

Request Parameters

**Table 2** Parameters in the request header
Parameter	Mandatory	Type	Description
Authorization	Yes	String	Bearer token

Response Parameters

Status code: 200

**Table 3** Parameters in the response body
Parameter	Type	Description
schemas	Array of strings	Summary
documentationUri	String	Help documentation URL
authenticationSchemes	Array of objects	List of authentication schemes
patch	Object	Whether an SP supports partial modifications and related configurations
bulk	Object	Whether an SP supports batch operations and related configurations
filter	Object	Whether an SP supports filtering and related configurations
changePassword	Object	Whether an SP supports the password change and related configurations
sort	Object	Whether an SP supports sorting and related configurations
etag	Object	Whether an SP supports electronic tags and related configurations

**Table 4** authenticationSchemes
Parameter	Type	Description
type	String	Authentication type
name	String	Name of an authentication scheme
description	String	Description of an authentication scheme
specUri	String	Specification URL
documentationUri	String	Help documentation URL
primary	Boolean	Whether the value is the primary authentication method

**Table 5** patch
Parameter	Type	Description
supported	Boolean	Whether an SP supports the operation

**Table 6** bulk
Parameter	Type	Description
supported	Boolean	Whether an SP supports the operation
maxOperations	Integer	Maximum number of operations that can be performed at a time
maxPayloadSize	Integer	Maximum valid payload

**Table 7** filter
Parameter	Type	Description
supported	Boolean	Whether an SP supports the operation
maxResults	Integer	Maximum number of results

**Table 8** changePassword
Parameter	Type	Description
supported	Boolean	Whether an SP supports the operation

**Table 9** sort
Parameter	Type	Description
supported	Boolean	Whether an SP supports the operation

**Table 10** etag
Parameter	Type	Description
supported	Boolean	Whether an SP supports the operation

Status code: 400

**Table 11** Parameters in the response body
Parameter	Type	Description
schema	String	Summary
schemas	Array of strings	Summary list
detail	String	Exception details
status	Integer	Status code
timeStamp	String	Timestamp

Status code: 403

**Table 12** Parameters in the response body
Parameter	Type	Description
schema	String	Summary
schemas	Array of strings	Summary list
detail	String	Exception details
status	Integer	Status code
timeStamp	String	Timestamp

Status code: 404

**Table 13** Parameters in the response body
Parameter	Type	Description
schema	String	Summary
schemas	Array of strings	Summary list
detail	String	Exception details
status	Integer	Status code
timeStamp	String	Timestamp

Status code: 409

**Table 14** Parameters in the response body
Parameter	Type	Description
schema	String	Summary
schemas	Array of strings	Summary list
detail	String	Exception details
status	Integer	Status code
timeStamp	String	Timestamp

Status code: 500

**Table 15** Parameters in the response body
Parameter	Type	Description
schema	String	Summary
schemas	Array of strings	Summary list
detail	String	Exception details
status	Integer	Status code
timeStamp	String	Timestamp

Example Request

Querying the SCIM configuration in IAM Identity Center

GET https://{hostname}/{tenant_id}/scim/v2/ServiceProviderConfig

Example Response

Status code: 200

Successful

{
  "schemas" : [ "urn:ietf:params:scim:schemas:core:2.0:ServiceProviderConfig" ],
  "documentationUri" : null,
  "authenticationSchemes" : [ {
    "type" : "authenticationtype",
    "name" : "Authentication Name",
    "description" : "Authentication scheme using the AAA Authentication Standard",
    "specUri" : "http://www.example.org/doc/auth1234",
    "documentationUri" : null,
    "primary" : true
  } ],
  "patch" : {
    "supported" : false
  },
  "bulk" : {
    "supported" : false,
    "maxOperations" : null,
    "maxPayloadSize" : null
  },
  "filter" : {
    "supported" : false,
    "maxResults" : null
  },
  "changePassword" : {
    "supported" : false
  },
  "sort" : {
    "supported" : false
  },
  "etag" : {
    "supported" : false
  }
}

Status Codes

For details, see Status Codes.

Error Codes

For details, see Error Codes.

Parent topic: SCIM Metadata Management

Previous topic: SCIM Metadata Management

Next topic: Service Provider (SP) Management