Table CCS DMS OAuth Application
table 5306005 "CCS DMS OAuth Application"
Properties
| Name |
Value |
| Caption |
OAuth 2.0 Application |
| DrillDownPageId |
CCS DMS OAuth Applications |
| LookupPageId |
CCS DMS 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 |
Status
field(10; "Status"; Enum "CCS DMS OAuth Application Status")
Properties
| Name |
Value |
| Caption |
Status |
| DataClassification |
SystemMetadata |
Grant Type
field(11; "Grant Type"; Enum "CCS DMS OAuth Grant Type")
Properties
| Name |
Value |
| Caption |
Grant Type |
| DataClassification |
EndUserIdentifiableInformation |
| Editable |
0 |
| ValuesAllowed |
"Authorization Code" |
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 Value |
| DataClassification |
EndUserIdentifiableInformation |
Redirect URL
field(20; "Redirect URL"; Text[250])
Properties
| Name |
Value |
| Caption |
Redirect URI |
| 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 |
|
|
Methods
ClearTokens
public "CCS DMS OAuth Application" ClearTokens(): None
Clears the access token, refresh token, id token and other response values.
Return Value
None
GetAccessToken
public "CCS DMS OAuth Application" GetAccessToken(): Text
Returns a valid access token.
If no token has been saved, the token will be acquired. 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 occurred.
GetRefreshToken
public "CCS DMS OAuth Application" GetRefreshToken(): Text
Returns the saved refresh token.
If no token was acquired, the return value will be empty.
Return Value
Text
The saved refresh token.
RefreshAccessToken
public "CCS DMS 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 occurred.
RequestAccessToken
public "CCS DMS OAuth Application" RequestAccessToken(): None
Forces the application to acquire 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 occurred.
TryAcquireAuthorizationToken
public "CCS DMS OAuth Application" TryAcquireAuthorizationToken(var Response: JsonToken): Boolean
Acquires a new token, without saving the tokens into the application!
This procedure should be used for user specific tokens (Authorization Code flow).
Acquires 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 successful, else false.
TryAcquireTokenByRefreshToken
public "CCS DMS OAuth Application" TryAcquireTokenByRefreshToken(RefreshToken: Text; var Response: JsonToken): Boolean
Acquires 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).
Acquires 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 successful, else false.