Skip to main content

Update Attribute Sync Config

PUT 

/sources/:id/attribute-sync-config

Replaces the attribute synchronization configuration for the source specified by the given ID with the configuration provided in the request body. Only the "enabled" field of the values in the "attributes" array is mutable. Attempting to change other attributes or add new values to the "attributes" array will result in an error.

A token with ORG_ADMIN authority is required to call this API.

Request

Path Parameters

    id stringrequired

    The source id

    Example: 2c9180835d191a86015d28455b4a2329

Body

required

    source

    object

    required

    Target source for attribute synchronization.

    type string

    Possible values: [SOURCE]

    DTO type of target source for attribute synchronization.

    id string

    ID of target source for attribute synchronization.

    name string

    Human-readable name of target source for attribute synchronization.

    attributes

    object[]

    required

    Attribute synchronization configuration for specific identity attributes in the context of a source

  • Array [

  • name stringrequired

    Name of the identity attribute

    displayName stringrequired

    Display name of the identity attribute

    enabled booleanrequired

    Determines whether or not the attribute is enabled for synchronization

    target stringrequired

    Name of the source account attribute to which the identity attribute value will be synchronized if enabled

  • ]

Responses

Updated attribute synchronization configuration for a source

Schema

    source

    object

    required

    Target source for attribute synchronization.

    type string

    Possible values: [SOURCE]

    DTO type of target source for attribute synchronization.

    id string

    ID of target source for attribute synchronization.

    name string

    Human-readable name of target source for attribute synchronization.

    attributes

    object[]

    required

    Attribute synchronization configuration for specific identity attributes in the context of a source

  • Array [

  • name stringrequired

    Name of the identity attribute

    displayName stringrequired

    Display name of the identity attribute

    enabled booleanrequired

    Determines whether or not the attribute is enabled for synchronization

    target stringrequired

    Name of the source account attribute to which the identity attribute value will be synchronized if enabled

  • ]

Loading...