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.

Request Body required

Identity Preview request body.

  • identityId uuid
  • identityAttributeConfig object
  • enabled boolean

    If the profile or mapping is enabled

  • attributeTransforms object[]
  • 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* object
Responses

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


Schema
  • identity object
  • type string

    Possible values: [ACCOUNT_CORRELATION_CONFIG, ACCESS_PROFILE, ACCESS_REQUEST_APPROVAL, ACCOUNT, APPLICATION, CAMPAIGN, CAMPAIGN_FILTER, CERTIFICATION, CLUSTER, CONNECTOR_SCHEMA, ENTITLEMENT, GOVERNANCE_GROUP, IDENTITY, IDENTITY_PROFILE, IDENTITY_REQUEST, LIFECYCLE_STATE, PASSWORD_POLICY, ROLE, RULE, SOD_POLICY, SOURCE, TAG_CATEGORY, TASK_RESULT, REPORT_RESULT, SOD_VIOLATION, ACCOUNT_ACTIVITY]

    DTO type

  • 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

  • previewAttributes object[]
  • name string

    Name of the attribute that is being previewed.

  • value object

    Value that was derived during the preview.

  • previousValue object

    The value of the attribute before the preview.

  • errorMessages object[]

    A list of errors that may have been encountered

  • locale string

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

  • localeOrigin string

    Possible values: [DEFAULT, REQUEST]

    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...