Search Results for

    Show / Hide Table of Contents

    Class TerminologyUserCredentials

    Inheritance
    object
    TerminologyUserCredentials
    Implements
    IEquatable<TerminologyUserCredentials>
    Inherited Members
    object.ToString()
    object.Equals(object, object)
    object.ReferenceEquals(object, object)
    object.GetType()
    Namespace: Sdl.Terminology.TerminologyProvider.Core
    Assembly: Sdl.Terminology.TerminologyProvider.Core.dll
    Syntax
    public sealed class TerminologyUserCredentials : IEquatable<TerminologyUserCredentials>

    Constructors

    TerminologyUserCredentials(string, string, TerminologyUserManagerTokenType)

    Initializes a new instance of the TerminologyUserCredentials class.

    Declaration
    public TerminologyUserCredentials(string userName, string password, TerminologyUserManagerTokenType userType)
    Parameters
    Type Name Description
    string userName
    string password
    TerminologyUserManagerTokenType userType

    TerminologyUserCredentials(string, string, string, DateTime, TerminologyUserManagerTokenType)

    Initializes a new instance of the TerminologyUserCredentials class.

    Declaration
    public TerminologyUserCredentials(string userName, string samlToken, string authToken, DateTime expirationDate, TerminologyUserManagerTokenType userType)
    Parameters
    Type Name Description
    string userName
    string samlToken
    string authToken
    DateTime expirationDate
    TerminologyUserManagerTokenType userType
    Exceptions
    Type Condition
    ArgumentNullException

    Properties

    AuthToken

    Bearer token for REST API calls

    Declaration
    public string AuthToken { get; set; }
    Property Value
    Type Description
    string

    ExpirationDate

    Expiration date of bearer token

    Declaration
    public DateTime ExpirationDate { get; set; }
    Property Value
    Type Description
    DateTime

    HasExpired

    Checks expiration date time of the bearer token

    Declaration
    public bool HasExpired { get; }
    Property Value
    Type Description
    bool

    Password

    the password

    Declaration
    public string Password { get; set; }
    Property Value
    Type Description
    string

    SamlToken

    Saml token for WCF calls

    Declaration
    public string SamlToken { get; set; }
    Property Value
    Type Description
    string

    UserName

    the user name

    Declaration
    public string UserName { get; set; }
    Property Value
    Type Description
    string

    UserType

    the user type

    Declaration
    public TerminologyUserManagerTokenType UserType { get; set; }
    Property Value
    Type Description
    TerminologyUserManagerTokenType

    Methods

    Create(string)

    Creates a new instance of the TerminologyUserCredentials class from a string representation of a user' credentials.

    Declaration
    public static TerminologyUserCredentials Create(string credentialString)
    Parameters
    Type Name Description
    string credentialString

    The string representation of a user's credentials.

    Returns
    Type Description
    TerminologyUserCredentials
    Remarks

    the user credentials string format is as follows:
    user=[USERNAME];pass=[PASSWORD];type=[TYPE]
    If specifying windows or anonymous authentication, the user and pass parameters are not required. The type part is a string representation of the TerminologyUserManagerTokenType.

    Equals(TerminologyUserCredentials)

    Value type equality

    Declaration
    public bool Equals(TerminologyUserCredentials other)
    Parameters
    Type Name Description
    TerminologyUserCredentials other
    Returns
    Type Description
    bool

    Equals(TerminologyUserCredentials, TerminologyUserCredentials)

    value-type equality

    Declaration
    public static bool Equals(TerminologyUserCredentials left, TerminologyUserCredentials right)
    Parameters
    Type Name Description
    TerminologyUserCredentials left
    TerminologyUserCredentials right
    Returns
    Type Description
    bool

    Equals(object)

    value-type equality

    Declaration
    public override bool Equals(object obj)
    Parameters
    Type Name Description
    object obj
    Returns
    Type Description
    bool
    Overrides
    object.Equals(object)

    GetHashCode()

    Unique identifier of an in-memory object

    Declaration
    public override int GetHashCode()
    Returns
    Type Description
    int
    Overrides
    object.GetHashCode()

    Implements

    IEquatable<T>
    In this article
    • Constructors
      • TerminologyUserCredentials(string, string, TerminologyUserManagerTokenType)
      • TerminologyUserCredentials(string, string, string, DateTime, TerminologyUserManagerTokenType)
    • Properties
      • AuthToken
      • ExpirationDate
      • HasExpired
      • Password
      • SamlToken
      • UserName
      • UserType
    • Methods
      • Create(string)
      • Equals(TerminologyUserCredentials)
      • Equals(TerminologyUserCredentials, TerminologyUserCredentials)
      • Equals(object)
      • GetHashCode()
    • Implements
    Back to top Generated by DocFX