Get OAuth Token Activity

Use the Get OAuth Token activity to get an OAuth token from an authorized server.

The details required for getting the token are passed by using the FHIR Authentication shared resource.
Note: This plug-in uses a system flow (Client Credentials flow) that a client (system) can use to authorize directly without having a user (person) name or present as a part of authentication.

Example

Refer to the associated example:

General

The General tab contains the following fields:

Field Literal Value/Module Property/Process Property? Description
Name No The name to be displayed as the label for the activity in the process.
OAuth Resource No Points to the desired FHIR authorization server.

Display existing OAuthContextPropertiesDisplays

If multiple properties are created, select one from the list.

Create a new process property

After creation, the new property appears on the OAuthContextPropertiesDisplays menu.

Set default property values

To select the Default Value Set for the property, click and select one of the following options:

  • Literal Value
  • Module Property

Grant Type No Gives the application an access token.

Currently it is set to client_credentials.

Format No Represents the content type.

Currently it is set to application/x-www-form-urlencoded.

Description

The Description tab is used to provide a short description of the activity.

Output

You get an OAuth token as an output.

Fault

The Fault tab lists errors that might occur when you use this activity.

Error Schema Element Datatype Description
msg string Error message description.
msgCode string The error code.

It represents the ActiveMatrix BusinessWorks Plug-in for HL7 with FHIR errors. For more information about error codes, see FHIR Error Codes.

Note: An error occurs in the process even after removal of OAuth Resource activity. To remove propertyContext entry from the Process Properties section for the process, you need to follow this steps:

  1. Click on the Process Canvas.

  2. In the Properties tab, go to the Process Properties section.

  3. In the Process Properties section, you will see all the Property name with its type and value. Remove the unwanted entry and save the process.