ITokenClaims Interface

See https://datatracker.ietf.org/doc/html/rfc7519#section-4

Signature

export interface ITokenClaims

Properties

Property	Modifiers	Type	Description
documentId		string	Identifies the document (a.k.a container) for which the token is being generated. Generated by the service.
exp		number	"Expiration Time" Identifies the expiration time on or after which the token must not be accepted for processing. Expressed in Unix Time. See https://datatracker.ietf.org/doc/html/rfc7519#section-4.1.4
iat		number	"Issued At" Indicates when the authentication for this token occurred. Expressed in Unix Time. See https://datatracker.ietf.org/doc/html/rfc7519#section-4.1.6
jti	`optional`	string	"JWT ID" A unique identifier for the token. See https://datatracker.ietf.org/doc/html/rfc7519#section-4.1.7
scopes		string[]	Identifies the permissions required by the client on the document or summary. For every scope, you can define the permissions you want to give to the client.
tenantId		string	Unique tenant identifier.
user		IUser	User for whom the token was created.
ver		string	"Version" Version of the access token.

Property Details

documentId

Identifies the document (a.k.a container) for which the token is being generated. Generated by the service.

Signature

documentId: string;

exp

“Expiration Time” Identifies the expiration time on or after which the token must not be accepted for processing. Expressed in Unix Time .

See https://datatracker.ietf.org/doc/html/rfc7519#section-4.1.4

Signature

exp: number;

iat

“Issued At” Indicates when the authentication for this token occurred. Expressed in Unix Time .

See https://datatracker.ietf.org/doc/html/rfc7519#section-4.1.6

Signature

iat: number;

jti

“JWT ID” A unique identifier for the token.

See https://datatracker.ietf.org/doc/html/rfc7519#section-4.1.7

Signature

jti?: string;

scopes

Identifies the permissions required by the client on the document or summary. For every scope, you can define the permissions you want to give to the client.

Signature

scopes: string[];

tenantId

Unique tenant identifier.

Signature

tenantId: string;

user

User for whom the token was created.

Signature

user: IUser;

ver

“Version” Version of the access token.

Signature

ver: string;