Class Token

A token.

Inheritance

System.Object

Token

Namespace: FM.LiveSwitch

Assembly: FM.LiveSwitch.dll

Syntax

public class Token : object

Properties

Algorithm

Gets the algorithm.

Declaration

public string Algorithm { get; }

Property Value

Type	Description
System.String

ApiServiceId

Gets the API Service identifier.

Declaration

public string ApiServiceId { get; }

Property Value

Type	Description
System.String

ApplicationId

Gets the application identifier.

Declaration

public string ApplicationId { get; }

Property Value

Type	Description
System.String

ChannelClaim

Gets the first channel claim.

Declaration

public ChannelClaim ChannelClaim { get; }

Property Value

Type	Description
ChannelClaim

ChannelClaims

Gets an array of channel claims.

Declaration

public ChannelClaim[] ChannelClaims { get; }

Property Value

Type	Description
ChannelClaim[]

ClientId

Gets the client identifier.

Declaration

public string ClientId { get; }

Property Value

Type	Description
System.String

ClientRoles

Gets the client roles.

Declaration

public string[] ClientRoles { get; }

Property Value

Type	Description
System.String[]

ConnectorId

Gets the Connector identifier.

Declaration

public string ConnectorId { get; }

Property Value

Type	Description
System.String

DefaultExpiry

Gets the default token expiry (120 seconds).

Declaration

public static int DefaultExpiry { get; }

Property Value

Type	Description
System.Int32

DeviceId

Gets the device identifier.

Declaration

public string DeviceId { get; }

Property Value

Type	Description
System.String

ExpirationTime

Gets the "expires at" date/time.

Declaration

public DateTime? ExpirationTime { get; }

Property Value

Type	Description
System.Nullable<DateTime>

HmacSha256Algorithm

Gets the HMAC SHA-256 algorithm string.

Declaration

public static string HmacSha256Algorithm { get; }

Property Value

Type	Description
System.String

IssuedAt

Gets the "issued at" date/time.

Declaration

public DateTime IssuedAt { get; }

Property Value

Type	Description
DateTime

MediaServerId

Gets the Media Server identifier.

Declaration

public string MediaServerId { get; }

Property Value

Type	Description
System.String

RecordingMonitorId

Gets the Recording Monitor identifier.

Declaration

public string RecordingMonitorId { get; }

Property Value

Type	Description
System.String

RecordingMoverId

Gets the Recording Mover identifier.

Declaration

public string RecordingMoverId { get; }

Property Value

Type	Description
System.String

RecordingMuxerId

Gets the Recording Muxer identifier.

Declaration

public string RecordingMuxerId { get; }

Property Value

Type	Description
System.String

Region

Gets the region.

Declaration

public string Region { get; }

Property Value

Type	Description
System.String

RsaSha256Algorithm

Gets the RSA SHA-256 algorithm string.

Declaration

public static string RsaSha256Algorithm { get; }

Property Value

Type	Description
System.String

Type

Gets the type.

Declaration

public string Type { get; }

Property Value

Type	Description
System.String

UserId

Gets the user identifier.

Declaration

public string UserId { get; }

Property Value

Type	Description
System.String

WebSocketMediaServerId

Gets the Web Socket Media Server identifier.

Declaration

public string WebSocketMediaServerId { get; }

Property Value

Type	Description
System.String

Methods

GenerateClientJoinToken(Client, ChannelClaim, String)

Generates a signed client join token.

Declaration

public static string GenerateClientJoinToken(Client client, ChannelClaim channelClaim, string sharedSecret)

Parameters

Type	Name	Description
Client	client	The client.
ChannelClaim	channelClaim	The channel claim.
System.String	sharedSecret	The shared secret.

Returns

Type	Description
System.String

GenerateClientJoinToken(Client, ChannelClaim, String, DateTime)

Generates a signed client join token.

Declaration

public static string GenerateClientJoinToken(Client client, ChannelClaim channelClaim, string sharedSecret, DateTime expirationTime)

Parameters

Type	Name	Description
Client	client	The client.
ChannelClaim	channelClaim	The channel claim.
System.String	sharedSecret	The shared secret.
DateTime	expirationTime	The time the token will expire in UTC.

Returns

Type	Description
System.String

GenerateClientJoinToken(Client, String, String)

Generates a signed client join token.

Declaration

public static string GenerateClientJoinToken(Client client, string channelId, string sharedSecret)

Parameters

Type	Name	Description
Client	client	The client.
System.String	channelId	The channel identifier.
System.String	sharedSecret	The shared secret.

Returns

Type	Description
System.String

GenerateClientJoinToken(Client, String, String, DateTime)

Generates a signed client join token.

Declaration

public static string GenerateClientJoinToken(Client client, string channelId, string sharedSecret, DateTime expirationTime)

Parameters

Type	Name	Description
Client	client	The client.
System.String	channelId	The channel identifier.
System.String	sharedSecret	The shared secret.
DateTime	expirationTime	The time the token will expire in UTC.

Returns

Type	Description
System.String

GenerateClientJoinToken(String, String, String, String, ChannelClaim, String)

Generates a signed client join token.

Declaration

public static string GenerateClientJoinToken(string applicationId, string userId, string deviceId, string clientId, ChannelClaim channelClaim, string sharedSecret)

Parameters

Type	Name	Description
System.String	applicationId	The application identifier.
System.String	userId	The user identifier.
System.String	deviceId	The device identifier.
System.String	clientId	The client identifier.
ChannelClaim	channelClaim	The channel claim.
System.String	sharedSecret	The shared secret.

Returns

Type	Description
System.String

GenerateClientJoinToken(String, String, String, String, ChannelClaim, String, DateTime)

Generates a signed client join token.

Declaration

public static string GenerateClientJoinToken(string applicationId, string userId, string deviceId, string clientId, ChannelClaim channelClaim, string sharedSecret, DateTime expirationTime)

Parameters

Type	Name	Description
System.String	applicationId	The application identifier.
System.String	userId	The user identifier.
System.String	deviceId	The device identifier.
System.String	clientId	The client identifier.
ChannelClaim	channelClaim	The channel claim.
System.String	sharedSecret	The shared secret.
DateTime	expirationTime	The time the token will expire in UTC.

Returns

Type	Description
System.String

GenerateClientJoinToken(String, String, String, String, String, String)

Generates a signed client join token.

Declaration

public static string GenerateClientJoinToken(string applicationId, string userId, string deviceId, string clientId, string channelId, string sharedSecret)

Parameters

Type	Name	Description
System.String	applicationId	The application identifier.
System.String	userId	The user identifier.
System.String	deviceId	The device identifier.
System.String	clientId	The client identifier.
System.String	channelId	The channel identifier.
System.String	sharedSecret	The shared secret.

Returns

Type	Description
System.String

GenerateClientJoinToken(String, String, String, String, String, String, DateTime)

Generates a signed client join token.

Declaration

public static string GenerateClientJoinToken(string applicationId, string userId, string deviceId, string clientId, string channelId, string sharedSecret, DateTime expirationTime)

Parameters

Type	Name	Description
System.String	applicationId	The application identifier.
System.String	userId	The user identifier.
System.String	deviceId	The device identifier.
System.String	clientId	The client identifier.
System.String	channelId	The channel identifier.
System.String	sharedSecret	The shared secret.
DateTime	expirationTime	The time the token will expire in UTC.

Returns

Type	Description
System.String

GenerateClientRegisterToken(Client, ChannelClaim[], String)

Generates a signed client register token.

Declaration

public static string GenerateClientRegisterToken(Client client, ChannelClaim[] channelClaims, string sharedSecret)

Parameters

Type	Name	Description
Client	client	The client.
ChannelClaim[]	channelClaims	The channel claims.
System.String	sharedSecret	The shared secret.

Returns

Type	Description
System.String

GenerateClientRegisterToken(Client, ChannelClaim[], String, DateTime)

Generates a signed client register token.

Declaration

public static string GenerateClientRegisterToken(Client client, ChannelClaim[] channelClaims, string sharedSecret, DateTime expirationTime)

Parameters

Type	Name	Description
Client	client	The client.
ChannelClaim[]	channelClaims	The channel claims.
System.String	sharedSecret	The shared secret.
DateTime	expirationTime	The time the token will expire in UTC.

Returns

Type	Description
System.String

GenerateClientRegisterToken(Client, ChannelClaim[], String, DateTime, String)

Generates a signed client register token.

Declaration

public static string GenerateClientRegisterToken(Client client, ChannelClaim[] channelClaims, string sharedSecret, DateTime expirationTime, string region)

Parameters

Type	Name	Description
Client	client	The client.
ChannelClaim[]	channelClaims	The channel claims.
System.String	sharedSecret	The shared secret.
DateTime	expirationTime	The time the token will expire in UTC.
System.String	region	The region of the client.

Returns

Type	Description
System.String

GenerateClientRegisterToken(Client, ChannelClaim[], String, String)

Generates a signed client register token.

Declaration

public static string GenerateClientRegisterToken(Client client, ChannelClaim[] channelClaims, string sharedSecret, string region)

Parameters

Type	Name	Description
Client	client	The client.
ChannelClaim[]	channelClaims	The channel claims.
System.String	sharedSecret	The shared secret.
System.String	region	The region of the client.

Returns

Type	Description
System.String

GenerateClientRegisterToken(Client, String, String)

Generates a signed client register token.

Declaration

public static string GenerateClientRegisterToken(Client client, string channelId, string sharedSecret)

Parameters

Type	Name	Description
Client	client	The client.
System.String	channelId	The channel identifier.
System.String	sharedSecret	The shared secret.

Returns

Type	Description
System.String

GenerateClientRegisterToken(Client, String, String, DateTime)

Generates a signed client register token.

Declaration

public static string GenerateClientRegisterToken(Client client, string channelId, string sharedSecret, DateTime expirationTime)

Parameters

Type	Name	Description
Client	client	The client.
System.String	channelId	The channel identifier.
System.String	sharedSecret	The shared secret.
DateTime	expirationTime	The time the token will expire in UTC.

Returns

Type	Description
System.String

GenerateClientRegisterToken(Client, String, String, DateTime, String)

Generates a signed client register token.

Declaration

public static string GenerateClientRegisterToken(Client client, string channelId, string sharedSecret, DateTime expirationTime, string region)

Parameters

Type	Name	Description
Client	client	The client.
System.String	channelId	The channel identifier.
System.String	sharedSecret	The shared secret.
DateTime	expirationTime	The time the token will expire in UTC.
System.String	region	The region of the client.

Returns

Type	Description
System.String

GenerateClientRegisterToken(Client, String, String, String)

Generates a signed client register token.

Declaration

public static string GenerateClientRegisterToken(Client client, string channelId, string sharedSecret, string region)

Parameters

Type	Name	Description
Client	client	The client.
System.String	channelId	The channel identifier.
System.String	sharedSecret	The shared secret.
System.String	region	The region of the client.

Returns

Type	Description
System.String

GenerateClientRegisterToken(Client, String[], String)

Generates a signed client register token.

Declaration

public static string GenerateClientRegisterToken(Client client, string[] channelIds, string sharedSecret)

Parameters

Type	Name	Description
Client	client	The client.
System.String[]	channelIds	The channel identifiers.
System.String	sharedSecret	The shared secret.

Returns

Type	Description
System.String

GenerateClientRegisterToken(Client, String[], String, DateTime)

Generates a signed client register token.

Declaration

public static string GenerateClientRegisterToken(Client client, string[] channelIds, string sharedSecret, DateTime expirationTime)

Parameters

Type	Name	Description
Client	client	The client.
System.String[]	channelIds	The channel identifiers.
System.String	sharedSecret	The shared secret.
DateTime	expirationTime	The time the token will expire in UTC.

Returns

Type	Description
System.String

GenerateClientRegisterToken(Client, String[], String, DateTime, String)

Generates a signed client register token.

Declaration

public static string GenerateClientRegisterToken(Client client, string[] channelIds, string sharedSecret, DateTime expirationTime, string region)

Parameters

Type	Name	Description
Client	client	The client.
System.String[]	channelIds	The channel identifiers.
System.String	sharedSecret	The shared secret.
DateTime	expirationTime	The time the token will expire in UTC.
System.String	region	The region of the client.

Returns

Type	Description
System.String

GenerateClientRegisterToken(Client, String[], String, String)

Generates a signed client register token.

Declaration

public static string GenerateClientRegisterToken(Client client, string[] channelIds, string sharedSecret, string region)

Parameters

Type	Name	Description
Client	client	The client.
System.String[]	channelIds	The channel identifiers.
System.String	sharedSecret	The shared secret.
System.String	region	The region of the client.

Returns

Type	Description
System.String

GenerateClientRegisterToken(String, String, String, String, ChannelClaim[], String)

Generates a signed client register token.

Declaration

public static string GenerateClientRegisterToken(string applicationId, string userId, string deviceId, string clientId, ChannelClaim[] channelClaims, string sharedSecret)

Parameters

Type	Name	Description
System.String	applicationId	The application identifier.
System.String	userId	The user identifier.
System.String	deviceId	The device identifier.
System.String	clientId	The client identifier.
ChannelClaim[]	channelClaims	The channel claims.
System.String	sharedSecret	The shared secret.

Returns

Type	Description
System.String

GenerateClientRegisterToken(String, String, String, String, String[], ChannelClaim[], String)

Generates a signed client register token.

Declaration

public static string GenerateClientRegisterToken(string applicationId, string userId, string deviceId, string clientId, string[] clientRoles, ChannelClaim[] channelClaims, string sharedSecret)

Parameters

Type	Name	Description
System.String	applicationId	The application identifier.
System.String	userId	The user identifier.
System.String	deviceId	The device identifier.
System.String	clientId	The client identifier.
System.String[]	clientRoles	The client roles.
ChannelClaim[]	channelClaims	The channel claims.
System.String	sharedSecret	The shared secret.

Returns

Type	Description
System.String

GenerateClientRegisterToken(String, String, String, String, String[], ChannelClaim[], String, DateTime)

Generates a signed client register token.

Declaration

public static string GenerateClientRegisterToken(string applicationId, string userId, string deviceId, string clientId, string[] clientRoles, ChannelClaim[] channelClaims, string sharedSecret, DateTime expirationTime)

Parameters

Type	Name	Description
System.String	applicationId	The application identifier.
System.String	userId	The user identifier.
System.String	deviceId	The device identifier.
System.String	clientId	The client identifier.
System.String[]	clientRoles	The client roles.
ChannelClaim[]	channelClaims	The channel claims.
System.String	sharedSecret	The shared secret.
DateTime	expirationTime	The time the token will expire in UTC.

Returns

Type	Description
System.String

GenerateClientRegisterToken(String, String, String, String, String[], ChannelClaim[], String, DateTime, String)

Generates a signed client register token.

Declaration

public static string GenerateClientRegisterToken(string applicationId, string userId, string deviceId, string clientId, string[] clientRoles, ChannelClaim[] channelClaims, string sharedSecret, DateTime expirationTime, string region)

Parameters

Type	Name	Description
System.String	applicationId	The application identifier.
System.String	userId	The user identifier.
System.String	deviceId	The device identifier.
System.String	clientId	The client identifier.
System.String[]	clientRoles	The client roles.
ChannelClaim[]	channelClaims	The channel claims.
System.String	sharedSecret	The shared secret.
DateTime	expirationTime	The time the token will expire in UTC.
System.String	region	The region of the client.

Returns

Type	Description
System.String

GenerateClientRegisterToken(String, String, String, String, String[], ChannelClaim[], String, String)

Generates a signed client register token.

Declaration

public static string GenerateClientRegisterToken(string applicationId, string userId, string deviceId, string clientId, string[] clientRoles, ChannelClaim[] channelClaims, string sharedSecret, string region)

Parameters

Type	Name	Description
System.String	applicationId	The application identifier.
System.String	userId	The user identifier.
System.String	deviceId	The device identifier.
System.String	clientId	The client identifier.
System.String[]	clientRoles	The client roles.
ChannelClaim[]	channelClaims	The channel claims.
System.String	sharedSecret	The shared secret.
System.String	region	The region of the client.

Returns

Type	Description
System.String

GenerateClientRegisterToken(String, String, String, String, String[], String, String)

Generates a signed client register token.

Declaration

public static string GenerateClientRegisterToken(string applicationId, string userId, string deviceId, string clientId, string[] clientRoles, string channelId, string sharedSecret)

Parameters

Type	Name	Description
System.String	applicationId	The application identifier.
System.String	userId	The user identifier.
System.String	deviceId	The device identifier.
System.String	clientId	The client identifier.
System.String[]	clientRoles	The client roles.
System.String	channelId	The channel identifier.
System.String	sharedSecret	The shared secret.

Returns

Type	Description
System.String

GenerateClientRegisterToken(String, String, String, String, String[], String, String, DateTime)

Generates a signed client register token.

Declaration

public static string GenerateClientRegisterToken(string applicationId, string userId, string deviceId, string clientId, string[] clientRoles, string channelId, string sharedSecret, DateTime expirationTime)

Parameters

Type	Name	Description
System.String	applicationId	The application identifier.
System.String	userId	The user identifier.
System.String	deviceId	The device identifier.
System.String	clientId	The client identifier.
System.String[]	clientRoles	The client roles.
System.String	channelId	The channel identifier.
System.String	sharedSecret	The shared secret.
DateTime	expirationTime	The time the token will expire in UTC.

Returns

Type	Description
System.String

GenerateClientRegisterToken(String, String, String, String, String[], String, String, DateTime, String)

Generates a signed client register token.

Declaration

public static string GenerateClientRegisterToken(string applicationId, string userId, string deviceId, string clientId, string[] clientRoles, string channelId, string sharedSecret, DateTime expirationTime, string region)

Parameters

Type	Name	Description
System.String	applicationId	The application identifier.
System.String	userId	The user identifier.
System.String	deviceId	The device identifier.
System.String	clientId	The client identifier.
System.String[]	clientRoles	The client roles.
System.String	channelId	The channel identifier.
System.String	sharedSecret	The shared secret.
DateTime	expirationTime	The time the token will expire in UTC.
System.String	region	The region of the client.

Returns

Type	Description
System.String

GenerateClientRegisterToken(String, String, String, String, String[], String, String, String)

Generates a signed client register token.

Declaration

public static string GenerateClientRegisterToken(string applicationId, string userId, string deviceId, string clientId, string[] clientRoles, string channelId, string sharedSecret, string region)

Parameters

Type	Name	Description
System.String	applicationId	The application identifier.
System.String	userId	The user identifier.
System.String	deviceId	The device identifier.
System.String	clientId	The client identifier.
System.String[]	clientRoles	The client roles.
System.String	channelId	The channel identifier.
System.String	sharedSecret	The shared secret.
System.String	region	The region of the client.

Returns

Type	Description
System.String

GenerateClientRegisterToken(String, String, String, String, String[], String[], String)

Generates a signed client register token.

Declaration

public static string GenerateClientRegisterToken(string applicationId, string userId, string deviceId, string clientId, string[] clientRoles, string[] channelIds, string sharedSecret)

Parameters

Type	Name	Description
System.String	applicationId	The application identifier.
System.String	userId	The user identifier.
System.String	deviceId	The device identifier.
System.String	clientId	The client identifier.
System.String[]	clientRoles	The client roles.
System.String[]	channelIds	The channel identifiers.
System.String	sharedSecret	The shared secret.

Returns

Type	Description
System.String

GenerateClientRegisterToken(String, String, String, String, String[], String[], String, DateTime)

Generates a signed client register token.

Declaration

public static string GenerateClientRegisterToken(string applicationId, string userId, string deviceId, string clientId, string[] clientRoles, string[] channelIds, string sharedSecret, DateTime expirationTime)

Parameters

Type	Name	Description
System.String	applicationId	The application identifier.
System.String	userId	The user identifier.
System.String	deviceId	The device identifier.
System.String	clientId	The client identifier.
System.String[]	clientRoles	The client roles.
System.String[]	channelIds	The channel identifiers.
System.String	sharedSecret	The shared secret.
DateTime	expirationTime	The time the token will expire in UTC.

Returns

Type	Description
System.String

GenerateClientRegisterToken(String, String, String, String, String[], String[], String, DateTime, String)

Generates a signed client register token.

Declaration

public static string GenerateClientRegisterToken(string applicationId, string userId, string deviceId, string clientId, string[] clientRoles, string[] channelIds, string sharedSecret, DateTime expirationTime, string region)

Parameters

Type	Name	Description
System.String	applicationId	The application identifier.
System.String	userId	The user identifier.
System.String	deviceId	The device identifier.
System.String	clientId	The client identifier.
System.String[]	clientRoles	The client roles.
System.String[]	channelIds	The channel identifiers.
System.String	sharedSecret	The shared secret.
DateTime	expirationTime	The time the token will expire in UTC.
System.String	region	The region of the client.

Returns

Type	Description
System.String

GenerateClientRegisterToken(String, String, String, String, String[], String[], String, String)

Generates a signed client register token.

Declaration

public static string GenerateClientRegisterToken(string applicationId, string userId, string deviceId, string clientId, string[] clientRoles, string[] channelIds, string sharedSecret, string region)

Parameters

Type	Name	Description
System.String	applicationId	The application identifier.
System.String	userId	The user identifier.
System.String	deviceId	The device identifier.
System.String	clientId	The client identifier.
System.String[]	clientRoles	The client roles.
System.String[]	channelIds	The channel identifiers.
System.String	sharedSecret	The shared secret.
System.String	region	The region of the client.

Returns

Type	Description
System.String

GenerateClientWebSocketAccessToken(String, String, String, String, String)

Generates a signed client websocket access token.

Declaration

public static string GenerateClientWebSocketAccessToken(string applicationId, string userId, string deviceId, string clientId, string sharedSecret)

Parameters

Type	Name	Description
System.String	applicationId
System.String	userId
System.String	deviceId
System.String	clientId
System.String	sharedSecret

Returns

Type	Description
System.String

GenerateEventToken(String, String)

Generates a signed event token.

Declaration

public static string GenerateEventToken(string applicationId, string sharedSecret)

Parameters

Type	Name	Description
System.String	applicationId	The application identifier.
System.String	sharedSecret	The shared secret.

Returns

Type	Description
System.String

GenerateEventToken(String, String, DateTime)

Generates a signed event token.

Declaration

public static string GenerateEventToken(string applicationId, string sharedSecret, DateTime expirationTime)

Parameters

Type	Name	Description
System.String	applicationId	The application identifier.
System.String	sharedSecret	The shared secret.
DateTime	expirationTime	The expiration time.

Returns

Type	Description
System.String

Parse(String)

Parses a token string.

Declaration

public static Token Parse(string tokenString)

Parameters

Type	Name	Description
System.String	tokenString	The token string.

Returns

Type	Description
Token	The token.

Verify(String)

Verifies the token signature.

Declaration

public bool Verify(string sharedSecret)

Parameters

Type	Name	Description
System.String	sharedSecret	The shared secret.

Returns

Type	Description
System.Boolean	true if the signature is valid; otherwise, false.

Verify(String, String)

Parses a token and verifies its signature.

Declaration

public static bool Verify(string tokenString, string sharedSecret)

Parameters

Type	Name	Description
System.String	tokenString	The token string.
System.String	sharedSecret	The shared secret.

Returns

Type	Description
System.Boolean	true if the token string could be parsed and the signature is valid; otherwise, false