TokenResponse Interface
Represents token response
To use, import via @fluidframework/odsp-driver-definitions/legacy.
For more information about our API support guarantees, see here.
Signature
export interface TokenResponse
Properties
| Property | Alerts | Modifiers | Type | Description |
|---|---|---|---|---|
| authorizationHeader | Alpha |
optional, readonly |
string | Authorization header value will be used verbatim when making network call that requires the token. If not provided, the token value will be assumed to be a Bearer token and will be used to generate the Authorization header value in the following format: Bearer ${token}. |
| fromCache | Alpha |
optional |
boolean | Whether or not the token was obtained from local cache. |
| token | Alpha |
string | Token value |
Property Details
authorizationHeader
Authorization header value will be used verbatim when making network call that requires the token. If not provided, the token value will be assumed to be a Bearer token and will be used to generate the Authorization header value in the following format: Bearer ${token}.
To use, import via @fluidframework/odsp-driver-definitions/alpha.
For more information about our API support guarantees, see here.
Signature
readonly authorizationHeader?: string;
Type: string
fromCache
Whether or not the token was obtained from local cache.
To use, import via @fluidframework/odsp-driver-definitions/alpha.
For more information about our API support guarantees, see here.
Signature
fromCache?: boolean;
Type: boolean
Remarks
undefined indicates that it could not be determined whether or not the token was obtained this way.
token
Token value
To use, import via @fluidframework/odsp-driver-definitions/alpha.
For more information about our API support guarantees, see here.
Signature
token: string;
Type: string