LiveKit.Grants.SIP (LiveKit v0.1.0)

Copy Markdown View Source

SIP permissions, encoded as the sip claim of a LiveKit JWT.

iex> LiveKit.Grants.to_claims(%LiveKit.Grants.SIP{admin: true})
%{"admin" => true}

admin grants access to all SIP features; call allows placing outbound calls.

Summary

Types

t()

Functions

claim_keys()

Mapping from struct field to LiveKit JWT claim key.

Types

t()

@type t() :: %LiveKit.Grants.SIP{admin: boolean() | nil, call: boolean() | nil}

Functions

claim_keys()

@spec claim_keys() :: %{required(atom()) => String.t()}

Mapping from struct field to LiveKit JWT claim key.

Examples

iex> LiveKit.Grants.SIP.claim_keys()[:call]
"call"