Skip to main content

Generate Identity Profile Preview

POST 

/identity-profiles/identity-preview

Use this API to generate a non-persisted preview of the identity object after applying IdentityAttributeConfig sent in request body. This API only allows accountAttribute, reference and rule transform types in the IdentityAttributeConfig sent in the request body.

Request

Body

required

Identity Preview request body.

    identityId uuid

    The Identity id

    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

  • ]

Responses

A preview of the identity attributes after applying identity attributes config sent in request body.

Schema

    identity

    object

    Identity's basic details.

    type string

    Possible values: [IDENTITY]

    Identity's DTO type.

    id string

    Identity ID.

    name string

    Identity's display name.

    previewAttributes

    object[]

  • Array [

  • name string

    Name of the attribute that is being previewed.

    value string

    Value that was derived during the preview.

    previousValue string

    The value of the attribute before the preview.

    errorMessages

    object[]

    A list of errors that may have been encountered.

  • Array [

  • locale stringnullable

    The locale for the message text, a BCP 47 language tag.

    localeOrigin LocaleOrigin (string)nullable

    Possible values: [DEFAULT, REQUEST, null]

    An indicator of how the locale was selected. DEFAULT means the locale is the system default. REQUEST means the locale was selected from the request context (i.e., best match based on the Accept-Language header). Additional values may be added in the future without notice.

    text string

    Actual text of the error message in the indicated locale.

  • ]

  • ]

Loading...