OAuth SP

The OAuth SP screen allows you to view, add, and update the OAuth SP settings for your site.

OAuth SP list

Accessing the screen

In the left sidebar menu, under "SETTINGS", click [External system integration] -> [OAuth SP].

fetched from Gyazo

Item descriptions

fetched from Gyazo

ItemDescription
EnableStatus of the OAuth SP.
Image (fetched from Gyazo): Enabled
Image (fetched from Gyazo): Disabled
Login OAuth SP nameName of the OAuth SP.
TypeType of OAuth SP.
Updated onDate and time of last update to the OAuth SP.

SSO OAuth SP editor

Accessing the screen

In the left sidebar menu, under "SETTINGS", click [External system integration] -> [OAuth SP].

fetched from Gyazo

On the OAuth SP list screen, click the name of the OAuth SP you want to edit.

fetched from Gyazo

Item descriptions

SSO OAuth SP editor

fetched from Gyazo

ItemDescription
Login OAuth SP nameName of the OAuth SP. Check the "Enable" box to enable the current settings.
(Note: The test function can be used even if the OAuth SP settings are disabled.)
Target domainTarget domain of the OAuth SP (admin panel URL or API domain).
TypeService that will use the OAuth SP login.
Login URLURL for the user login.
Client IDSecurity ID obtained when creating a new OAuth application with the identity provider.
(Note: Store your client ID in a safe place, and do not use the same client ID for multiple providers.)
Client secretSecurity key obtained when creating a new OAuth application with the identity provider. Store your client secret in a safe place.
Return URL (success)URL that user will be redirected to upon successfully logging in.
Return URL (error)URL that user will be redirected to if login fails.
Automatic user registrationOption to enable automatic registration. Disabling this option redirects all unregistered users to the return URL (error) when they try to log in via SSO.
Store the ID in member ext col and link without using emailIf enabled, the OpenID from the identity provider will be used to authenticate the user.
(Note: Once this setting has been configured, do not change it again, as it may prevent users from logging in.)
Save user access tokenEnabling this option stores the users' access tokens in the database for future logins. Any refresh tokens from the identity provider will also be stored. Tokens will be refreshed each time the user logs in.

Actions

fetched from Gyazo

ButtonDescription
UpdateApply all changes made on this screen.
TestTest the OAuth SP settings to verify the fields that contain the necessary data. Click update to save the entered data before executing a test.
DeleteDelete the current OAuth SP.

Additional settings

If you select Custom for the OAuth SP type, enter the settings for your identity provider of choice in the additional fields that appear. Most of these settings can be found in the documentations of the identity provider.

SSO OAuth SP editor

ItemDescription
Authorize URLURL to which the user will be redirected for sign in. This is obtained from the identity provider.
Token URLURL used to obtain the access token for the code. This is obtained from the identity provider.
Resource URLURL used to obtain login credentials via an access token. This is obtained from the identity provider.
IdP mapping with registration fieldsEnter the user's first and last names for IdP mapping.
Required data scopeScope of data to be requested from the identity provider. To configure multiple scopes, click [Add].
Scope separatorFor multiple scopes, specify the scope separator. You can find this information in the documentation of the identity provider. By default, the comma , is used, but you may choose from a list of options depending on the provider.
Send client secret in basic auth headerOption to send the client secret in the basic authentication header. When unchecked, it will be sent in the URL parameter. You can find this setting in the documentation of the identity provider. If you are unsure, leave the box unchecked.
Do not send authorization prompt parameterWhen this option is enabled, the authorization prompt query will not be sent with the request. You can find this setting in the documentation of the identity provider. If you are unsure, leave the box unchecked.

Token and resource request settings

Click [Set up] to expand this section.

fetched from Gyazo

ItemDescription
Request typeType of request sent to the identity provider. The default value is GET. If your identity provider requires POST requests, specify it here.
Do not send access token in headerWhen this option is enabled, one or more parameters must be specified to send the access token.
Send additional parameter(s)Specify the parameter key and value to be sent in the request. Some identity providers may require additional parameters.
Resource key from IdPSpecify the key for mapping the response from the identity provider and the column in the t_member_header table the data will be mapped onto.

If you have any other questions, please use our contact form or Slack workspace.