Returns all ServiceProviderConfig resources.

GET 
/ServiceProviderConfig

This endpoint returns all ServiceProviderConfig resources.

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 schema related to ServiceProviderConfig is:

• urn:ietf:params:scim:schemas:sailpoint:2.0:ServiceProviderConfig

Responses

200

Returned all SCIM resources for this endpoint.

application/json

Schema

Schema

totalResults integer

Number of resources returned for this endpoint.

startIndex integer

The starting index of the resource set list. Can be specified with startIndex query parameter.

schemas string[]

SCIM Schema used for response.

Resources

undefined[]

Array [

documentationUri string

An HTTP addressable URL pointing to the service provider's human consumable help documentation.

patch

object

required

A complex type that specifies PATCH configuration options.

supported booleanrequired

Boolean value specifying whether the operation is supported.

etag

object

required

A complex type that specifies ETAG configuration options.

supported booleanrequired

Boolean value specifying whether the operation is supported.

bulk

object

required

A complex type that specifies ETAG configuration options.

supported booleanrequired

Boolean value specifying whether the operation is supported.

maxOperations integerrequired

An integer value specifying the maximum number of operations.

maxPayloadSize integerrequired

An integer value specifying the maximum payload size in bytes.

filter

object

required

A complex type that specifies FILTER options.

supported booleanrequired

Boolean value specifying whether the operation is supported.

maxResults integerrequired

Integer value specifying the maximum number of resources returned in a response.

changePassword

object

required

A complex type that specifies change password options.

supported booleanrequired

Boolean value specifying whether the operation is supported.

sort

object

required

A complex type that specifies sort result options.

supported booleanrequired

Boolean value specifying whether the operation is supported.

authenticationSchemes

object

required

A complex type that specifies supported Authentication Scheme properties.

name stringrequired

The common authentication scheme name; e.g., HTTP Basic.

description stringrequired

A description of the authentication scheme.

specUri string

An HTTP addressable URL pointing to the Authentication Scheme's specification.

documentationUri string

An HTTP addressable URL pointing to the Authentication Scheme's usage documentation.

type stringrequired

Possible values: [oauth, oauth2, oauthbearertoken, httpbasic, httpdigest]

The authentication scheme.

meta

object

location string

URL to ServiceProviderConfig resource.

resourceType string

Resource type of the metadata subject.

]

Example (from schema)

{
  "totalResults": "1,",
  "startIndex": 1,
  "schemas": [
    "urn:ietf:params:scim:api:messages:2.0:ListResponse"
  ],
  "Resources": [
    {
      "documentationUri": "https://community.sailpoint.com/community/identityiq/product-downloads",
      "patch": {
        "supported": false
      },
      "etag": {
        "supported": true
      },
      "bulk": {
        "supported": false,
        "maxOperations": 3,
        "maxPayloadSize": 128
      },
      "filter": {
        "supported": true,
        "maxResults": 10
      },
      "changePassword": {
        "supported": false
      },
      "sort": {
        "supported": false
      },
      "authenticationSchemes": {
        "name": "HTTP Basic",
        "description": "Authentication Scheme using the Http Basic Standard.",
        "specUri": "http://www.ietf.org/rfc/rfc2617.txt",
        "documentationUri": "https://community.sailpoint.com/community/identityiq/product-downloads",
        "type": "oauthbearertoken"
      },
      "meta": {
        "location": "http://localhost:8080/identityiq/scim/v2/ServiceProviderConfig",
        "resourceType": "ServiceProviderConfig"
      }
    }
  ]
}

application/scim+json

Schema

Schema

maxResults integer

Number of ServiceProviderConfig resources returned.

supported boolean
schemas string[]

SCIM Schema used for response.

Resources

undefined[]

The SCIM resources returned for this endpoint.

Array [

documentationUri string

An HTTP addressable URL pointing to the service provider's human consumable help documentation.

patch

object

required

A complex type that specifies PATCH configuration options.

supported booleanrequired

Boolean value specifying whether the operation is supported.

etag

object

required

A complex type that specifies ETAG configuration options.

supported booleanrequired

Boolean value specifying whether the operation is supported.

bulk

object

required

A complex type that specifies ETAG configuration options.

supported booleanrequired

Boolean value specifying whether the operation is supported.

maxOperations integerrequired

An integer value specifying the maximum number of operations.

maxPayloadSize integerrequired

An integer value specifying the maximum payload size in bytes.

filter

object

required

A complex type that specifies FILTER options.

supported booleanrequired

Boolean value specifying whether the operation is supported.

maxResults integerrequired

Integer value specifying the maximum number of resources returned in a response.

changePassword

object

required

A complex type that specifies change password options.

supported booleanrequired

Boolean value specifying whether the operation is supported.

sort

object

required

A complex type that specifies sort result options.

supported booleanrequired

Boolean value specifying whether the operation is supported.

authenticationSchemes

object

required

A complex type that specifies supported Authentication Scheme properties.

name stringrequired

The common authentication scheme name; e.g., HTTP Basic.

description stringrequired

A description of the authentication scheme.

specUri string

An HTTP addressable URL pointing to the Authentication Scheme's specification.

documentationUri string

An HTTP addressable URL pointing to the Authentication Scheme's usage documentation.

type stringrequired

Possible values: [oauth, oauth2, oauthbearertoken, httpbasic, httpdigest]

The authentication scheme.

meta

object

location string

URL to ServiceProviderConfig resource.

resourceType string

Resource type of the metadata subject.

]

Example (from schema)

{
  "maxResults": "1500,",
  "supported": true,
  "schemas": [
    "urn:ietf:params:scim:api:messages:2.0:ListResponse"
  ],
  "Resources": [
    {
      "documentationUri": "https://community.sailpoint.com/community/identityiq/product-downloads",
      "patch": {
        "supported": false
      },
      "etag": {
        "supported": true
      },
      "bulk": {
        "supported": false,
        "maxOperations": 3,
        "maxPayloadSize": 128
      },
      "filter": {
        "supported": true,
        "maxResults": 10
      },
      "changePassword": {
        "supported": false
      },
      "sort": {
        "supported": false
      },
      "authenticationSchemes": {
        "name": "HTTP Basic",
        "description": "Authentication Scheme using the Http Basic Standard.",
        "specUri": "http://www.ietf.org/rfc/rfc2617.txt",
        "documentationUri": "https://community.sailpoint.com/community/identityiq/product-downloads",
        "type": "oauthbearertoken"
      },
      "meta": {
        "location": "http://localhost:8080/identityiq/scim/v2/ServiceProviderConfig",
        "resourceType": "ServiceProviderConfig"
      }
    }
  ]
}

Loading...