IAuthResult Interface
Holds the final information of a succesfull authorization flow.
Syntax
Unit: Sphinx.OidcClient.AuthResult
IAuthResult = interface(IInterface);
Methods
Name | Description |
---|---|
IsExpired | Indicates if the current information (i.e., access token) is expired. |
Properties
Name | Description |
---|---|
AccessToken | Holds the access token which can be used to authenticate to the API server. |
TokenType | The type of the access token. Usually just contains "Bearer". |
RefreshToken | If present, contains a refresh token that can be used to obtain new access tokens. |
Scope | Spaced-separated list of scope tokens granted in the access token. |
Expiration | The date and time where the access token expires. |
IdToken | A OpenId Connect compatible JSON Web Token holding information about the authenticated user. |
Profile | Holds information about the authenticated user, extracted from the IdToken. |
AppState | Holds the custom application state provided at the beggining of the authorization flow. |