Class AccessToken

The claims of a LiveKit access token: a JWT signed with HS256 by an API secret, whose issuer is the API key.

Inheritance
object
AccessToken
Implements
Inherited Members
Namespace: Uniform.LiveKit.Protocol
Assembly: Uniform.LiveKit.Protocol.dll
Syntax
public sealed record AccessToken : IEquatable<AccessToken>

Properties

| Edit this page View Source

Expires

End of validity, in Unix seconds.

Declaration
[JsonPropertyName("exp")]
public long Expires { get; init; }
Property Value
Type Description
long
| Edit this page View Source

Identity

The participant's identity, unique in a room.

Declaration
[JsonPropertyName("sub")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
public string? Identity { get; init; }
Property Value
Type Description
string
| Edit this page View Source

Issuer

The API key, which tells LiveKit which secret signed the token.

Declaration
[JsonPropertyName("iss")]
public string Issuer { get; init; }
Property Value
Type Description
string
| Edit this page View Source

Name

Shown name of the participant.

Declaration
[JsonPropertyName("name")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
public string? Name { get; init; }
Property Value
Type Description
string
| Edit this page View Source

NotBefore

Start of validity, in Unix seconds.

Declaration
[JsonPropertyName("nbf")]
public long NotBefore { get; init; }
Property Value
Type Description
long
| Edit this page View Source

Video

The room permissions.

Declaration
[JsonPropertyName("video")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
public VideoGrant? Video { get; init; }
Property Value
Type Description
VideoGrant

Methods

| Edit this page View Source

Create(string, string?, VideoGrant, DateTimeOffset, TimeSpan)

Create claims for identity valid from now for lifetime.

Declaration
public static AccessToken Create(string apiKey, string? identity, VideoGrant video, DateTimeOffset now, TimeSpan lifetime)
Parameters
Type Name Description
string apiKey
string identity
VideoGrant video
DateTimeOffset now
TimeSpan lifetime
Returns
Type Description
AccessToken
| Edit this page View Source

Sign(string)

Return the claims as a JWT signed with apiSecret.

Declaration
public string Sign(string apiSecret)
Parameters
Type Name Description
string apiSecret
Returns
Type Description
string
| Edit this page View Source

TryRead(string, string, DateTimeOffset, out AccessToken?)

Read a JWT signed with HS256 by apiSecret and valid at now; return false for a bad signature, format or time.

Declaration
public static bool TryRead(string token, string apiSecret, DateTimeOffset now, out AccessToken? claims)
Parameters
Type Name Description
string token
string apiSecret
DateTimeOffset now
AccessToken claims
Returns
Type Description
bool

Implements