mirror of
https://github.com/LukeHagar/api-specs.git
synced 2025-12-10 04:19:19 +00:00
134 lines
3.8 KiB
YAML
134 lines
3.8 KiB
YAML
get:
|
|
operationId: getPasswordOrgConfig
|
|
tags:
|
|
- Password Configuration
|
|
summary: Get Password Org Config
|
|
description: >-
|
|
This API returns the password org config .
|
|
Requires ORG_ADMIN, API role or authorization scope of 'idn:password-org-config:read'
|
|
security:
|
|
- UserContextAuth: ['idn:password-org-config:read']
|
|
responses:
|
|
'200':
|
|
description: Reference to the password org config.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '../schemas/PasswordOrgConfig.yaml'
|
|
example:
|
|
{
|
|
"customInstructionsEnabled": true,
|
|
"digitTokenDurationMinutes": 9,
|
|
"digitTokenEnabled": false,
|
|
"digitTokenLength": 6
|
|
}
|
|
'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'
|
|
put:
|
|
operationId: putPasswordOrgConfig
|
|
tags:
|
|
- Password Configuration
|
|
summary: Update Password Org Config
|
|
description: >-
|
|
This API updates the password org config for specified fields. Other fields will keep original value.
|
|
|
|
You must set the `customInstructionsEnabled` field to "true" to be able to use custom password instructions.
|
|
|
|
Requires ORG_ADMIN, API role or authorization scope of 'idn:password-org-config:write'
|
|
security:
|
|
- UserContextAuth: ['idn:password-org-config:write']
|
|
requestBody:
|
|
required: true
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '../schemas/PasswordOrgConfig.yaml'
|
|
example:
|
|
{
|
|
"digitTokenEnabled": true,
|
|
"digitTokenDurationMinutes": 12
|
|
}
|
|
responses:
|
|
'200':
|
|
description: Reference to the password org config.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '../schemas/PasswordOrgConfig.yaml'
|
|
example:
|
|
{
|
|
"customInstructionsEnabled": true,
|
|
"digitTokenDurationMinutes": 12,
|
|
"digitTokenEnabled": true,
|
|
"digitTokenLength": 6
|
|
}
|
|
|
|
'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: createPasswordOrgConfig
|
|
tags:
|
|
- Password Configuration
|
|
summary: Create Password Org Config
|
|
description: >-
|
|
This API creates the password org config. Unspecified fields will use default value.
|
|
|
|
To be able to use the custom password instructions, you must set the `customInstructionsEnabled` field to "true".
|
|
|
|
Requires ORG_ADMIN, API role or authorization scope of 'idn:password-org-config:write'
|
|
security:
|
|
- UserContextAuth: [ 'idn:password-org-config:write' ]
|
|
requestBody:
|
|
required: true
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '../schemas/PasswordOrgConfig.yaml'
|
|
example:
|
|
{
|
|
"customInstructionsEnabled": true,
|
|
"digitTokenEnabled": true,
|
|
"digitTokenDurationMinutes": 12,
|
|
"digitTokenLength": 9
|
|
}
|
|
responses:
|
|
'200':
|
|
description: Reference to the password org config.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '../schemas/PasswordOrgConfig.yaml'
|
|
example:
|
|
{
|
|
"customInstructionsEnabled": true,
|
|
"digitTokenDurationMinutes": 9,
|
|
"digitTokenEnabled": true,
|
|
"digitTokenLength": 12
|
|
}
|
|
'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'
|