Class APIKey

Fields tracked against each API key.

Inheritance

object

APIKey

Implements

IDbEntity

IWMEntity

IPolicyAssignable

IPermissionAssignable

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Quantellia.WMServer.Auth

Assembly: WMServer.dll

Syntax

public class APIKey : IDbEntity, IWMEntity, IPolicyAssignable, IPermissionAssignable

Fields

Active

API key status is active

Declaration

public const string Active = "Active"

Field Value

Type	Description
string

BusinessDevelopment

API access used to support business development

Declaration

public const string BusinessDevelopment = "BusinessDevelopment"

Field Value

Type	Description
string

Cancelled

API key has been suspended because of misuse by license holder

Declaration

public const string Cancelled = "Cancelled"

Field Value

Type	Description
string

Commercial

API used for commercial operations

Declaration

public const string Commercial = "Commercial"

Field Value

Type	Description
string

Developer

API access used by third party developers.

Declaration

public const string Developer = "Developer"

Field Value

Type	Description
string

Evaluation

API access used for evaluation purposes only

Declaration

public const string Evaluation = "Evaluation"

Field Value

Type	Description
string

Internal

For internal company use at Quantellia.

Declaration

public const string Internal = "Internal"

Field Value

Type	Description
string

NotForProfit

API used to support not for profit activities

Declaration

public const string NotForProfit = "NotForProfit"

Field Value

Type	Description
string

SuspendedFinancial

API key has been suspended for non-payment.

Declaration

public const string SuspendedFinancial = "SuspendedFinancial"

Field Value

Type	Description
string

SuspendedGeneral

API key has been suspended for a non-specific reason. (Reason should be described in the Documentation)

Declaration

public const string SuspendedGeneral = "SuspendedGeneral"

Field Value

Type	Description
string

SuspendedMisuse

API key has been suspended because of misuse by license holder

Declaration

public const string SuspendedMisuse = "SuspendedMisuse"

Field Value

Type	Description
string

Properties

APIName

Name of the API product to which this key grants access.

Declaration

public string APIName { get; set; }

Property Value

Type	Description
string

AccessType

Nauture or purpose of the access granted by the API key (e.g., development, businss development, etc.)

Declaration

public string AccessType { get; set; }

Property Value

Type	Description
string

Remarks

Valid values are:

• Internal
• Evaluation
• Developer
• BusinessDevelopment
• Commercial
• NotForProfit

ApplicationName

THe name of the application for which the API key has been issued.

Declaration

public string ApplicationName { get; set; }

Property Value

Type	Description
string

CreatedBy

ID of the user that created this entity.

Declaration

public string CreatedBy { get; set; }

Property Value

Type	Description
string

CreatedDate

Date and time at which this entity was last updated.

Declaration

public DateTime CreatedDate { get; set; }

Property Value

Type	Description
DateTime

Documentation

Miscellaneous documentation for this API Key

Declaration

public string? Documentation { get; set; }

Property Value

Type	Description
string

Endpoint

The World Modeler Server endpoint for which the API key was granted

Declaration

public string Endpoint { get; set; }

Property Value

Type	Description
string

ExpirationDate

Date the API key expires

Declaration

public DateTime ExpirationDate { get; set; }

Property Value

Type	Description
DateTime

ID

Database key of the API key record.

Declaration

public string ID { get; set; }

Property Value

Type	Description
string

IssueDate

Date the API Key was issued

Declaration

public DateTime IssueDate { get; set; }

Property Value

Type	Description
DateTime

IssuedToEmail

Email address of the recipient of the API key

Declaration

public string IssuedToEmail { get; set; }

Property Value

Type	Description
string

Issuer

Organization that issued the API key.

Declaration

public string Issuer { get; set; }

Property Value

Type	Description
string

LastUpdatedBy

ID of the user that last updated this entity.

Declaration

public string LastUpdatedBy { get; set; }

Property Value

Type	Description
string

LastUpdatedDate

Date and time at which this entity was last updated.

Declaration

public DateTime LastUpdatedDate { get; set; }

Property Value

Type	Description
DateTime

Permissions

List of Permission instances associated with this APIKey

Declaration

public virtual List<Permission> Permissions { get; }

Property Value

Type	Description
List<Permission>

Policies

List of Policy instances associated with this APIKey

Declaration

public virtual List<Policy> Policies { get; }

Property Value

Type	Description
List<Policy>

Status

Current status of API Key

Declaration

public string Status { get; set; }

Property Value

Type	Description
string

Remarks

Must be one of the following constants:

Active SuspendedGeneral SuspendedFinancial SuspendedMisuse Cancelled

Implements

IDbEntity

IWMEntity

IPolicyAssignable

IPermissionAssignable