Type alias ServerAuthorizationTokenResponse

ServerAuthorizationTokenResponse: {
    access_token?: string;
    claims?: string;
    client_info?: string;
    correlation_id?: string;
    error?: string;
    error_codes?: string[];
    error_description?: string;
    expires_in?: number;
    ext_expires_in?: number;
    foci?: string;
    id_token?: string;
    key_id?: string;
    refresh_in?: number;
    refresh_token?: string;
    scope?: string;
    spa_accountid?: string;
    spa_code?: string;
    status?: number;
    suberror?: string;
    timestamp?: string;
    token_type?: AuthenticationScheme;
    trace_id?: string;
}

Deserialized response object from server authorization code request.

  • token_type: Indicates the token type value. Can be either Bearer or pop.
  • scope: The scopes that the access_token is valid for.
  • expires_in: How long the access token is valid (in seconds).
  • refresh_in: Duration afer which a token should be renewed, regardless of expiration.
  • ext_expires_in: How long the access token is valid (in seconds) if the server isn't responding.
  • access_token: The requested access token. The app can use this token to authenticate to the secured resource, such as a web API.
  • refresh_token: An OAuth 2.0 refresh token. The app can use this token acquire additional access tokens after the current access token expires.
  • id_token: A JSON Web Token (JWT). The app can decode the segments of this token to request information about the user who signed in.
  • key_id: A string that uniquely identifies a public key that the request is bound to.

In case of error:

  • error: An error code string that can be used to classify types of errors that occur, and can be used to react to errors.
  • error_description: A specific error message that can help a developer identify the root cause of an authentication error.
  • error_codes: A list of STS-specific error codes that can help in diagnostics.
  • timestamp: The time at which the error occurred.
  • trace_id: A unique identifier for the request that can help in diagnostics.
  • correlation_id: A unique identifier for the request that can help in diagnostics across components.
  • status: the network request's response status

Type declaration

  • Optional access_token?: string
  • Optional claims?: string
  • Optional client_info?: string
  • Optional correlation_id?: string
  • Optional error?: string
  • Optional error_codes?: string[]
  • Optional error_description?: string
  • Optional expires_in?: number
  • Optional ext_expires_in?: number
  • Optional foci?: string
  • Optional id_token?: string
  • Optional key_id?: string
  • Optional refresh_in?: number
  • Optional refresh_token?: string
  • Optional scope?: string
  • Optional spa_accountid?: string
  • Optional spa_code?: string
  • Optional status?: number
  • Optional suberror?: string
  • Optional timestamp?: string
  • Optional token_type?: AuthenticationScheme
  • Optional trace_id?: string

Settings

Member Visibility

Theme

Generated using TypeDoc