Class UserSecret

• Defined in File UserSecret.cs

Inheritance Relationships

Base Type

• public xbe.sdk.EntityBase (Class EntityBase)

Class Documentation

class xbe.sdk.Models.UserSecret : xbe.sdk.EntityBase

Provides a single method of authentication for a given user. A user may have multiple secrets tied to their user account. This makes it possible to handle multiple types of authentication methods such as password, two-step authentication, pre-shared key and more.

REQUIRES: Account Services

Public Functions

UserSecret ()

UserSecret (Object obj)

Properties

Guid UserId { get; set; }

The universally unique identifier of the user account associated with the secret.

string Type { get; set; }

The type of secret that is being stored.

string Secret { get; set; }

The underlying secret that is being stored.

Public Static Functions

new UserSecret Parse (string json)

Parses the given JSON encoded string into a new UserSecret instance.

Param json:

Return:

Public Static Attributes

const string TYPE_APIKEY = "apikey"

An special alpha-numeric plain text secret used by external applications and services.

const string TYPE_DEVICE = "device"

A deterministic unique device hash or password used for frictionless device login.

const string TYPE_MFA = "mfa"

A multi-factor authentication token used to strengthen the security of existing secrets. There can only be one secret of this type per user.

const string TYPE_MFA_BACKUP = "mfabackup"

When mfa is used a series of mfabackup secrets are made as a one-time use recovery password.

const string TYPE_PASSWORD = "password"

A simple alpha-numeric plain text password. There can only one secret of this type per user.