Skip to main content

Initiates configuration objects export job

POST 

/sp-config/export

This post will export objects from the tenant to a JSON configuration file. For more information about the object types that currently support export functionality, refer to SaaS Configuration.

Request

Body

required

Export options control what will be included in the export.

    description string

    Optional user defined description/name for export job.

    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.

Responses

Export job accepted and queued for processing.

Schema

    jobId stringrequired

    Unique id assigned to this job.

    status stringrequired

    Possible values: [NOT_STARTED, IN_PROGRESS, COMPLETE, CANCELLED, FAILED]

    Status of the job.

    type stringrequired

    Possible values: [EXPORT, IMPORT]

    Type of the job, either export or import.

    expiration date-timerequired

    The time until which the artifacts will be available for download.

    created date-timerequired

    The time the job was started.

    modified date-timerequired

    The time of the last update to the job.

    description string

    Optional user defined description/name for export job.

Loading...