Skip to main content

Get config object details

GET 

/sp-config/config-objects

experimental

This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to true to use this endpoint.

This gets the list of object configurations which are known to the tenant export/import service. Object configurations that contain "importUrl" and "exportUrl" are available for export/import.

Request

Header Parameters

    X-SailPoint-Experimental stringrequired

    Default value: true

    Use this header to enable this experimental API.

    Example: true

Responses

Object configurations returned successfully.

Schema

  • Array [

  • objectType string

    The object type this configuration is for.

    referenceExtractors string[]nullable

    List of json paths within an exported object of this type that represent references that need to be resolved.

    signatureRequired boolean

    If true, this type of object will be JWS signed and cannot be modified before import.

    legacyObject boolean

    Whether this is a legacy object

    onePerTenant boolean

    Whether there is only one object of this type

    exportable boolean

    Whether this object can be exported or it is just a reference object

    rules

    object

    Rules to be applied to the config object during draft process

    takeFromTargetRules

    object[]

  • Array [

  • path string

    JSONPath expression denoting the path within the object where a value substitution should be applied

    value objectnullable

    Value to be assigned at the jsonPath location within the object

    mode string[]

    Possible values: [RESTORE, PROMOTE, UPLOAD]

    Draft modes to which this rule will apply

  • ]

  • defaultRules

    object[]

  • Array [

  • path string

    JSONPath expression denoting the path within the object where a value substitution should be applied

    value objectnullable

    Value to be assigned at the jsonPath location within the object

    mode string[]

    Possible values: [RESTORE, PROMOTE, UPLOAD]

    Draft modes to which this rule will apply

  • ]

  • editable boolean

    Whether this object can be edited

  • ]

Loading...