Skip to main content

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

Path Parameters
  • id string required

    The source id

    Example: 2c9180835d191a86015d28455b4a2329
Request Body required
  • source object required

    Reference to the source which is the target of the attribute synchronization

  • 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

  • attributes object[] required

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

  • name string required

    Name of the identity attribute

  • displayName string required

    Display name of the identity attribute

  • enabled boolean required

    Determines whether or not the attribute is enabled for synchronization

  • target string required

    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

    Reference to the source which is the target of the attribute synchronization

  • 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

  • attributes object[]

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

  • name string

    Name of the identity attribute

  • displayName string

    Display name of the identity attribute

  • enabled boolean

    Determines whether or not the attribute is enabled for synchronization

  • target string

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

Loading...