PasswordsApi

Method	HTTP request	Description
DeleteUserNamedPasswordUsingDELETE	DELETE /api/web/v1/users/{userid}/passwords/{namedpasswordid}	Delete a user password using the password ID
DeleteUserPasswordUsingDELETE	DELETE /api/web/v1/users/{userid}/passwords	Delete a user password
GetUserNamedPasswordSettingsUsingGET	GET /api/web/v1/users/{userid}/settings/password/{namedpasswordid}	Get user password authenticator settings by named password ID
GetUserNamedPasswordsUsingGET	GET /api/web/v1/users/{userid}/list/passwords	Gets a list of user passwords
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
SendUserNamedPasswordExpiryNotificationUsingPUT	PUT /api/web/v1/users/{userid}/password/{namedpasswordid}/notify	Update and send a password expiry notification using password ID
SetUserPasswordUsingPUT	PUT /api/web/v1/users/{userid}/passwords	Set a user password
ValidateUserPasswordUsingPOST	POST /api/web/v1/users/{userid}/password/validate	Validate user password

DeleteUserNamedPasswordUsingDELETE

void DeleteUserNamedPasswordUsingDELETE (string userid, string namedpasswordid)

Delete a user password using the password ID

Delete the user's password. Caller requires the USERPASSWORDS:REMOVE permission.

Using the DeleteUserNamedPasswordUsingDELETEWithHttpInfo variant

This returns an ApiResponse object which contains the response data, status code and headers.

Parameters

Name	Type	Description	Notes
userid	string	The UUID of the user from which the password will be deleted.
namedpasswordid	string

Return type

void (empty response body)

Authorization

AdminAPIAuthentication

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	-

DeleteUserPasswordUsingDELETE

void DeleteUserPasswordUsingDELETE (string userid)

Delete a user password

Delete the user's password. Caller requires the USERPASSWORDS:REMOVE permission.

Example

Using the DeleteUserPasswordUsingDELETEWithHttpInfo variant

This returns an ApiResponse object which contains the response data, status code and headers.

Parameters

Name	Type	Description	Notes
userid	string	The UUID of the user from which the password will be deleted.

Return type

void (empty response body)

Authorization

AdminAPIAuthentication

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	-

GetUserNamedPasswordSettingsUsingGET

UserPasswordSettings GetUserNamedPasswordSettingsUsingGET (string userid, string namedpasswordid)

Get user password authenticator settings by named password ID

Get password settings information for the specified user. Caller requires the USERPASSWORDS:VIEW permission.

Example

Using the GetUserNamedPasswordSettingsUsingGETWithHttpInfo variant

This returns an ApiResponse object which contains the response data, status code and headers.

Parameters

Name	Type	Description	Notes
userid	string	The UUID of the user whose password settings information is to be fetched.
namedpasswordid	string	The named password ID whose password settings information is to be fetched.

Return type

UserPasswordSettings

Authorization

AdminAPIAuthentication

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	-

GetUserNamedPasswordsUsingGET

List<UserPassword> GetUserNamedPasswordsUsingGET (string userid)

Gets a list of user passwords

Get password information for the specified user. Caller requires the USERPASSWORDS:VIEW permission.

Example

Using the GetUserNamedPasswordsUsingGETWithHttpInfo variant

This returns an ApiResponse object which contains the response data, status code and headers.

Parameters

Name	Type	Description	Notes
userid	string	The UUID of the user whose password information is to be fetched.

Return type

List<UserPassword>

Authorization

AdminAPIAuthentication

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 (string userid)

Gets a user password settings

Get password settings information for the specified user. Caller requires the USERPASSWORDS:VIEW permission.

Example

Using the GetUserPasswordSettingsUsingGETWithHttpInfo variant

This returns an ApiResponse object which contains the response data, status code and headers.

Parameters

Name	Type	Description	Notes
userid	string	The UUID of the user whose password settings information is to be fetched.

Return type

UserPasswordSettings

Authorization

AdminAPIAuthentication

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 (string userid)

Gets a user password

Get password information for the specified user. Caller requires the USERPASSWORDS:VIEW permission.

Example

Using the GetUserPasswordUsingGETWithHttpInfo variant

This returns an ApiResponse object which contains the response data, status code and headers.

Parameters

Name	Type	Description	Notes
userid	string	The UUID of the user whose password information is to be fetched.

Return type

UserPassword

Authorization

AdminAPIAuthentication

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

void SendPasswordExpiryNotificationUsingPUT (string 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

Using the SendPasswordExpiryNotificationUsingPUTWithHttpInfo variant

This returns an ApiResponse object which contains the response data, status code and headers.

Parameters

Name	Type	Description	Notes
userid	string	The UUID of the user to send an expiry notification to.

Return type

void (empty response body)

Authorization

AdminAPIAuthentication

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	-

SendUserNamedPasswordExpiryNotificationUsingPUT

void SendUserNamedPasswordExpiryNotificationUsingPUT (string userid, string namedpasswordid)

Update and send a password expiry notification using password ID

Updates and sends a password expiry notification to the specified user. Caller requires the USERPASSWORDS:EDIT permission.

Example

Using the SendUserNamedPasswordExpiryNotificationUsingPUTWithHttpInfo variant

This returns an ApiResponse object which contains the response data, status code and headers.

Parameters

Name	Type	Description	Notes
userid	string	The UUID of the user to send an expiry notification to.
namedpasswordid	string

Return type

void (empty response body)

Authorization

AdminAPIAuthentication

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 (string userid, UserPasswordParms userPasswordParms)

Set a user password

Set a user password for the specified user. Caller requires the USERPASSWORDS:EDIT permission.

Example

Using the SetUserPasswordUsingPUTWithHttpInfo variant

This returns an ApiResponse object which contains the response data, status code and headers.

Parameters

Name	Type	Description	Notes
userid	string	The UUID of the user whose password is to be created or modified.
userPasswordParms	UserPasswordParms

Return type

UserPassword

Authorization

AdminAPIAuthentication

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 (string userid, UserPasswordValidationParms userPasswordValidationParms)

Validate user password

Validate user password. Caller requires the USERPASSWORDS:EDIT permission.

Example

Using the ValidateUserPasswordUsingPOSTWithHttpInfo variant

This returns an ApiResponse object which contains the response data, status code and headers.

Parameters

Name	Type	Description	Notes
userid	string	The UUID of the user whose password is to be validated.
userPasswordValidationParms	UserPasswordValidationParms

Return type

UserPasswordValidationResponse

Authorization

AdminAPIAuthentication

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	-