Defender 5.11 - Administration Guide

RemoveTokenFromUser method

Unassigns a Defender token from a user.

C# syntax
[OperationContract]
[FaultContract(typeof(FaultException))]
AssignedToken RemoveTokenFromUser(string userCommonName, string tokenCommonName, bool deleteSoftwareToken, string userSearchBase, string tokenSearchBase);

Parameters

• userCommonName  Common name of the user whose tokens are to be unassigned.
• tokenCommonName  Common name of the token that is to be unassigned.
• deleteSorfwareToken  If true, then Defender Software tokens are removed from the directory and from the user.
• userSearchBase  Optional parameter to specify base container in which to search for users.
• tokenSearchBase  Optional parameter to specify base container in which to search for tokens.

Return value

A successful unassignment results in an AssignedToken being returned. If the token was already unassigned, then the AssignedToken.TokenCommonName indicates this. In the case of an error a Fault is generated.

The faultCode can be one of the following:

• ArgumentOutOfRange  One of the arguments was invalid, further details are contained in the faultstring.
• UnknownFault  Any other error, further details may be included in the faultstring.

ResetDefenderToken method

Resets a Defender token to aid authentication when the token is out of synchronization with the server.

C# syntax
[OperationContract]
[FaultContract(typeof(FaultException))]
DefenderResult ResetDefenderToken(string tokenCommonName, string tokenSearchBase);

Parameters

• tokenCommonName  Common name of the token to reset.
• tokenSearchBase  Optional parameter to specify base container in which to search for tokens.

Return value

A DefenderResult is returned indicating the success or otherwise of the reset. In the case of an error a Fault is generated.

The faultCode can be one of the following:

• ArgumentOutOfRange  One of the arguments was invalid, further details are contained in the faultstring.
• UnknownFault  Any other error, further details may be included in the faultstring.

ResetDefenderViolationCount method

Reset a user's Defender violation count. Also allows the violation and reset counts to be viewed without resetting them.

C# syntax
[OperationContract]
[FaultContract(typeof(FaultException))]
UserViolationCount ResetDefenderViolationCount(string userCommonName, bool viewOnly, string userSearchBase);

Parameters

• userCommonName  Common name of the user whose violation count is to be reset.
• viewOnly  If true, then the violation count and reset count are returned but not adjusted.
• userSearchBase  Optional parameter to specify base container in which to search for users.

Return value

Successfull calls return a UserViolationCount. In the case of an error, a Fault is generated.

The faultCode can be one of the following:

• ArgumentOutOfRange  One of the arguments was invalid, further details are contained in the faultstring.
• UnknownFault  Any other error, further details may be included in the faultstring.

SetDefenderPassword method

Sets the Defender password for a user or all users in a group. When a user account name is specified, that user's Defender password is set. When a group name is specified, the Defender passwords for all users in that group are assigned the specified Defender password.

C# syntax
[OperationContract]
[FaultContract(typeof(FaultException))]
void SetDefenderPassword(string userGroupCommonName, string password, bool expire, bool overwrite, string userSearchBase);

Parameters

• userGroupCommonName  Common name of the user or group of users to which the Defender password is to be set.
• password  The Defender password to set.
• expire  Sets the Defender password to the expired state.
• overwrite  Overwrites an existing Defender Password. By default, an existing Defender password cannot be overwritten.
• userSearchBase  Optional parameter to specify base container in which to search for users.

Return value

In the case of an error, a Fault is generated. The faultCode can be one of the following:

• ArgumentOutOfRange  One of the arguments was invalid, further details are contained in the faultstring.
• UnknownFault  Any other error, further details may be included in the faultstring.