Files
developer.sailpoint.com/static/api-specs/idn/beta/paths/attr-sync-config-source.yaml
2022-09-27 02:15:36 +00:00

85 lines
2.5 KiB
YAML

get:
operationId: getSourceAttrSyncConfig
tags:
- Sources
summary: Attribute Sync Config
description: >-
This API returns the existing attribute synchronization configuration for a source specified by the
given ID. The response contains all attributes, regardless of whether they enabled or not.
A token with ORG_ADMIN authority is required to call this API.
parameters:
- in: path
name: id
required: true
schema:
type: string
description: The source id
example: 2c9180835d191a86015d28455b4a2329
responses:
'200':
description: Attribute synchronization configuration for a source
content:
application/json:
schema:
$ref: '../schemas/AttrSyncSourceConfig.yaml'
'400':
$ref: '../../v3/responses/400.yaml'
'401':
$ref: '../../v3/responses/401.yaml'
'403':
$ref: '../../v3/responses/403.yaml'
'404':
$ref: '../../v3/responses/404.yaml'
'429':
$ref: '../../v3/responses/429.yaml'
'500':
$ref: '../../v3/responses/500.yaml'
put:
operationId: putSourceAttrSyncConfig
tags:
- Sources
summary: Update Attribute Sync Config
description: >-
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.
parameters:
- in: path
name: id
required: true
schema:
type: string
description: The source id
example: 2c9180835d191a86015d28455b4a2329
requestBody:
required: true
content:
application/json:
schema:
$ref: '../schemas/AttrSyncSourceConfig.yaml'
responses:
'200':
description: Updated attribute synchronization configuration for a source
content:
application/json:
schema:
$ref: '../schemas/AttrSyncSourceConfig.yaml'
'400':
$ref: '../../v3/responses/400.yaml'
'401':
$ref: '../../v3/responses/401.yaml'
'403':
$ref: '../../v3/responses/403.yaml'
'404':
$ref: '../../v3/responses/404.yaml'
'429':
$ref: '../../v3/responses/429.yaml'
'500':
$ref: '../../v3/responses/500.yaml'