.NET: UserAuth - Devolens (formerly Cryptolens) Documentation

Methods that perform operations on a user object. A complete list can be found here: UserAuth Namespace: SKM.V3.Methods
Version: 4.0.54. Both packages; all six documented target frameworks.

public class UserAuth

Public Class UserAuth

These methods return a result object. Check Result == ResultType.Success before using its data. In version 4.0.54, handled request and JSON errors normally return ResultType.Error with a diagnostic Message. A non-null result alone does not mean the request succeeded. See Request Errors.

Constructors

UserAuth()

Creates an empty UserAuth object. This constructor does not send an API request.

public UserAuth()

Public Sub New()

Methods

Associate(string, AssociateUserModel)

Associates a user with a customer object.

public static BasicResult Associate(string token, AssociateUserModel parameters)

Public Shared Function Associate(token As String, parameters As AssociateUserModel) As BasicResult

Web API Reference Parameters

Name	Type	Description
`token`	`string`	This method can be called with an access token that has UserAuthAdmin permission. More info: Auth
`parameters`	`AssociateUserModel`	Parameters of the method.

Returns: BasicResult. The API response. Check Result and Message before using the returned data.

ChangePassword(string, ChangePasswordModel)

This method will change the password of a user. It supports 3 modes of operation. With an access token that has UserAuthNormal permission (i.e. without admin permission), the password can either be changed by providing the old password or a password reset token, which can be generated using Reset Password Token method. Finally, if you call this method with an access token that has UserAuthAdmin permission, it will allow you to set AdminMode to True and only provide the NewPassword.

public static BasicResult ChangePassword(string token, ChangePasswordModel parameters)

Public Shared Function ChangePassword(token As String, parameters As ChangePasswordModel) As BasicResult

Web API Reference Parameters

Name	Type	Description
`token`	`string`	This method can be called with an access token that has UserAuthNormal or UserAuthAdmin permission. More info: Auth
`parameters`	`ChangePasswordModel`	Parameters of the method.

Returns: BasicResult. The API response. Check Result and Message before using the returned data.

Dissociate(string, DissociateModel)

Dissociates a user from a customer customer object.

public static BasicResult Dissociate(string token, DissociateModel parameters)

Public Shared Function Dissociate(token As String, parameters As DissociateModel) As BasicResult

Web API Reference Parameters

Name	Type	Description
`token`	`string`	This method can be called with an access token that has UserAuthAdmin permission. More info: Auth
`parameters`	`DissociateModel`	Parameters of the method.

Returns: BasicResult. The API response. Check Result and Message before using the returned data.

GetUsers(string, GetUsersModel)

List all registered users.

public static GetUsersResult GetUsers(string token, GetUsersModel parameters)

Public Shared Function GetUsers(token As String, parameters As GetUsersModel) As GetUsersResult

Web API Reference Parameters

Name	Type	Description
`token`	`string`	This method can be called with an access token that has UserAuthAdmin permission. More info: Auth
`parameters`	`GetUsersModel`	Parameters of the method.

Returns: GetUsersResult. The API response. Check Result and Message before using the returned data. This method will return all licenses that belong to the user.

public static LoginUserResult Login(string token, LoginUserModel parameters)

Public Shared Function Login(token As String, parameters As LoginUserModel) As LoginUserResult

Web API Reference Parameters

Name	Type	Description
`token`	`string`	This method can be called with an access token that has UserAuthNormal and UserAuthAdmin permission. More info: Auth
`parameters`	`LoginUserModel`	Parameters of the method.

Returns: LoginUserResult. The API response. Check Result and Message before using the returned data.

Register(string, RegisterUserModel)

This method will register a new user.

public static BasicResult Register(string token, RegisterUserModel parameters)

Public Shared Function Register(token As String, parameters As RegisterUserModel) As BasicResult

Web API Reference Parameters

Name	Type	Description
`token`	`string`	This method can be called with an access token that has UserAuthAdmin permission. More info: Auth
`parameters`	`RegisterUserModel`	Parameters of the method.

Returns: BasicResult. The API response. Check Result and Message before using the returned data.

RemoveUser(string, RemoveUserModel)

This method removes a user.

public static BasicResult RemoveUser(string token, RemoveUserModel parameters)

Public Shared Function RemoveUser(token As String, parameters As RemoveUserModel) As BasicResult

Web API Reference Parameters

Name	Type	Description
`token`	`string`	This method can be called with an access token that has UserAuthAdmin permission. More info: Auth
`parameters`	`RemoveUserModel`	Parameters of the method.

Returns: BasicResult. The API response. Check Result and Message before using the returned data.

ResetPasswordToken(string, ResetPasswordModel)

This method allows you to retrive the password reset token that you can use when calling Change Password method.

public static ResetPasswordResult ResetPasswordToken(string token, ResetPasswordModel parameters)

Public Shared Function ResetPasswordToken(token As String, parameters As ResetPasswordModel) As ResetPasswordResult

Web API Reference Parameters

Name	Type	Description
`token`	`string`	This method can be called with an access token that has UserAuthAdmin permission. More info: Auth
`parameters`	`ResetPasswordModel`	Parameters of the method.

Returns: ResetPasswordResult. The API response. Check Result and Message before using the returned data. .NET SDK Reference · Reviewed Source Revision

​Constructors

​UserAuth()

​Methods

​Associate(string, AssociateUserModel)

​ChangePassword(string, ChangePasswordModel)

​Dissociate(string, DissociateModel)

​GetUsers(string, GetUsersModel)

​Login(string, LoginUserModel)

​Register(string, RegisterUserModel)

​RemoveUser(string, RemoveUserModel)

​ResetPasswordToken(string, ResetPasswordModel)

Constructors

UserAuth()

Methods

Associate(string, AssociateUserModel)

ChangePassword(string, ChangePasswordModel)

Dissociate(string, DissociateModel)

GetUsers(string, GetUsersModel)

Login(string, LoginUserModel)

Register(string, RegisterUserModel)

RemoveUser(string, RemoveUserModel)

ResetPasswordToken(string, ResetPasswordModel)