Working with the Retrieve ID Token Process

Navigation:  How to Work with Processes > Working with the Web Services Processes Group >

Working with the Retrieve ID Token Process

Previous pageReturn to chapter overviewNext page

 

Process Purpose

 

The "Retrieve ID Token" process is used to cache user profile information. This user information can, then, be exposed in the application or shared with 3rd party entities.

This type of request requires the matching "openid" scope to be configured in the authorization profile and in the server.

 

Be aware that this process ONLY returns part of the JWT (JSON Web Token) Payload Data of the Token ID.

It does NOT return an Access Token.

 

 

 

When you add a process, you are required to define its settings. This occurs in the process's properties window which is displayed automatically after having added the "Retrieve ID Token" process.

If any subsequent edition is required, double-click the process to open its properties window and enter the necessary modifications.

 

 

Fill in the following options:

 

Authorization

Authorization Profile

Select an authorization profile from the drop-down OR  click to access the authorization profile list and edit an existing profile or create a new one.

See To Create an Authorization Profile with a Basic/Digest Authentication, To Create an Authorization Profile with "OAuth 2.0" Authentication and/or To Edit an Authorization Profile.

Store in Variable

Click to define the variable that will receive the "ID Token" data.

 

Detail of a window:

 

 

"S:Menu" is a screen included in the same program as the process.

"R:Routine_1" is a routine included in the same program as the process.

 

If required, use the icon on the upper right corner of the properties window to attach any relevant notes to this process. Click it and enter your notes in the resulting text box. These notes will be displayed in the corresponding "Actions" tab or "Process" window (in the "Notes" field) and in the "Developer Report".

 

After filling in the required options, click to conclude or to abort the operation.

The added process is displayed in the corresponding "Actions" tab or "Process" window.

 

 

Use the right click in MCL-Designer's input boxes to access certain features regarding the input box's option as well as general actions such as "Copy"; "Paste"; "Search".

Ex: If you right-click the "Variable" input box (included in a "Conversion's" properties window), you are provided with the "Search..."and "Variable Select" options.

If you right-click another input box, it will provide other possibilities.