TdxMicrosoftGraphAPIOAuth2AuthorizationAgent Class

A non-visual component designed to authorize your application in a Microsoft online account.

Declaration

delphi

TdxMicrosoftGraphAPIOAuth2AuthorizationAgent = class(
    TdxOAuth2AuthorizationAgent
)

Remarks

Associate this component with a Microsoft Graph®; API-compatible DevExpress data provider (TcxSchedulerWebServiceStorageOfficeProvider, for instance) to authenticate and authorize your app in a Microsoft online account.

Main API Members

The list below outlines key members of the TdxMicrosoftGraphAPIOAuth2AuthorizationAgent component. These members allow you to authorize your app in an account on behalf of a user and manage access tokens.

Access Token Management

AccessToken | AccessTokenExpiresInReturn the current access token and its expiration time (in seconds).AccessTokenTypeReturns the access token type.DefaultTokenExpiresInSpecifies the default life time for an access token, in seconds.DefaultRedirectUri | RedirectUri

Specify the address required to receive an access token.

Important

Use corresponding settings for different online service providers. Refer to the RedirectUri property description for detailed information.

Load

Assigns specified access and refresh tokens.

Tip

This method is useful if you need to load existing tokens stored in the local file system.

OnReceiveAccessToken | OnReceiveAuthorizationCodeAllow you to override predefined authorization and authentication routines.RefreshAccessTokenRefreshes the access token on demand using the refresh token.RefreshTokenReturns the current refresh token.RevokeAccessTokenRevokes the current access token. This operation also terminates the current authorization session.ValidateAccessTokenChecks if the access token is valid and refreshes the token if it has expired.

Credentials Management

ClientIDSpecifies a unique OAuth 2.0 client identifier.ClientSecret

Specifies the OAuth 2.0 secret for the identifier assigned to the ClientID property.

Important

We strongly recommend that you can handle the OnGetClientSecret event to request the client secret from a safe storage on demand.

OnGetClientSecret Recommended. Allows you to load an OAuth 2.0 secret from a safe storage in response to starting an authorization session.

Server-Related Settings

DefaultUserAgent | UserAgentAllow you to define a specific user agent for interaction with a cloud service.HeaderContentTypeSpecifies the default header for HTTPS requests.

Permission Management

AdditionalScopesSpecify a set of permissions granted by a user to an application for all required operations in the target account.DefaultIncludeGrantedScopesSpecifies if incremental authorization is active.RefreshScopesReloads account access permissions.

Session Management

FinishAuthorizationTerminates the ongoing authorization session.IsAuthorized | OnStartAuthorization | OnFinishAuthorizationAllow you to track the authorization session state.OnErrorReturns information on an authorization error every time it occurs.RestartAuthorizationRestarts the current authorization session.StartAuthorizationStarts a new authorization session using the current component settings.

Inheritance

TObject TPersistent TComponent TdxCustomAuthorizationAgent TdxOAuth2AuthorizationAgent TdxMicrosoftGraphAPIOAuth2AuthorizationAgent