PropertiesFields  Code  Description  Type  Status  Grant Type  Client ID  Client Secret Key  User Name  Password Key  Redirect URL  Authorization URL  Access Token URL  Scope  Resource  Auth. URL Parameter  Access Token  Refresh Token  ID Token  Authorization Time  Expires In  Ext. Expires In  Expires Not Before  Token Type  Token Scope  Token ResourceKeysMethods  ClearTokens  GetAccessToken  GetRefreshToken  RefreshAccessToken  RequestAccessToken  TryAcquireAuthorizationToken  TryAcquireTokenByRefreshToken

Table CCS DIS OAuth Application

table 5100902 "CCS DIS OAuth Application"

Properties

Name	Value
Caption	OAuth Application
DrillDownPageId	CCS DIS OAuth Applications
LookupPageId	CCS DIS OAuth Applications

Fields

Code

field(1; "Code"; Code[20])

Properties

Name	Value
Caption	Code
DataClassification	CustomerContent
NotBlank	1

Description

field(2; "Description"; Text[250])

Properties

Name	Value
Caption	Description
DataClassification	CustomerContent

Type

field(5; "Type"; Enum "CCS DIS OAuth Application Type")

Properties

Name	Value
Caption	Type
DataClassification	SystemMetadata
InitValue	OAuth20

Status

field(10; "Status"; Enum "CCS DIS OAuth Application Status")

Properties

Name	Value
Caption	Status
DataClassification	SystemMetadata

Grant Type

field(11; "Grant Type"; Enum "CCS DIS OAuth Grant Type")

Properties

Name	Value
Caption	Grant Type
DataClassification	EndUserIdentifiableInformation
ValuesAllowed	"Authorization Code", "Password Credentials", "Client Credentials", Implicit

Client ID

field(15; "Client ID"; Text[250])

Properties

Name	Value
Caption	Client ID
DataClassification	EndUserIdentifiableInformation

Client Secret Key

field(16; "Client Secret Key"; Guid)

Properties

Name	Value
Caption	Client Secret
DataClassification	EndUserIdentifiableInformation

User Name

field(17; "User Name"; Text[80])

Properties

Name	Value
Caption	User Name
DataClassification	EndUserIdentifiableInformation

Password Key

field(18; "Password Key"; Guid)

Properties

Name	Value
Caption	Password
DataClassification	EndUserIdentifiableInformation

Redirect URL

field(20; "Redirect URL"; Text[250])

Properties

Name	Value
Caption	Redirect URL
DataClassification	OrganizationIdentifiableInformation

Authorization URL

field(21; "Authorization URL"; Text[250])

Properties

Name	Value
Caption	Authorization URL
DataClassification	OrganizationIdentifiableInformation

Access Token URL

field(22; "Access Token URL"; Text[250])

Properties

Name	Value
Caption	Access Token URL
DataClassification	OrganizationIdentifiableInformation

Scope

field(25; "Scope"; Text[250])

Properties

Name	Value
Caption	Scope
DataClassification	SystemMetadata

Resource

field(26; "Resource"; Text[250])

Properties

Name	Value
Caption	Resource
DataClassification	SystemMetadata

Auth. URL Parameter

field(35; "Auth. URL Parameter"; Text[250])

Properties

Name	Value
Caption	Auth. URL Parameter
DataClassification	SystemMetadata

Access Token

field(50; "Access Token"; Blob)

Properties

Name	Value
Caption	Access Token
DataClassification	EndUserIdentifiableInformation

Refresh Token

field(51; "Refresh Token"; Blob)

Properties

Name	Value
Caption	Refresh Token
DataClassification	EndUserIdentifiableInformation

ID Token

field(52; "ID Token"; Blob)

Properties

Name	Value
Caption	ID Token
DataClassification	EndUserIdentifiableInformation

Authorization Time

field(55; "Authorization Time"; DateTime)

Properties

Name	Value
Caption	Authorization Time
DataClassification	EndUserIdentifiableInformation
Editable	0

Expires In

field(56; "Expires In"; Integer)

Properties

Name	Value
Caption	Expires In
DataClassification	EndUserIdentifiableInformation
Editable	0

Ext. Expires In

field(57; "Ext. Expires In"; Integer)

Properties

Name	Value
Caption	Ext. Expires In
DataClassification	EndUserIdentifiableInformation
Editable	0

Expires Not Before

field(58; "Expires Not Before"; Integer)

Properties

Name	Value
Caption	Expires Not Before
DataClassification	EndUserIdentifiableInformation
Editable	0

Token Type

field(60; "Token Type"; Text[250])

Properties

Name	Value
Caption	Token Type
DataClassification	EndUserIdentifiableInformation
Editable	0

Token Scope

field(61; "Token Scope"; Text[250])

Properties

Name	Value
Caption	Token Scope
DataClassification	EndUserIdentifiableInformation
Editable	0

Token Resource

field(62; "Token Resource"; Text[250])

Properties

Name	Value
Caption	Token Resource
DataClassification	EndUserIdentifiableInformation
Editable	0

Keys

Name	Fields	Properties
PK	"Code"	Clustered = 1

Methods

ClearTokens

public "CCS DIS OAuth Application" ClearTokens(): None

Clears the access token, refresh token, id token and other response values.

Return Value

None

GetAccessToken

public "CCS DIS OAuth Application" GetAccessToken(): Text

Returns a valid access token.
If no token has been saved, the token will be aquired. If the token is expired, the token will be refreshed.
This procedure will save the tokens into the application!

Return Value

Text

A valid access token, or empty if an error occured.

GetRefreshToken

public "CCS DIS OAuth Application" GetRefreshToken(): Text

Returns the saved refresh token.
If no token was aquired, the return value will be empty.

Return Value

Text

The saved refresh token.

RefreshAccessToken

public "CCS DIS OAuth Application" RefreshAccessToken(): None

Forces the application to refresh the token, independent from the token expiration.
This procedure will save the tokens into the application!

Return Value

None

A valid new access token, or empty if an error occured.

RequestAccessToken

public "CCS DIS OAuth Application" RequestAccessToken(): None

Forces the application to aquire a new token, independent from the application status.
This procedure will save the tokens into the application!

Return Value

None

A valid new access token, or empty if an error occured.

TryAcquireAuthorizationToken

public "CCS DIS OAuth Application" TryAcquireAuthorizationToken(var Response: JsonToken): Boolean

Aquires a new token, without saving the tokens into the application!
This procedure should be used for user specific tokens (Authorization Code flow).
Aquires a token based on the application settings, independent from the application status.
Uses a TryFunction in implementation. Use GetLastErrorText() for error details.

Parameters

Name	Type	Description
Response	JsonToken	The full json response, containing all tokens.

Return Value

Boolean

True if the response was successfull, else false.

TryAcquireTokenByRefreshToken

public "CCS DIS OAuth Application" TryAcquireTokenByRefreshToken(RefreshToken: Text; var Response: JsonToken): Boolean

Aquires a new token from a refresh token, without saving the tokens into the application!
This procedure should be used for user specific tokens (Authorization Code flow).
Aquires a token based on the application settings, independent from the application status.
Uses a TryFunction in implementation. Use GetLastErrorText() for error details.

Parameters

Name	Type	Description
RefreshToken	Text	The refresh token used to create a new authorization token.
Response	JsonToken	The full json response, containing all tokens.

Return Value

Boolean

True if the response was successfull, else false.