Skip to main content

Download export job result.

GET 

/sp-config/export/:id/download

This endpoint gets the export file resulting from the export job with the requested id and downloads it to a file. The request will need one of the following security scopes:

  • sp:config:read - sp:config:manage

Request

Path Parameters

    id stringrequired

    The ID of the export job whose results will be downloaded.

    Example: ef38f94347e94562b5bb8424a56397d8

Responses

Exported JSON objects.

Schema

    version integer

    Current version of the export results object.

    timestamp date-time

    Time the export was completed.

    tenant string

    Name of the tenant where this export originated.

    description string

    Optional user defined description/name for export job.

    options

    object

    Options used to create this export.

    excludeTypes string[]

    Possible values: [ACCESS_PROFILE, ACCESS_REQUEST_CONFIG, ATTR_SYNC_SOURCE_CONFIG, AUTH_ORG, CAMPAIGN_FILTER, FORM_DEFINITION, GOVERNANCE_GROUP, IDENTITY_OBJECT_CONFIG, IDENTITY_PROFILE, LIFECYCLE_STATE, NOTIFICATION_TEMPLATE, PASSWORD_POLICY, PASSWORD_SYNC_GROUP, PUBLIC_IDENTITIES_CONFIG, ROLE, RULE, SEGMENT, SERVICE_DESK_INTEGRATION, SOD_POLICY, SOURCE, TAG, TRANSFORM, TRIGGER_SUBSCRIPTION, WORKFLOW]

    Object type names to be excluded from an sp-config export command.

    includeTypes string[]

    Possible values: [ACCESS_PROFILE, ACCESS_REQUEST_CONFIG, ATTR_SYNC_SOURCE_CONFIG, AUTH_ORG, CAMPAIGN_FILTER, FORM_DEFINITION, GOVERNANCE_GROUP, IDENTITY_OBJECT_CONFIG, IDENTITY_PROFILE, LIFECYCLE_STATE, NOTIFICATION_TEMPLATE, PASSWORD_POLICY, PASSWORD_SYNC_GROUP, PUBLIC_IDENTITIES_CONFIG, ROLE, RULE, SEGMENT, SERVICE_DESK_INTEGRATION, SOD_POLICY, SOURCE, TAG, TRANSFORM, TRIGGER_SUBSCRIPTION, WORKFLOW]

    Object type names to be included in an sp-config export command. IncludeTypes takes precedence over excludeTypes.

    objectOptions

    object

    Additional options targeting specific objects related to each item in the includeTypes field

    property name*

    ObjectExportImportOptions

    includedIds string[]

    Object ids to be included in an import or export.

    includedNames string[]

    Object names to be included in an import or export.

    objects

    object[]

  • Array [

  • version integer

    Current version of configuration object.

    self

    object

    Self block for imported/exported object.

    type string

    Possible values: [ACCESS_PROFILE, ACCESS_REQUEST_CONFIG, ATTR_SYNC_SOURCE_CONFIG, AUTH_ORG, CAMPAIGN_FILTER, FORM_DEFINITION, GOVERNANCE_GROUP, IDENTITY_OBJECT_CONFIG, IDENTITY_PROFILE, LIFECYCLE_STATE, NOTIFICATION_TEMPLATE, PASSWORD_POLICY, PASSWORD_SYNC_GROUP, PUBLIC_IDENTITIES_CONFIG, ROLE, RULE, SEGMENT, SERVICE_DESK_INTEGRATION, SOD_POLICY, SOURCE, TAG, TRANSFORM, TRIGGER_SUBSCRIPTION, WORKFLOW]

    Imported/exported object's DTO type. Import is currently only possible with the IDENTITY_OBJECT_CONFIG, IDENTITY_PROFILE, RULE, SOURCE, TRANSFORM, and TRIGGER_SUBSCRIPTION object types.

    id string

    Imported/exported object's ID.

    name string

    Imported/exported object's display name.

    object

    Object details. Format dependant on the object type.

    property name* any

    Object details. Format dependant on the object type.

  • ]

Loading...