Skip to main content

Import Identity Profiles

POST 

/identity-profiles/import

This imports previously exported identity profiles.

Request

Body

array

required

Previously exported Identity Profiles.

  • Array [

  • version int32

    Version or object from the target service.

    self

    object

    Self block for 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]

    Exported object's DTO type.

    id string

    Exported object's ID.

    name string

    Exported object's display name.

    object

    object

    name stringrequired

    Name of the Object

    description stringnullable

    The description of the Identity Profile.

    owner

    object

    nullable

    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

    object

    required

    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

    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

    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

    property name* any

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

  • ]

  • identityExceptionReportReference

    object

    nullable

    taskResultId uuid

    The id of the task result.

    reportName string

    The name of the report.

    hasTimeBasedAttr boolean

    Indicates the value of requiresPeriodicRefresh attribute for the Identity Profile.

  • ]

Responses

The result of importing Identity Profiles.

Schema

    infos

    object[]

    required

    Informational messages returned from the target service on import.

  • Array [

  • key stringrequired

    Message key.

    text stringrequired

    Message text.

    details

    object

    required

    Message details if any, in key:value pairs.

    property name* any

    Message details if any, in key:value pairs.

  • ]

  • warnings

    object[]

    required

    Warning messages returned from the target service on import.

  • Array [

  • key stringrequired

    Message key.

    text stringrequired

    Message text.

    details

    object

    required

    Message details if any, in key:value pairs.

    property name* any

    Message details if any, in key:value pairs.

  • ]

  • errors

    object[]

    required

    Error messages returned from the target service on import.

  • Array [

  • key stringrequired

    Message key.

    text stringrequired

    Message text.

    details

    object

    required

    Message details if any, in key:value pairs.

    property name* any

    Message details if any, in key:value pairs.

  • ]

  • importedObjects

    object[]

    required

    References to objects that were created or updated by the import.

  • Array [

  • type string

    Possible values: [IDENTITY_OBJECT_CONFIG, IDENTITY_PROFILE, RULE, SOURCE, TRANSFORM, TRIGGER_SUBSCRIPTION]

    DTO type of object created or updated by import.

    id string

    ID of object created or updated by import.

    name string

    Display name of object created or updated by import.

  • ]

Loading...