Codeunit "OAuth 2.0 Mgt."

ID 1140
Namespace: System.Security.Authentication

Methods

GetAuthorizationURL

Obsolete

This element will become obsolete from version 24.0. Use procedure GetAuthorizationURLAsSecretText instead.

[NonDebuggable]
[Obsolete(Use procedure GetAuthorizationURLAsSecretText instead.,24.0)]
procedure GetAuthorizationURL(OAuth20Setup: Record "OAuth 2.0 Setup", ClientID: Text): Text

Parameters

Name Type Description
OAuth20Setup Record "OAuth 2.0 Setup"
ClientID Text

Returns

Type Description
Text

GetAuthorizationURLAsSecretText

procedure GetAuthorizationURLAsSecretText(OAuth20Setup: Record "OAuth 2.0 Setup", ClientID: Text): SecretText

Parameters

Name Type Description
OAuth20Setup Record "OAuth 2.0 Setup"
ClientID Text

Returns

Type Description
SecretText

RequestAccessToken

Obsolete

This element will become obsolete from version 24.0. Use RequestAccessToken procedure with parameters declared as SecretText instead.

Request access token using application/json ContentType.

[NonDebuggable]
[Obsolete(Use RequestAccessToken procedure with parameters declared as SecretText instead.,24.0)]
procedure RequestAccessToken(var OAuth20Setup: Record "OAuth 2.0 Setup", var MessageText: Text, AuthorizationCode: Text, ClientID: Text, ClientSecret: Text, var AccessToken: Text, var RefreshToken: Text): Boolean

Parameters

Name Type Description
OAuth20Setup Record "OAuth 2.0 Setup"
MessageText Text
AuthorizationCode Text
ClientID Text
ClientSecret Text
AccessToken Text
RefreshToken Text

Returns

Type Description
Boolean

RequestAccessToken

Request access token using application/json ContentType.

procedure RequestAccessToken(var OAuth20Setup: Record "OAuth 2.0 Setup", var MessageText: Text, AuthorizationCode: SecretText, ClientID: Text, ClientSecret: SecretText, var AccessToken: SecretText, var RefreshToken: SecretText): Boolean

Parameters

Name Type Description
OAuth20Setup Record "OAuth 2.0 Setup"
MessageText Text
AuthorizationCode SecretText
ClientID Text
ClientSecret SecretText
AccessToken SecretText
RefreshToken SecretText

Returns

Type Description
Boolean

RequestAccessTokenWithGivenRequestJson

Obsolete

This element will become obsolete from version 24.0. Use RequestAccessTokenWithGivenRequestJson with paramaters declared as SecretText instead.

Request access token using given request json and application/json ContentType.

[NonDebuggable]
[Obsolete(Use RequestAccessTokenWithGivenRequestJson with paramaters declared as SecretText instead.,24.0)]
procedure RequestAccessTokenWithGivenRequestJson(var OAuth20Setup: Record "OAuth 2.0 Setup", RequestJson: Text, var MessageText: Text, AuthorizationCode: Text, ClientID: Text, ClientSecret: Text, var AccessToken: Text, var RefreshToken: Text): Boolean

Parameters

Name Type Description
OAuth20Setup Record "OAuth 2.0 Setup"
RequestJson Text
MessageText Text
AuthorizationCode Text
ClientID Text
ClientSecret Text
AccessToken Text
RefreshToken Text

Returns

Type Description
Boolean

RequestAccessTokenWithGivenRequestJson

Request access token using given request json and application/json ContentType.

procedure RequestAccessTokenWithGivenRequestJson(var OAuth20Setup: Record "OAuth 2.0 Setup", RequestJson: Text, var MessageText: Text, AuthorizationCode: SecretText, ClientID: Text, ClientSecret: SecretText, var AccessToken: SecretText, var RefreshToken: SecretText): Boolean

Parameters

Name Type Description
OAuth20Setup Record "OAuth 2.0 Setup"
RequestJson Text
MessageText Text
AuthorizationCode SecretText
ClientID Text
ClientSecret SecretText
AccessToken SecretText
RefreshToken SecretText

Returns

Type Description
Boolean

RequestAccessTokenWithContentType

Obsolete

This element will become obsolete from version 24.0. Use "RequestAccessTokenWithContentType with paramaters declared as SecretText instead.

Request access token using application/x-www-form-urlencoded ContentType if UseUrlEncodedContentType is set to true or application/json ContentType otherwise.

[NonDebuggable]
[Obsolete(Use "RequestAccessTokenWithContentType with paramaters declared as SecretText instead.,24.0)]
procedure RequestAccessTokenWithContentType(var OAuth20Setup: Record "OAuth 2.0 Setup", RequestJson: Text, var MessageText: Text, AuthorizationCode: Text, ClientID: Text, ClientSecret: Text, var AccessToken: Text, var RefreshToken: Text, UseUrlEncodedContentType: Boolean): Boolean

Parameters

Name Type Description
OAuth20Setup Record "OAuth 2.0 Setup"
RequestJson Text
MessageText Text
AuthorizationCode Text
ClientID Text
ClientSecret Text
AccessToken Text
RefreshToken Text
UseUrlEncodedContentType Boolean

Returns

Type Description
Boolean

RequestAccessTokenWithContentType

Request access token using application/x-www-form-urlencoded ContentType if UseUrlEncodedContentType is set to true or application/json ContentType otherwise.

procedure RequestAccessTokenWithContentType(var OAuth20Setup: Record "OAuth 2.0 Setup", RequestJson: Text, var MessageText: Text, AuthorizationCode: SecretText, ClientID: Text, ClientSecret: SecretText, var AccessToken: SecretText, var RefreshToken: SecretText, UseUrlEncodedContentType: Boolean): Boolean

Parameters

Name Type Description
OAuth20Setup Record "OAuth 2.0 Setup"
RequestJson Text
MessageText Text
AuthorizationCode SecretText
ClientID Text
ClientSecret SecretText
AccessToken SecretText
RefreshToken SecretText
UseUrlEncodedContentType Boolean

Returns

Type Description
Boolean

RefreshAccessToken

Obsolete

This element will become obsolete from version 24.0. Use RefreshAccessToken with paramaters declared as SecretText instead.

Refreshes access token using application/json ContentType.

[NonDebuggable]
[Obsolete(Use RefreshAccessToken with paramaters declared as SecretText instead.,24.0)]
procedure RefreshAccessToken(var OAuth20Setup: Record "OAuth 2.0 Setup", var MessageText: Text, ClientID: Text, ClientSecret: Text, var AccessToken: Text, var RefreshToken: Text): Boolean

Parameters

Name Type Description
OAuth20Setup Record "OAuth 2.0 Setup"
MessageText Text
ClientID Text
ClientSecret Text
AccessToken Text
RefreshToken Text

Returns

Type Description
Boolean

RefreshAccessToken

Refreshes access token using application/json ContentType.

[NonDebuggable]
procedure RefreshAccessToken(var OAuth20Setup: Record "OAuth 2.0 Setup", var MessageText: Text, ClientID: Text, ClientSecret: SecretText, var AccessToken: SecretText, var RefreshToken: SecretText): Boolean

Parameters

Name Type Description
OAuth20Setup Record "OAuth 2.0 Setup"
MessageText Text
ClientID Text
ClientSecret SecretText
AccessToken SecretText
RefreshToken SecretText

Returns

Type Description
Boolean

RefreshAccessTokenWithGivenRequestJson

Obsolete

This element will become obsolete from version 24.0. Use RefreshAccessTokenWithGivenRequestJson with paramaters declared as SecretText instead.

Refreshes access token with given request json using application/json ContentType.

[NonDebuggable]
[Obsolete(Use RefreshAccessTokenWithGivenRequestJson with paramaters declared as SecretText instead.,24.0)]
procedure RefreshAccessTokenWithGivenRequestJson(var OAuth20Setup: Record "OAuth 2.0 Setup", RequestJson: Text, var MessageText: Text, ClientID: Text, ClientSecret: Text, var AccessToken: Text, var RefreshToken: Text): Boolean

Parameters

Name Type Description
OAuth20Setup Record "OAuth 2.0 Setup"
RequestJson Text
MessageText Text
ClientID Text
ClientSecret Text
AccessToken Text
RefreshToken Text

Returns

Type Description
Boolean

RefreshAccessTokenWithGivenRequestJson

Refreshes access token with given request json using application/json ContentType.

procedure RefreshAccessTokenWithGivenRequestJson(var OAuth20Setup: Record "OAuth 2.0 Setup", RequestJson: Text, var MessageText: Text, ClientID: Text, ClientSecret: SecretText, var AccessToken: SecretText, var RefreshToken: SecretText): Boolean

Parameters

Name Type Description
OAuth20Setup Record "OAuth 2.0 Setup"
RequestJson Text
MessageText Text
ClientID Text
ClientSecret SecretText
AccessToken SecretText
RefreshToken SecretText

Returns

Type Description
Boolean

RefreshAccessTokenWithContentType

Obsolete

This element will become obsolete from version 24.0. Use RefreshAccessTokenWithContentType with paramaters declared as SecretText instead.

Refreshes access token using application/x-www-form-urlencoded ContentType if UseUrlEncodedContentType is set to true or application/json ContentType otherwise.

[NonDebuggable]
[Obsolete(Use RefreshAccessTokenWithContentType with paramaters declared as SecretText instead.,24.0)]
procedure RefreshAccessTokenWithContentType(var OAuth20Setup: Record "OAuth 2.0 Setup", RequestJson: Text, var MessageText: Text, ClientID: Text, ClientSecret: Text, var AccessToken: Text, var RefreshToken: Text, UseUrlEncodedContentType: Boolean): Boolean

Parameters

Name Type Description
OAuth20Setup Record "OAuth 2.0 Setup"
RequestJson Text
MessageText Text
ClientID Text
ClientSecret Text
AccessToken Text
RefreshToken Text
UseUrlEncodedContentType Boolean

Returns

Type Description
Boolean

RefreshAccessTokenWithContentType

Refreshes access token using application/x-www-form-urlencoded ContentType if UseUrlEncodedContentType is set to true or application/json ContentType otherwise.

procedure RefreshAccessTokenWithContentType(var OAuth20Setup: Record "OAuth 2.0 Setup", RequestJson: Text, var MessageText: Text, ClientID: Text, ClientSecret: SecretText, var AccessToken: SecretText, var RefreshToken: SecretText, UseUrlEncodedContentType: Boolean): Boolean

Parameters

Name Type Description
OAuth20Setup Record "OAuth 2.0 Setup"
RequestJson Text
MessageText Text
ClientID Text
ClientSecret SecretText
AccessToken SecretText
RefreshToken SecretText
UseUrlEncodedContentType Boolean

Returns

Type Description
Boolean

InvokeRequest

Obsolete

This element will become obsolete from version 24.0. Use InvokeRequest with paramaters declared as SecretText instead.

[NonDebuggable]
[Obsolete(Use InvokeRequest with paramaters declared as SecretText instead.,24.0)]
procedure InvokeRequest(var OAuth20Setup: Record "OAuth 2.0 Setup", RequestJson: Text, var ResponseJson: Text, var HttpError: Text, AccessToken: Text, RetryOnCredentialsFailure: Boolean): Boolean

Parameters

Name Type Description
OAuth20Setup Record "OAuth 2.0 Setup"
RequestJson Text
ResponseJson Text
HttpError Text
AccessToken Text
RetryOnCredentialsFailure Boolean

Returns

Type Description
Boolean

InvokeRequest

procedure InvokeRequest(var OAuth20Setup: Record "OAuth 2.0 Setup", RequestJson: Text, var ResponseJson: Text, var HttpError: Text, AccessToken: SecretText, RetryOnCredentialsFailure: Boolean): Boolean

Parameters

Name Type Description
OAuth20Setup Record "OAuth 2.0 Setup"
RequestJson Text
ResponseJson Text
HttpError Text
AccessToken SecretText
RetryOnCredentialsFailure Boolean

Returns

Type Description
Boolean

GetHttpStatusFromJsonResponse

[NonDebuggable]
procedure GetHttpStatusFromJsonResponse(JsonString: Text, var StatusCode: Integer, var StatusReason: Text, var StatusDetails: Text): Boolean

Parameters

Name Type Description
JsonString Text
StatusCode Integer
StatusReason Text
StatusDetails Text

Returns

Type Description
Boolean

See also