Skip to main content

Generate Identity Profile Preview



This generates a non-persisted IdentityDetails object that will represent as the preview of the identities attribute when the given policy's attribute config is applied. A token with ORG_ADMIN authority is required to call this API to generate an identity preview.




Identity Preview request body.

    identityId uuid
    identityAttributeConfig object
    enabled boolean

    Default value: true

    If the profile or 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 objectnullable

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

    property name* anynullable

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

  • ]


Object representing the preview object with all of the identity attributes using the current mappings.

    identity object

    Identity's manager.

    type string

    Possible values: [IDENTITY]

    DTO type of identity's manager.

    id string

    ID of identity's manager.

    name string

    Human-readable display name of identity's manager.

    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 LocaleOriginnullable

    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.

  • ]
  • ]