mirror of
https://github.com/LukeHagar/api-specs.git
synced 2025-12-09 20:37:50 +00:00
9269e86172
* added new oauth2 flow and description * renamed authentication to make more sense' by github action: 5967546682
134 lines
3.9 KiB
YAML
134 lines
3.9 KiB
YAML
get:
|
|
operationId: getPasswordSyncGroup
|
|
tags:
|
|
- Password Sync Groups
|
|
summary: Get Password Sync Group by ID
|
|
description: >-
|
|
This API returns the sync group for the specified ID.
|
|
A token with ORG_ADMIN authority is required to call this API.
|
|
security:
|
|
- UserContextAuth: ['idn:password-sync-group-management:read']
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
required: true
|
|
description: The ID of password sync group to retrieve.
|
|
example: 6881f631-3bd5-4213-9c75-8e05cc3e35dd
|
|
responses:
|
|
'200':
|
|
description: Reference to the password sync group.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '../schemas/PasswordSyncGroup.yaml'
|
|
example:
|
|
{
|
|
"id": "6881f631-3bd5-4213-9c75-8e05cc3e35dd",
|
|
"name": "Password Sync Group 1",
|
|
"passwordPolicyId": "2c91808d744ba0ce01746f93b6204501",
|
|
"sourceIds": ["2c918084660f45d6016617daa9210584", "2c918084660f45d6016617daa9210500"]
|
|
}
|
|
'400':
|
|
$ref: '../responses/400.yaml'
|
|
'401':
|
|
$ref: '../responses/401.yaml'
|
|
'403':
|
|
$ref: '../responses/403.yaml'
|
|
'404':
|
|
$ref: '../responses/404.yaml'
|
|
'429':
|
|
$ref: '../responses/429.yaml'
|
|
'500':
|
|
$ref: '../responses/500.yaml'
|
|
put:
|
|
operationId: updatePasswordSyncGroup
|
|
tags:
|
|
- Password Sync Groups
|
|
summary: Update Password Sync Group by ID
|
|
description: >-
|
|
This API updates the specified password sync group.
|
|
A token with ORG_ADMIN authority is required to call this API.
|
|
security:
|
|
- UserContextAuth: ['idn:password-sync-group-management:write']
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
required: true
|
|
description: The ID of password sync group to update.
|
|
example: 6881f631-3bd5-4213-9c75-8e05cc3e35dd
|
|
requestBody:
|
|
required: true
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '../schemas/PasswordSyncGroup.yaml'
|
|
example:
|
|
{
|
|
"id": "6881f631-3bd5-4213-9c75-8e05cc3e35dd",
|
|
"name": "Password Sync Group 2",
|
|
"passwordPolicyId": "2c91808d744ba0ce01746f93b6204501",
|
|
"sourceIds": ["2c918084660f45d6016617daa9210584", "2c918084660f45d6016617daa9210500"]
|
|
}
|
|
responses:
|
|
'200':
|
|
description: Reference to the password sync group.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '../schemas/PasswordSyncGroup.yaml'
|
|
example:
|
|
{
|
|
"id": "6881f631-3bd5-4213-9c75-8e05cc3e35dd",
|
|
"name": "Password Sync Group 2",
|
|
"passwordPolicyId": "2c91808d744ba0ce01746f93b6204501",
|
|
"sourceIds": ["2c918084660f45d6016617daa9210584", "2c918084660f45d6016617daa9210500"]
|
|
}
|
|
'400':
|
|
$ref: '../responses/400.yaml'
|
|
'401':
|
|
$ref: '../responses/401.yaml'
|
|
'403':
|
|
$ref: '../responses/403.yaml'
|
|
'404':
|
|
$ref: '../responses/404.yaml'
|
|
'429':
|
|
$ref: '../responses/429.yaml'
|
|
'500':
|
|
$ref: '../responses/500.yaml'
|
|
delete:
|
|
operationId: deletePasswordSyncGroup
|
|
tags:
|
|
- Password Sync Groups
|
|
summary: Delete Password Sync Group by ID
|
|
description: >-
|
|
This API deletes the specified password sync group.
|
|
A token with ORG_ADMIN authority is required to call this API.
|
|
security:
|
|
- UserContextAuth: ['idn:password-sync-group-management:write']
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
required: true
|
|
description: The ID of password sync group to delete.
|
|
example: 6881f631-3bd5-4213-9c75-8e05cc3e35dd
|
|
responses:
|
|
'204':
|
|
$ref: '../responses/204.yaml'
|
|
'400':
|
|
$ref: '../responses/400.yaml'
|
|
'401':
|
|
$ref: '../responses/401.yaml'
|
|
'403':
|
|
$ref: '../responses/403.yaml'
|
|
'429':
|
|
$ref: '../responses/429.yaml'
|
|
'500':
|
|
$ref: '../responses/500.yaml'
|
|
|