Credentials Class

Basic class to create new users, Username/Password authentication

Inheritance Hierarchy

SystemObject
NetQuarry.Web.APICredentials

Namespace: NetQuarry.Web.API
Assembly: EAP.Core (in EAP.Core.dll) Version: 2.0.0.0 (4.6.8.0)

Syntax

public class Credentials : ILogSupport

Public Class Credentials
	Implements ILogSupport

The Credentials type exposes the following members.

Constructors

	Name	Description
	Credentials	Initializes a new instance of the Credentials class

Properties

	Name	Description
	app_version	The version of the application. Should be provided by the caller.
	device_id	The unique identifier for the user's device
	device_os	The device operating system. Android, iOS, Windows, MacOS
	device_token	The permanent device token for the user.
	device_type	The device type name. iPhone 6s, Galaxy 7
	latitude	The latitude when the request is made.
	longitude	The longitude when the request is made.
	os_version	The device operating system version (9.0.4)
	password	The user's password to authenticate this application to act on the user's behalf.
	user_id	The user's account ID. Commonly the email address with which they signed up.
	user_roles	The list of user roles. Typically these are obtained from the AuthenticationRolesView (default for which is the users_roles table).

Methods

	Name	Description
	Authenticate	Authenticates the user and returns the user context object.
	Clone	Creates a duplicate object.
	Equals	Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
	Finalize	Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection. (Inherited from Object.)
	GetHashCode	Serves as a hash function for a particular type. (Inherited from Object.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	PasswordLogValue	Obfuscate a password to a form appropriate for logging to the API log.
	ToString	Returns a String that represents the current Object. (Inherited from Object.)
	Unauthenticate	Unauthenticates the user (deletes their authenticated device token).

Extension Methods

	Name	Description
	EqualValue	Determines if the object value is equal to another object. If the two objects are null, then this returns true. There is special handling for guid comparisons (since a guid could be a string formatted in up to 3 different ways). If the special guid handling is not performed, then the object.Equals method is used. (Defined by EAPUtil.)