Avaya Client Services API Reference (Windows)
Avaya Client Services API Reference (Windows)
Avaya.ClientServices
UserCredential Class
UserCredential Constructor
UserCredential Properties
UserCredential Methods

# UserCredential Class

Represents a user credential that can be used to respond to an authentication credential challenge.
Inheritance Hierarchy
System
Object
Avaya.ClientServices
UserCredential

Namespace: Avaya.ClientServices
Assembly: AvayaClientServices (in AvayaClientServices.dll) Version: 550.0.60.0
Syntax
C#
Copy

    public class UserCredential

The UserCredential type exposes the following members.

Constructors

| Name | Description
--- | --- | ---
| UserCredential(String) | Constructor of UserCredential with Portal User Token.
| UserCredential(String, DateTime) | Constructor of UserCredential with Access token and Credential Expiry.
| UserCredential(String, String) | Constructor of UserCredential with Username and Password.
| UserCredential(String, String, DateTime) | Constructor of UserCredential with Username, Password and Credential Expiry.
| UserCredential(String, String, String) | Constructor of UserCredential with Username, Password and Domain.
| UserCredential(String, String, String, DateTime) | Constructor of UserCredential with Username, Password , Domain and Credential Expiry.
| UserCredential(String, String, String, String) | Constructor of UserCredential with Username, Password, Domain and HA1String.
| UserCredential(String, String, String, String, DateTime) | Constructor of UserCredential with Username, Password, Domain ,HA1String and CrdentialExpiry.
| UserCredential(String, String, String, String, String) | Constructor of UserCredential with Username, Password, Domain, HA1String, AuthToken and State
| UserCredential(String, String, String, String, String, DateTime) | Constructor of UserCredential with Username, Password, Domain, HA1String, AuthToken and Credential Expiry

Top
Properties

| Name | Description
--- | --- | ---
| AccessToken | Authorization Token string of the credential
| CredentialExpiry | The time until which the token is valid.
| Domain | The domain for the credential (empty string if n/a).
| HA1String | The HA1String for the credential (empty string if n/a).
| Password | The password for the credential (empty string if n/a).
| PortalUserToken | The Portal User Token of the credential (empty string if n/a).
| Username | The username for the credential.

Top
Methods

| Name | Description
--- | --- | ---
| CreateUserCredential | Construct a UserCredential using access token
| Equals | (Overrides Object Equals(Object).)
| GetHashCode | (Overrides Object GetHashCode .)

Top
Remarks
Credentials may consist of username, password, HA1 String and domain information.Depending on the system configuration, some of the parameters may not be available or applicable for a particular credential.For example, some credential may be made up of username and password only.In such case, the domain and HA1 String will be just empty strings.In some other configurations(e.g., for SIP authentication), the HA1 String and the username are the only user credential information available from the configuration server for a user.In such case, the user credential will have empty strings for password and domain. This interface includes all of the convenient methods for constructing a UserCredential.
See Also

#### Reference

Avaya.ClientServices Namespace

© 2017 Avaya LLC. All Rights Reserved.