mirror of
https://github.com/LukeHagar/api-specs.git
synced 2025-12-09 04:19:16 +00:00
9269e86172
* added new oauth2 flow and description * renamed authentication to make more sense' by github action: 5967546682
81 lines
2.4 KiB
YAML
81 lines
2.4 KiB
YAML
get:
|
|
operationId: getPasswordSyncGroups
|
|
tags:
|
|
- Password Sync Groups
|
|
summary: Get Password Sync Group List
|
|
description: >-
|
|
This API returns a list of password sync groups.
|
|
A token with ORG_ADMIN authority is required to call this API.
|
|
security:
|
|
- UserContextAuth: ['idn:password-sync-group-management:read']
|
|
parameters:
|
|
- $ref: '../parameters/limit.yaml'
|
|
- $ref: '../parameters/offset.yaml'
|
|
- $ref: '../parameters/count.yaml'
|
|
responses:
|
|
'200':
|
|
description: A list of password sync groups.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: array
|
|
items:
|
|
$ref: '../schemas/PasswordSyncGroup.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'
|
|
post:
|
|
operationId: createPasswordSyncGroup
|
|
tags:
|
|
- Password Sync Groups
|
|
summary: Create Password Sync Group
|
|
description: >-
|
|
This API creates a password sync group based on the specifications provided.
|
|
A token with ORG_ADMIN authority is required to call this API.
|
|
security:
|
|
- UserContextAuth: ['idn:password-sync-group-management:write']
|
|
requestBody:
|
|
required: true
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '../schemas/PasswordSyncGroup.yaml'
|
|
example:
|
|
{
|
|
"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'
|
|
'429':
|
|
$ref: '../responses/429.yaml'
|
|
'500':
|
|
$ref: '../responses/500.yaml'
|
|
|