Table of Contents

Class LocalToken

Namespace
OverKizApi.Models
Assembly
OverKizApi.dll

Descriptor for a local gateway API token generated via GenerateLocalToken(string) and activated with ActivateLocalToken(string, string, string, string).

public sealed class LocalToken
Inheritance
LocalToken
Inherited Members

Properties

ExpirationTime

Unix epoch millisecond timestamp when this token expires, or null if it does not expire.

[JsonPropertyName("expirationTime")]
[JsonNumberHandling(JsonNumberHandling.AllowReadingFromString)]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
public long? ExpirationTime { get; init; }

Property Value

long?

Unix epoch millisecond timestamp when this token expires, or null if it does not expire.

GatewayCreationTime

Unix epoch millisecond timestamp recorded when the gateway was created.

[JsonPropertyName("gatewayCreationTime")]
[JsonNumberHandling(JsonNumberHandling.AllowReadingFromString)]
public long GatewayCreationTime { get; init; }

Property Value

long

Unix epoch millisecond timestamp recorded when the gateway was created.

GatewayId

Serial number of the gateway this token is bound to.

[JsonPropertyName("gatewayId")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
public string? GatewayId { get; init; }

Property Value

string

Serial number of the gateway this token is bound to.

Label

User-assigned label for this token.

[JsonPropertyName("label")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
public string? Label { get; init; }

Property Value

string

User-assigned label for this token.

Scope

Access scope granted by this token (e.g. "devmode").

[JsonPropertyName("scope")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
public string? Scope { get; init; }

Property Value

string

Access scope granted by this token (e.g. "devmode").

Uuid

UUID that uniquely identifies this token; required when deleting via DeleteLocalToken(string, string).

[JsonPropertyName("uuid")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
public string? Uuid { get; init; }

Property Value

string

UUID that uniquely identifies this token; required when deleting via DeleteLocalToken(string, string).