Files
api-specs/idn/beta/paths/reassignment-configuration.yaml
GitHub Action Bot 9269e86172 Automated commit 'added new oauth2 flow and description (#1386)
* added new oauth2 flow and description

* renamed authentication to make more sense' by github action: 5967546682
2023-08-24 18:29:03 +00:00

107 lines
2.9 KiB
YAML

get:
operationId: getReassignmentConfiguration
tags:
- Work Reassignment
summary: Get Reassignment Configuration
description: >-
Gets the Reassignment Configuration for an identity.
security:
- UserContextAuth: [idn:reassignment-configuration:read]
parameters:
- in: path
name: identityId
schema:
type: string
description: unique identity id
required: true
example: 2c91808781a71ddb0181b9090b5c504f
responses:
'200':
description: Reassignment Configuration for an identity
content:
application/json:
schema:
$ref: '../schemas/work-reassignment/ConfigurationResponse.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: putReassignmentConfig
tags:
- Work Reassignment
summary: Update Reassignment Configuration
description: >-
Replaces existing Reassignment configuration for an identity with the newly provided configuration.
security:
- UserContextAuth: [idn:reassignment-configuration:update]
parameters:
- in: path
name: identityId
schema:
type: string
description: unique identity id
required: true
example: 2c91808781a71ddb0181b9090b5c504e
requestBody:
required: true
content:
application/json:
schema:
$ref: '../schemas/work-reassignment/ConfigurationItemRequest.yaml'
responses:
'200':
description: Reassignment Configuration updated
content:
application/json:
schema:
$ref: '../schemas/work-reassignment/ConfigurationItemResponse.yaml'
'400':
$ref: '../../v3/responses/400.yaml'
'401':
$ref: '../../v3/responses/401.yaml'
'403':
$ref: '../../v3/responses/403.yaml'
'429':
$ref: '../../v3/responses/429.yaml'
'500':
$ref: '../../v3/responses/500.yaml'
delete:
operationId: deleteReassignmentConfiguration
tags:
- Work Reassignment
summary: Delete Reassignment Configuration
description: >-
Deletes all Reassignment Configuration for the specified identity
security:
- UserContextAuth: [idn:reassignment-configuration:delete]
parameters:
- in: path
name: identityId
schema:
type: string
description: unique identity id
required: true
example: 2c91808781a71ddb0181b9090b5c504e
responses:
'204':
description: Reassignment Configuration deleted
'400':
$ref: '../../v3/responses/400.yaml'
'401':
$ref: '../../v3/responses/401.yaml'
'403':
$ref: '../../v3/responses/403.yaml'
'429':
$ref: '../../v3/responses/429.yaml'
'500':
$ref: '../../v3/responses/500.yaml'