OAuth 2


When adding a OAuth 2 identity provider the following parameters are requested:

Base settings

Basic settings for the configuration of the OAuth 2 identity provider.

Name

Name of the identity provider in Xima® Formcycle.

Different name on form login button

If a form has been configured to offer several authentication options, a dialog will be displayed when opening the form in which an authentication type has to be selected. The text content that should be on the button for this identity provider can be configured here. 

If nothing is entered here, the name entered under Name is used.

Alias for callback URL (UUID)

Unique identifier that is used when the identity provider returns to Xima® Formcycle. This value is generated automatically, but can be changed if necessary.

Callback URL

URLs for each Xima® Formcycle-Server (master server as well as frontend servers) which can be used when returning from the identity provider to Xima® Formcycle. Each URL can be copied to the clipboard by clicking the copy icon to the right of the URL.

Initially visible buttons

Below the base settings there are initially 3 buttons whose functions are intended to help with the configuration of the identity provider.

Send email to provider

Opens the e-mail program set up in the system with a pre-formulated request regarding the information required for the configuration of the identity provider in Xima® Formcycle

Help

Opens this help page in the browser.

Add configuration

If the required information has been provided by the identity provider, the area for the configuration of the identity provider can be opened by clicking on this button. Afterwards the area configuration which is described below opens.

Configuration

Configuration options for an OAuth 2 identity provider.

Key

Unique ID of the configuration you get from your identity provider.

Secret

Secret key which is used to authenticate your client.

Scope

Specifies the access scope that FORMCYCLE uses when querying fields from the identity provider.

Authorization Request URL

Defines the URL which is used for an authorization request from the identity provider.

Access-Token Request URL

Defines the URL that is used to request the access token from the identity provider.

URL to determine the profile data

Defines the URL which is used to request the (user) profile data from the identity provider.

Request method for determining the profile data

Defines the request method (GET or POST) which is used for the request to receive the profile data from the Identity Provider.

Attribute name for unique identifier in profile data

Overrides the attribute name for the identifier in the returned profile data. The default value is "id".

Mapping of the profile attributes to FORMCYCLE user profile

Advanced settings for configuring an OAuth 2 identity provider.

Given name

Specifies which profile attribute should be used for the user's first name.

Last name

Specifies which profile attribute should be used for the user's last name.

Display name

Specifies which profile attribute should be used for the user's display name.

Username

Specifies which profile attribute should be used for the user name of the user.

Email

Specifies which profile attribute should be used for the user's email address.

Language

Specifies which profile attribute should be used for the user's language. (Value must correspond to a code from ISO standards 3166 or 639.)

Location

Specifies which profile attribute should be used for the user's location. (Value must correspond to a code from ISO standards 3166 or 639.)

Picture URL

Specifies which profile attribute should be used for the user's picture URL. (Value must be convertible to a valid URI.)

Profile URL

Specifies which profile attribute should be used for the user's profile URL. (Value must be convertible to a valid URI.)

Extended attribute mapping

In addition to the ones listed above, other attributes can be defined in this table. A property and a corresponding value must be entered in each line.