PasswordsApi
| Method | HTTP request | Description |
|---|---|---|
| deleteUserPasswordUsingDELETE | DELETE /api/web/v1/users/{userid}/passwords | Delete a user password |
| getUserPasswordSettingsUsingGET | GET /api/web/v1/users/{userid}/settings/password | Gets a user password settings |
| getUserPasswordUsingGET | GET /api/web/v1/users/{userid}/passwords | Gets a user password |
| sendPasswordExpiryNotificationUsingPUT | PUT /api/web/v1/users/{userid}/password/notify | Update and send a password expiry notification |
| setUserPasswordUsingPUT | PUT /api/web/v1/users/{userid}/passwords | Set a user password |
| validateUserPasswordUsingPOST | POST /api/web/v1/users/{userid}/password/validate | Validate user password |
deleteUserPasswordUsingDELETE
deleteUserPasswordUsingDELETE(userid)
Delete a user password
Delete the user's password. Caller requires the USERPASSWORDS:REMOVE permission.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| userid | String | The UUID of the user from which the password will be deleted. |
Return type
null (empty response body)
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful | - |
| 400 | Bad Request | - |
| 401 | Access denied | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
| 409 | Conflict | - |
getUserPasswordSettingsUsingGET
UserPasswordSettings getUserPasswordSettingsUsingGET(userid)
Gets a user password settings
Get password settings information for the specified user. Caller requires the USERPASSWORDS:VIEW permission.
Example
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| userid | String | The UUID of the user whose password settings information is to be fetched. |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful | - |
| 400 | Bad Request | - |
| 401 | Access denied | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
| 409 | Conflict | - |
getUserPasswordUsingGET
UserPassword getUserPasswordUsingGET(userid)
Gets a user password
Get password information for the specified user. Caller requires the USERPASSWORDS:VIEW permission.
Example
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| userid | String | The UUID of the user whose password information is to be fetched. |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful | - |
| 400 | Bad Request | - |
| 401 | Access denied | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
| 409 | Conflict | - |
sendPasswordExpiryNotificationUsingPUT
sendPasswordExpiryNotificationUsingPUT(userid)
Update and send a password expiry notification
Updates and sends a password expiry notification to the specified user. Caller requires the USERPASSWORDS:EDIT permission.
Example
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| userid | String | The UUID of the user to send an expiry notification to. |
Return type
null (empty response body)
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful | - |
| 400 | Bad Request | - |
| 401 | Access denied | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
| 409 | Conflict | - |
setUserPasswordUsingPUT
UserPassword setUserPasswordUsingPUT(userid, userPasswordParms)
Set a user password
Set a user password for the specified user. Caller requires the USERPASSWORDS:EDIT permission.
Example
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| userid | String | The UUID of the user whose password is to be created or modified. | |
| userPasswordParms | UserPasswordParms |
Return type
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: application/json
HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful | - |
| 400 | Bad Request | - |
| 401 | Access denied | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
| 409 | Conflict | - |
validateUserPasswordUsingPOST
UserPasswordValidationResponse validateUserPasswordUsingPOST(userid, userPasswordValidationParms)
Validate user password
Validate user password. Caller requires the USERPASSWORDS:EDIT permission.
Example
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| userid | String | The UUID of the user whose password is to be validated. | |
| userPasswordValidationParms | UserPasswordValidationParms |
Return type
UserPasswordValidationResponse
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: application/json
HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful | - |
| 400 | Bad Request | - |
| 401 | Access denied | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
| 409 | Conflict | - |