Files
api-specs/idn/beta/paths/custom-password-instructions.yaml
2022-09-02 10:59:29 -04:00

37 lines
1.2 KiB
YAML

post:
operationId: createCustomPasswordInstructions
tags:
- Custom Password Instructions
summary: Create Custom Password Instructions
description: >-
This API creates the custom password instructions for the specified page ID.
A token with ORG_ADMIN authority is required to call this API.
requestBody:
required: true
content:
application/json:
schema:
$ref: '../schemas/CustomPasswordInstruction.yaml'
example: {
"pageId": "reset-password:enter-password",
"pageContent": "See company password policies for details by clicking <a href=\"url\">here</a>"
}
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'
'500':
$ref: '../../v3/responses/500.yaml'