OAuth 2

Modified on Mon, 14 Aug, 2023 at 4:38 PM

The OAuth 2 login service can be used to connect an OAuth 2 identity provider to formcycle. The OAuth 2 specific configuration options are described below. For general information on basic settings and creating login services, see Login Services.

Contents

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.