ITokenClaims Interface
JSON Web Token (JWT) Claims
See https://datatracker.ietf.org/doc/html/rfc7519#section-4
To use, import via @fluidframework/driver-definitions/legacy.
For more information about our API support guarantees, see here.
Signature
export interface ITokenClaims
Properties
| Property | Alerts | Modifiers | Type | Description |
|---|---|---|---|---|
| documentId | Alpha |
string | Identifies the document (a.k.a container) for which the token is being generated. Generated by the service. | |
| exp | Alpha |
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 | Alpha |
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 | Alpha |
optional |
string |
"JWT ID" A unique identifier for the token. See https://datatracker.ietf.org/doc/html/rfc7519#section-4.1.7 |
| scopes | Alpha |
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 | Alpha |
string | Unique tenant identifier. | |
| user | Alpha |
IUser | User for whom the token was created. | |
| ver | Alpha |
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.
To use, import via @fluidframework/driver-definitions/alpha.
For more information about our API support guarantees, see here.
Signature
documentId: string;
Type: 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
To use, import via @fluidframework/driver-definitions/alpha.
For more information about our API support guarantees, see here.
Signature
exp: number;
Type: 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
To use, import via @fluidframework/driver-definitions/alpha.
For more information about our API support guarantees, see here.
Signature
iat: number;
Type: number
jti
"JWT ID" A unique identifier for the token.
See https://datatracker.ietf.org/doc/html/rfc7519#section-4.1.7
To use, import via @fluidframework/driver-definitions/alpha.
For more information about our API support guarantees, see here.
Signature
jti?: string;
Type: 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.
To use, import via @fluidframework/driver-definitions/alpha.
For more information about our API support guarantees, see here.
Signature
scopes: string[];
Type: string[]
tenantId
Unique tenant identifier.
To use, import via @fluidframework/driver-definitions/alpha.
For more information about our API support guarantees, see here.
Signature
tenantId: string;
Type: string
user
User for whom the token was created.
To use, import via @fluidframework/driver-definitions/alpha.
For more information about our API support guarantees, see here.
Signature
user: IUser;
Type: IUser
ver
"Version" Version of the access token.
To use, import via @fluidframework/driver-definitions/alpha.
For more information about our API support guarantees, see here.
Signature
ver: string;
Type: string