mirror of
https://github.com/LukeHagar/api-specs.git
synced 2025-12-09 20:37:50 +00:00
100 lines
3.2 KiB
YAML
100 lines
3.2 KiB
YAML
get:
|
|
operationId: getCustomPasswordInstructions
|
|
tags:
|
|
- Custom Password Instructions
|
|
summary: Get Custom Password Instructions by Page ID
|
|
description: >-
|
|
This API returns the custom password instructions for the specified page ID.
|
|
A token with ORG_ADMIN authority is required to call this API.
|
|
parameters:
|
|
- in: path
|
|
name: pageId
|
|
schema:
|
|
type: string
|
|
enum:
|
|
- change-password:enter-password
|
|
- change-password:finish
|
|
- flow-selection:select
|
|
- forget-username:user-email
|
|
- mfa:enter-code
|
|
- mfa:enter-kba
|
|
- mfa:select
|
|
- reset-password:enter-password
|
|
- reset-password:enter-username
|
|
- reset-password:finish
|
|
- unlock-account:enter-username
|
|
- unlock-account:finish
|
|
required: true
|
|
description: The page ID of custom password instructions to query.
|
|
example: mfa:select
|
|
- in: query
|
|
name: locale
|
|
schema:
|
|
type: string
|
|
description: The locale for the custom instructions, a BCP47 language tag. The default value is \"default\".
|
|
responses:
|
|
'200':
|
|
description: Reference to the custom password instructions.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '../schemas/CustomPasswordInstruction.yaml'
|
|
example:
|
|
{
|
|
"pageId": "reset-password:enter-password",
|
|
"locale": "default",
|
|
"pageContent": "See company password policies for details by clicking <a href=\"url\">here</a>"
|
|
}
|
|
'400':
|
|
$ref: '../../v3/responses/400.yaml'
|
|
'403':
|
|
$ref: '../../v3/responses/403.yaml'
|
|
'404':
|
|
$ref: '../../v3/responses/404.yaml'
|
|
'500':
|
|
$ref: '../../v3/responses/500.yaml'
|
|
delete:
|
|
operationId: deleteCustomPasswordInstructions
|
|
tags:
|
|
- Custom Password Instructions
|
|
summary: Delete Custom Password Instructions by page ID
|
|
description: >-
|
|
This API delete the custom password instructions for the specified page ID.
|
|
A token with ORG_ADMIN authority is required to call this API.
|
|
parameters:
|
|
- in: path
|
|
name: pageId
|
|
schema:
|
|
type: string
|
|
enum:
|
|
- change-password:enter-password
|
|
- change-password:finish
|
|
- flow-selection:select
|
|
- forget-username:user-email
|
|
- mfa:enter-code
|
|
- mfa:enter-kba
|
|
- mfa:select
|
|
- reset-password:enter-password
|
|
- reset-password:enter-username
|
|
- reset-password:finish
|
|
- unlock-account:enter-username
|
|
- unlock-account:finish
|
|
required: true
|
|
description: The page ID of custom password instructions to delete.
|
|
example: mfa:select
|
|
- in: query
|
|
name: locale
|
|
schema:
|
|
type: string
|
|
description: The locale for the custom instructions, a BCP47 language tag. The default value is \"default\".
|
|
responses:
|
|
'204':
|
|
$ref: '../../v3/responses/204.yaml'
|
|
'400':
|
|
$ref: '../../v3/responses/400.yaml'
|
|
'403':
|
|
$ref: '../../v3/responses/403.yaml'
|
|
'404':
|
|
$ref: '../../v3/responses/404.yaml'
|
|
'500':
|
|
$ref: '../../v3/responses/500.yaml' |