Password
Download OpenAPI Specification: Download
For more information about Postman collections, forking, and making your first API call, refer to the Working with Boomi APIs on Postman page.
Validates a password set link using the provided key
Validates password set link and returns user information for password setup.
Authorizations:
ApiKeyBearer
query Parameters
| key | string <uuid> Unique identifier for the password set operation |
Responses
Response Schema:
| key | string <uuid> |
| mfaEnabled | boolean |
| username | string or null |
| password | string or null |
| confirmPassword | string or null |
Response samples
- 200
- 400
- 500
Content type
No sample
Sets a new password using the validated password set link
Sets new password for user account using validated password set link.
Authorizations:
ApiKeyBearer
Request Body schema:
Password model containing the key, new password, and confirmation
| key | string <uuid> |
| mfaEnabled | boolean |
| username | string or null |
| password | string or null |
| confirmPassword | string or null |
Responses
Response Schema:
string
Request samples
- Payload
Content type
{- "key": "4adfe27e-63d3-45b9-8238-62b6ed6fdb5e",
- "mfaEnabled": true,
- "username": "string",
- "password": "string",
- "confirmPassword": "string"
}Response samples
- 200
- 400
- 500
Content type
No sample
Validates a password reset link using the provided key
Validates password reset link and returns user information for password reset.
Authorizations:
ApiKeyBearer
query Parameters
| key | string <uuid> Unique identifier for the password reset operation |
Responses
Response Schema:
| key | string <uuid> |
| mfaEnabled | boolean |
| username | string or null |
| password | string or null |
| confirmPassword | string or null |
Response samples
- 200
- 400
- 500
Content type
No sample
Resets a password using the validated password reset link
Resets user password using validated password reset link.
Authorizations:
ApiKeyBearer
Request Body schema:
Password model containing the key, new password, and confirmation
| key | string <uuid> |
| mfaEnabled | boolean |
| username | string or null |
| password | string or null |
| confirmPassword | string or null |
Responses
Response Schema:
string
Request samples
- Payload
Content type
{- "key": "4adfe27e-63d3-45b9-8238-62b6ed6fdb5e",
- "mfaEnabled": true,
- "username": "string",
- "password": "string",
- "confirmPassword": "string"
}Response samples
- 200
- 400
- 500
Content type
No sample
Was this topic helpful?
