Skip to main content

Export Identity Profiles

GET 

/identity-profiles/export

This exports existing identity profiles in the format specified by the sp-config service.

Request

Query Parameters

    limit int32

    Possible values: <= 250

    Default value: 250

    Max number of results to return. See V3 API Standard Collection Parameters for more information.

    Example: 250
    offset int32

    Offset into the full result set. Usually specified with limit to paginate through the results. See V3 API Standard Collection Parameters for more information.

    Example: 0
    count boolean

    If true it will populate the X-Total-Count response header with the number of results that would be returned if limit and offset were ignored.

    Since requesting a total count can have a performance impact, it is recommended not to send count=true if that value will not be used.

    See V3 API Standard Collection Parameters for more information.

    Example: true
    filters string

    Filter results using the standard syntax described in V3 API Standard Collection Parameters

    Filtering is supported for the following fields and operators:

    id: eq, ne

    name: eq, ne

    priority: eq, ne

    Example: id eq 8c190e6787aa4ed9a90bd9d5344523fb
    sorters comma-separated

    Sort results using the standard syntax described in V3 API Standard Collection Parameters

    Sorting is supported for the following fields: id, name, priority

    Example: name,-priority

Responses

List of export objects with identity profiles.

Schema
  • Array [
  • version integer

    Version or object from the target service.

    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
    id string

    System-generated unique ID of the Object

    name stringrequired

    Name of the Object

    created date-time

    Creation date of the Object

    modified date-time

    Last modification date of the Object

    description stringnullable

    The description of the Identity Profile.

    owner objectnullable

    The owner of the Identity Profile.

    type string

    Possible values: [IDENTITY]

    Type of the object to which this reference applies

    id string

    ID of the object to which this reference applies

    name string

    Human-readable display name of the object to which this reference applies

    priority int64

    The priority for an Identity Profile.

    authoritativeSource objectrequired
    type string

    Possible values: [SOURCE]

    Type of the object to which this reference applies

    id string

    ID of the object to which this reference applies

    name string

    Human-readable display name of the object to which this reference applies

    identityRefreshRequired boolean

    Default value: false

    True if a identity refresh is needed. Typically triggered when a change on the source has been made.

    identityCount int32

    The number of identities that belong to the Identity Profile.

    identityAttributeConfig object

    Defines all the identity attribute mapping configurations. This defines how to generate or collect data for each identity attributes in identity refresh process.

    enabled boolean

    Default value: false

    The backend will only promote values if the profile/mapping is enabled.

    attributeTransforms object[]
  • Array [
  • identityAttributeName string

    Name of the identity attribute.

    transformDefinition object

    The seaspray transformation definition.

    type string

    The type of the transform definition.

    attributes object

    Arbitrary key-value pairs to store any metadata for the object

    anyOf
  • ]
  • identityExceptionReportReference objectnullable
    taskResultId uuid

    The id of the task result.

    reportName string

    The name of the report.

    hasTimeBasedAttr boolean

    Default value: false

    Indicates the value of requiresPeriodicRefresh attribute for the Identity Profile.

  • ]
Loading...