Skip to main content

Update the Identity Profile

This updates the specified Identity Profile. A token with ORG_ADMIN authority is required to call this API to update the Identity Profile. Some fields of the Schema cannot be updated. These fields are listed below.

  • id
  • name
  • created
  • modified
Path Parameters
  • identity-profile-id uuid required

    The Identity Profile ID

    Example: ef38f94347e94562b5bb8424a56397d8
Request Body array required

A list of Identity Profile update operations according to the JSON Patch standard.

  • op string required

    Possible values: [add, remove, replace, move, copy, test]

    The operation to be performed

  • path string required

    A string JSON Pointer representing the target path to an element to be affected by the operation

  • value object

    The value to be used for the operation, required for "add" and "replace" operations

    anyOf

  • string
Responses

The updated Identity Profile.


Schema
  • id string

    System-generated unique ID of the Object

  • name string

    Name of the Object

  • created date-time

    Creation date of the Object

  • modified date-time

    Last modification date of the Object

  • description string

    The description of the Identity Profile.

  • owner object

    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

    The authoritative source for this Identity Profile.

  • 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
  • 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
  • identityExceptionReportReference object
  • 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.

Loading...