Skip to main content

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​

Returned all SCIM resources for this endpoint.

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

  • ]

  • ]

Loading...