Files
developer.sailpoint.com/static/api-specs/idn/v3/paths/query-password-info.yaml
2022-10-18 20:45:01 +00:00

39 lines
1.4 KiB
YAML

post:
operationId: queryPasswordInfo
tags:
- Password Management
summary: Query Password Info
# security:
# - oauth2: [API]
description: |
This API is used to query password related information.
A token with [API authority](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)
is required to call this API. "API authority" refers to a token that only has the "client_credentials"
grant type, and therefore no user context. A [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)
or a token generated with the [authorization_code](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)
grant type will **NOT** work on this endpoint, and a `403 Forbidden` response
will be returned.
requestBody:
required: true
content:
application/json:
schema:
$ref: '../schemas/PasswordInfoQueryDTO.yaml'
responses:
'200':
description: Reference to the password info.
content:
application/json:
schema:
$ref: '../schemas/PasswordInfo.yaml'
'400':
$ref: '../../v3/responses/400.yaml'
'401':
$ref: '../../v3/responses/401.yaml'
'403':
$ref: '../../v3/responses/403.yaml'
'429':
$ref: '../../v3/responses/429.yaml'
'500':
$ref: '../../v3/responses/500.yaml'