Skip to main content

Update the Identity Profile

PATCH 

/identity-profiles/:identity-profile-id

This updates the specified Identity Profile.

Some fields of the Schema cannot be updated. These fields are listed below:

  • id
  • name
  • created
  • modified
  • identityCount
  • identityRefreshRequired
  • Authoritative Source and Identity Attribute Configuration cannot be modified at once.

Request

Path Parameters

    identity-profile-id uuidrequired

    The Identity Profile ID

    Example: ef38f94347e94562b5bb8424a56397d8

Body

array

required

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

  • Array [

  • op stringrequired

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

    The operation to be performed

    path stringrequired

    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

    oneOf

    string

  • ]

Responses

The updated Identity Profile.

Schema

    id string

    System-generated unique ID of the Object

    name stringrequired

    Name of the Object

    created date-time

    Creation date of the Object

    modified date-time

    Last modification date 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.

Loading...