IDRARestServer.UserResetPassword Method

IDRARestServer UserResetPassword Method

DRA REST Extensions SDK

Resets the password and unlocks a user. User will be required to change password at next logon.
UriTemplate: /dra/domains/{domainFqdn}/users/resetpassword/put

Namespace: NetIQ.DRA.RestServiceLibrary
Assembly: NetIQ.DRA.RestServiceLibrary (in NetIQ.DRA.RestServiceLibrary.dll) Version: 1.1.0.318 (1.1.0.318)

Syntax

C++

Copy to Clipboard Print

[WebInvokeAttribute(Method = "POST", ResponseFormat = WebMessageFormat.Json, 
	RequestFormat = WebMessageFormat.Json, BodyStyle = WebMessageBodyStyle.Wrapped, 
	UriTemplate = "/dra/domains/{domainFqdn}/users/resetpassword/put")]
[OperationContractAttribute]
Stream UserResetPassword(
	string domainFqdn,
	string userIdentifier,
	string domainController,
	User user,
	ConnectionParameters connectionParameters
)

[WebInvokeAttribute(Method = "POST", ResponseFormat = WebMessageFormat.Json, 
	RequestFormat = WebMessageFormat.Json, BodyStyle = WebMessageBodyStyle.Wrapped, 
	UriTemplate = "/dra/domains/{domainFqdn}/users/resetpassword/put")]
[OperationContractAttribute]
Stream UserResetPassword(
	string domainFqdn,
	string userIdentifier,
	string domainController,
	User user,
	ConnectionParameters connectionParameters
)

<WebInvokeAttribute(Method := "POST", ResponseFormat := WebMessageFormat.Json, 
	RequestFormat := WebMessageFormat.Json, BodyStyle := WebMessageBodyStyle.Wrapped, 
	UriTemplate := "/dra/domains/{domainFqdn}/users/resetpassword/put")> 
<OperationContractAttribute> 
Function UserResetPassword ( 
	domainFqdn As String,
	userIdentifier As String,
	domainController As String,
	user As User,
	connectionParameters As ConnectionParameters
) As Stream

<WebInvokeAttribute(Method := "POST", ResponseFormat := WebMessageFormat.Json, 
	RequestFormat := WebMessageFormat.Json, BodyStyle := WebMessageBodyStyle.Wrapped, 
	UriTemplate := "/dra/domains/{domainFqdn}/users/resetpassword/put")> 
<OperationContractAttribute> 
Function UserResetPassword ( 
	domainFqdn As String,
	userIdentifier As String,
	domainController As String,
	user As User,
	connectionParameters As ConnectionParameters
) As Stream

Parameters

domainFqdn: Type: System String
The FQDN of the domain where the user is located

userIdentifier: Type: System String
A string identifying the user. Supported formats are: name or distinguishedName

domainController: Type: System String
Optional. A string identifying a specific domain controller to use for this request.

user: Type: NetIQ.DRA.Common.Rest.DataModels User
A User object containing the password to set.

connectionParameters: Type: NetIQ.DRA.Common.Rest.DataModels ConnectionParameters
Optional ConnectionParameters to specify a DRA server and Assistant Admin credentials

Return Value

Type:

Stream
A RestResponse object containing the operation results. If a password is generated, it is returned in the results.