Class ClaimsModel

Namespace

Livekit.Server.Sdk.Dotnet

Assembly

LivekitApi.dll

All the claims of an access token, as built by AccessToken and read back by Verify(string).

public class ClaimsModel

Inheritance

object

ClaimsModel

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Properties

Attributes

Participant attributes.

public Dictionary<string, string> Attributes { get; set; }

Property Value

Dictionary<string, string>

Identity

Participant identity (the sub claim).

public string Identity { get; set; }

Property Value

string

Inference

Inference grants, null when the token has none.

public InferenceGrants Inference { get; set; }

Property Value

InferenceGrants

Kind

Kind of participant: standard, egress, ingress, agent or sip.

public string Kind { get; set; }

Property Value

string

Metadata

Participant metadata, visible to the other participants.

public string Metadata { get; set; }

Property Value

string

Name

Display name of the participant.

public string Name { get; set; }

Property Value

string

Observability

Observability grants, null when the token has none.

public ObservabilityGrants Observability { get; set; }

Property Value

ObservabilityGrants

RoomConfig

Room configuration applied when the token creates the room; empty (never null) when not set.

public RoomConfiguration RoomConfig { get; set; }

Property Value

RoomConfiguration

RoomPreset

Room configuration preset applied when the token creates the room.

public string RoomPreset { get; set; }

Property Value

string

Sha256

SHA-256 of the request body, which webhooks use to verify the body.

public string Sha256 { get; set; }

Property Value

string

Sip

SIP grants (the sip claim).

public SIPGrants Sip { get; set; }

Property Value

SIPGrants

Video

Room grants (the video claim).

public VideoGrants Video { get; set; }

Property Value

VideoGrants