@fluidframework/azure-service-utils Package

Packages > @fluidframework/azure-service-utils

A set of helper utilities for building backend APIs for use with Azure Fluid Relay.

Enumerations

List of enums contained in this package or namespace
Enumeration Description
ScopeType

Functions

List of functions contained in this package or namespace
Function Description
generateToken(tenantId, documentId, key, scopes, user, lifetime, ver) Generates a JWT token to authorize routerlicious. This function uses a browser friendly auth library (jsrsasign) and should only be used in client context.

Enumerations

ScopeType enum

Signature:

export declare enum ScopeType 

Enumeration Members

List of members in use in this enum
Member Value Description
DocRead "doc:read"
DocWrite "doc:write"
SummaryWrite "summary:write"

Functions

generateToken

Generates a JWT token to authorize routerlicious. This function uses a browser friendly auth library (jsrsasign) and should only be used in client context.

Signature:

export declare function generateToken(tenantId: string, documentId: string, key: string, scopes: ScopeType[], user?: IUser, lifetime?: number, ver?: string): string;

Parameters

List of parameters
Parameter Type Description
tenantId
documentId
key
scopes ScopeType
user
lifetime
ver

Returns: