mirror of
https://github.com/LukeHagar/api-specs.git
synced 2025-12-09 04:19:16 +00:00
62 lines
2.6 KiB
YAML
62 lines
2.6 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'
|
|
example: {
|
|
"userName":"Abby.Smith",
|
|
"sourceName": "My-AD"
|
|
}
|
|
responses:
|
|
'200':
|
|
description: Reference to the password info.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '../schemas/PasswordInfo.yaml'
|
|
example:
|
|
{
|
|
"identityId": "2c918085744fec4301746f9a5bce4611",
|
|
"sourceId": "2c918083746f642c01746f9908840111",
|
|
"publicKeyId": "N2M1OTJiMGEtMDJlZS00ZWU3LTkyYTEtNjA5YmI5NWE3ZWVA",
|
|
"publicKey": "AIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAuGFkWi2J75TztpbaPKd36bJnIB3J8gZ6UcoS9oSDYsqBzPpTsfZXYaEf4Y4BKGgJIXmE/lwhwuj7mU1itdZ2qTSNFtnXA8Fn75c3UUkk+h+wdZbkuSmqlsJo3R1OnJkwkJggcAy9Jvk9jlcrNLWorpQ1w9raUvxtvfgkSdq153KxotenQ1HciSyZ0nA/Kw0UaucLnho8xdRowZs11afXGXA9IT9H6D8T6zUdtSxm0nAyH+mluma5LdTfaM50W3l/L8q56Vrqmx2pZIiwdx/0+g3Y++jV70zom0ZBkC1MmSoLMrQYG5OICNjr72f78B2PaGXfarQHqARLjKpMVt9YIQIDAQAB",
|
|
"accounts": [
|
|
{
|
|
"accountId": "CN=Abby Smith,OU=Austin,OU=Americas,OU=Demo,DC=seri,DC=acme,DC=com",
|
|
"accountName": "Abby.Smith"
|
|
}
|
|
],
|
|
"policies": [
|
|
"passwordRepeatedChar is 3",
|
|
"passwordMinAlpha is 1",
|
|
"passwordMinLength is 5",
|
|
"passwordMinNumeric is 1"
|
|
]
|
|
}
|
|
'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' |