Returns all object of type ObjectConfig.

GET 
/ObjectConfigs

This endpoint returns all ObjectConfig 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 ObjectConfig is:

• urn:ietf:params:scim:schemas:sailpoint:1.0:ObjectConfig.

Request

Query Parameters

filter string

Allows for query filters according to RFC-7644, Section 3.4.2.2 - not all operations are supported.

lookupByName boolean

(OPTIONAL) Set to true if the ObjectConfig name is passed instead of the ObjectConfig id.

sortBy string

Allows sorting the results by a resource's attributes.

sortOrder string
Default value: ascending
Determines what order to sort results in.
Example: descending
startIndex integer

Default value: 1

Determines the starting index of the result set.

count integer

Default value: 1000

Specifies the number of results per page.

attributes string

A comma-separated list of attributes to return in the response. This query parameter supersedes excludedAttributes, so providing the same attribute(s) to both will result in the attribute(s) being returned.

excludedAttributes string

A comma-separated list of attributes to exclude from the response. Some attributes cannot be excluded.

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 [
id string
Unique identifier of the ObjectConfig.
name string
Name of the ObjectConfig.
objectAttributes undefined[]
A list of attributes of the ObjectConfig.
Array [
name string
The object attribute name.
displayName string
The display name of the object attribute.
type string
The type of the object attribute.
multi boolean
A Boolean value indicating this is a multi-valued attribute.
defaultValue string
The default value of the object attribute.
system boolean
A Boolean value indicating this is a system attribute that does not have a source and is not configurable.
standard boolean
A Boolean value indicating this is a standard attribute (i.e. manager, email, firstname, lastname).
extendedNumber integer
Integer value of the extended attribute column number in the database schema.
namedColumn boolean
A Boolean value indicating this attribute has a named column in the database schema.
ruleName string
Rule used to derive the value. Usually specified when there are no attributeSources defined.
groupFactory boolean
A Boolean value indicating this attribute can be used in a group factory. Identity attributes only.
editMode string
Possible values: [READONLY, PERMANENT, UNTILFEEDVALUECHANGES]
Enumeration indicating whether this attribute allows modification.
attributeSources undefined[]
Sources of values for this atribute. Identity attributes only.
Array [
name string
The name of the attribute on the application.
key string
Derived identifier for this source.
instance string
Optional instance name for template applications.
ruleName string
Rule used to derive the value.
]
attributeTargets undefined[]
Targets of this attribute that should receive the value upon attribute synchronization. Identity attributes only.
Array [
name string
The name of the attribute on the application.
key string
Derived identifier for this target.
instance string
Optional instance name for template applications.
ruleName string
Rule used to derive the value.
provisionAllAccount boolean
Return whether to provision all accounts if an identity has multiple accounts on the target application. Identity attributes only.
]
]
meta undefined[]
Metadata for the ObjectConfig
Array [
created string
Datetime when the ObjectConfig was created
location string
URL to the ObjectConfig
lastModified string
Datetime of ObjectConfig last modification
version string
ObjectConfig version
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": [
    {
      "id": "c0a8019c7fe11678817fe18984351477",
      "name": "Link",
      "objectAttributes": [
        {
          "name": "inactive",
          "displayName": "attr_demoInactive",
          "type": "boolean",
          "multi": false,
          "defaultValue": "false",
          "system": true,
          "standard": false,
          "extendedNumber": 1,
          "namedColumn": false,
          "ruleName": "lastLoginToDateRule",
          "groupFactory": true,
          "editMode": "READONLY",
          "attributeSources": [
            {
              "name": "app1_inactive",
              "key": "Active_Directory:app1_inactive",
              "instance": "test-environment",
              "ruleName": "attributeSource-aws-S3-rule"
            }
          ],
          "attributeTargets": [
            {
              "name": "app2_active",
              "key": "Composite_ERP_Global_Platform:app2_inactive",
              "instance": "continuous-integration-environment1",
              "ruleName": "attributeTarget-aws-S3-rule",
              "provisionAllAccount": false
            }
          ]
        }
      ],
      "meta": [
        {
          "created": "2022-03-31T14:52:40.245-05:00",
          "location": "http://localhost:8080/identityiq/scim/v2/ObjectConfig/7f00000180281df7818028be62ef00e9",
          "lastModified": "2022-03-31T14:52:40.265-05:00",
          "version": "\"W\"1649951092552\"",
          "resourceType": "ObjectConfig"
        }
      ]
    }
  ]
}

application/scim+json

Schema

Schema

totalResults integer

Number of ObjectConfig resources returned.

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[]
The SCIM resources returned for this endpoint.
Array [
id string
Unique identifier of the ObjectConfig.
name string
Name of the ObjectConfig.
objectAttributes undefined[]
A list of attributes of the ObjectConfig.
Array [
name string
The object attribute name.
displayName string
The display name of the object attribute.
type string
The type of the object attribute.
multi boolean
A Boolean value indicating this is a multi-valued attribute.
defaultValue string
The default value of the object attribute.
system boolean
A Boolean value indicating this is a system attribute that does not have a source and is not configurable.
standard boolean
A Boolean value indicating this is a standard attribute (i.e. manager, email, firstname, lastname).
extendedNumber integer
Integer value of the extended attribute column number in the database schema.
namedColumn boolean
A Boolean value indicating this attribute has a named column in the database schema.
ruleName string
Rule used to derive the value. Usually specified when there are no attributeSources defined.
groupFactory boolean
A Boolean value indicating this attribute can be used in a group factory. Identity attributes only.
editMode string
Possible values: [READONLY, PERMANENT, UNTILFEEDVALUECHANGES]
Enumeration indicating whether this attribute allows modification.
attributeSources undefined[]
Sources of values for this atribute. Identity attributes only.
Array [
name string
The name of the attribute on the application.
key string
Derived identifier for this source.
instance string
Optional instance name for template applications.
ruleName string
Rule used to derive the value.
]
attributeTargets undefined[]
Targets of this attribute that should receive the value upon attribute synchronization. Identity attributes only.
Array [
name string
The name of the attribute on the application.
key string
Derived identifier for this target.
instance string
Optional instance name for template applications.
ruleName string
Rule used to derive the value.
provisionAllAccount boolean
Return whether to provision all accounts if an identity has multiple accounts on the target application. Identity attributes only.
]
]
meta undefined[]
Metadata for the ObjectConfig
Array [
created string
Datetime when the ObjectConfig was created
location string
URL to the ObjectConfig
lastModified string
Datetime of ObjectConfig last modification
version string
ObjectConfig version
resourceType string
Resource type of the metadata subject
]
]

Example (from schema)

{
  "totalResults": "1500,",
  "startIndex": 1,
  "schemas": [
    "urn:ietf:params:scim:api:messages:2.0:ListResponse"
  ],
  "Resources": [
    {
      "id": "c0a8019c7fe11678817fe18984351477",
      "name": "Link",
      "objectAttributes": [
        {
          "name": "inactive",
          "displayName": "attr_demoInactive",
          "type": "boolean",
          "multi": false,
          "defaultValue": "false",
          "system": true,
          "standard": false,
          "extendedNumber": 1,
          "namedColumn": false,
          "ruleName": "lastLoginToDateRule",
          "groupFactory": true,
          "editMode": "READONLY",
          "attributeSources": [
            {
              "name": "app1_inactive",
              "key": "Active_Directory:app1_inactive",
              "instance": "test-environment",
              "ruleName": "attributeSource-aws-S3-rule"
            }
          ],
          "attributeTargets": [
            {
              "name": "app2_active",
              "key": "Composite_ERP_Global_Platform:app2_inactive",
              "instance": "continuous-integration-environment1",
              "ruleName": "attributeTarget-aws-S3-rule",
              "provisionAllAccount": false
            }
          ]
        }
      ],
      "meta": [
        {
          "created": "2022-03-31T14:52:40.245-05:00",
          "location": "http://localhost:8080/identityiq/scim/v2/ObjectConfig/7f00000180281df7818028be62ef00e9",
          "lastModified": "2022-03-31T14:52:40.265-05:00",
          "version": "\"W\"1649951092552\"",
          "resourceType": "ObjectConfig"
        }
      ]
    }
  ]
}

Loading...