mirror of
https://github.com/LukeHagar/api-specs.git
synced 2025-12-09 20:37:50 +00:00
60 lines
2.5 KiB
YAML
60 lines
2.5 KiB
YAML
post:
|
|
operationId: syncPassword
|
|
tags:
|
|
- Password
|
|
summary: Sync Identity's Password
|
|
# security:
|
|
# - oauth2: [API]
|
|
description: This API is reserved for password interceptor (PWI) to initiate a password change request for all sources in the sync group EXCEPT the source specified from the PasswordChangeRequest payload. To sync password for all sources in a source group, use set-password instead. The password can only be synced by a trusted API client application.
|
|
requestBody:
|
|
required: true
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '../schemas/SyncPasswordRequest.yaml'
|
|
example: {
|
|
"identityId": "2c918085744fec4301746f9a5bce4605",
|
|
"encryptedPassword": "GIAP7TaAg7Y2EJtFojokBDvHQ/iXF3qk0z0+eLusqXMSkEhAfr34GydFLy+BM2uZB94cwbTYKi9rRrCRRdh8610VeqpRDjhuc28nOPYqTJOx09IGJdr8dl4mbhC1f21JCqMBBrFSA4VQQvd6OMVsceoXTjDI0aKahRYNjlMlsOuaIUZeNQxWBydLuR6vYG3qAKEPCzYZbvyYuBUylUWArfqwV4dgwKGDgDkTLBkQU9LVu3rssc+BXaex6l6JcBDiPg7wvKD1G3lZ+BaGrMknbx3j0T2Uivg+HxwTf7PmtAua6O9M7F984c79KM+sYFTU37MAdlWZu/cy+w2DdHVdCg==",
|
|
"publicKeyId": "YWQ2NjQ4MTItZjY0NC00MWExLWFjMjktOGNmMzU3Y2VlNjk2",
|
|
"accountId": "CN=Abby Smith,OU=Austin,OU=Americas,OU=Demo,DC=seri,DC=acme,DC=com",
|
|
"sourceId": "8a807d4c73c545510173c545d4b60246",
|
|
"uuid":"{ad9fc391-246d-40af-b248-b6556a2b7c01}",
|
|
"retryCount": "0",
|
|
"host": "host1.example.net",
|
|
"passwordSyncTime": "2021-01-08T18:46:56+00:00",
|
|
"pwiType": "AD",
|
|
"pwiVersion": "20.0.0",
|
|
"passwordChangeTime": "2021-01-08T18:45:50+00:00"
|
|
}
|
|
responses:
|
|
'202':
|
|
description: Reference to the password change.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '../schemas/PasswordChangeResponse.yaml'
|
|
examples:
|
|
Password sync is in progress:
|
|
value:
|
|
{
|
|
"state": "IN_PROGRESS",
|
|
"requestId": "089899f13a8f4da7824996191587bab9",
|
|
}
|
|
Password sync is finshed:
|
|
value:
|
|
{
|
|
"state": "FINISHED",
|
|
"identityRequestId": null,
|
|
}
|
|
'204':
|
|
description: No content - Indicates there is no processing for the PWI request.
|
|
content:
|
|
application/json: {}
|
|
'400':
|
|
$ref: '../../v3/responses/400.yaml'
|
|
'401':
|
|
$ref: '../../v3/responses/401.yaml'
|
|
'403':
|
|
$ref: '../../v3/responses/403.yaml'
|
|
'500':
|
|
$ref: '../../v3/responses/500.yaml' |