Returns an ObjectConfig resource based on its name or id.

GET 
/ObjectConfig/:objectConfigId

The ObjectConfig resource with matching name or id is returned.

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

Path Parameters

objectConfigId stringrequired

id of ObjectConfig resource.

Query Parameters

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

Returns a single ObjectConfig resource based on its name or id.

application/json

Schema

Schema

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)

{
  "id": "7f00000180281df7818028be63aa00ef",
  "name": "Bundle",
  "objectAttributes": [
    {
      "name": "StringAttr",
      "displayName": "attr_demoString",
      "type": "string",
      "multi": false,
      "defaultValue": "None",
      "system": false,
      "standard": false,
      "extendedNumber": 2,
      "namedColumn": false,
      "ruleName": "lastLoginToDate",
      "groupFactory": true,
      "editMode": "READONLY",
      "attributeSources": [
        {
          "name": "lastName",
          "key": "testInstancesApplication/inst2:lastName",
          "instance": "inst2",
          "ruleName": "Identity Attribute Rule - Type"
        }
      ],
      "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...