Authentication via your own OAuth 2.0 provider

How it works

You can add user authorization through your social network using the OAuth 2.0 protocol. To enable a button for your social network on the authorization widget, specify the provider details in Publisher Account.

How to get it

To enable authorization via OAuth 2.0:

1. Open your project in Publisher Account and go to the Login section.
2. Click Configure in the panel of a classic login option.
3. Go to the Authentication block and select the OAuth 2.0 login connection.

4. Fill in the following fields:
   • Authorization name — integration name. Used for identification in Publisher Account. It can contain digits, Latin letters, hyphens, and underscores without spaces, with a maximum length of 100 characters.
   • Authorization URL — URL of the method used for user authentication.
   • Token URL — URL of the method used for obtaining an access token.
   • Your info URL — the URL of the authorization server token endpoint from where the access token is obtained after successful authentication.
   • Client ID — unique identifier of the client on the authorization server. It can contain digits, Latin letters, hyphens, and underscores without spaces, with a maximum length of 255 characters.
   • Client secret key — a unique ID generated by your authorization system. It can contain digits, Latin letters, hyphens, and underscores without spaces, with a length of 8-255.
   • Permission scope.
5. Set up the Key name map:
   • Provide the key name for the email address in your system (optional).
   • Provide the key name for the user identifier in your system.
6. In the Settings section, specify the fine integration settings (optional):
   • auth_content_type — the value of the Content-Type header.
   • auth_header — the header that passes the authorization token when requesting user data (authorization in the header).
   • auth_param — the name of the query parameter that passes the authorization token when requesting user data (authorization in the parameter).
   • token_type — token type. Possible values: Bearer, OAuth.
   • use_pkce — a flag indicating the use of the PKCE (Proof Key for Code Exchange) technology during authorization.

7. If you use the integration via the authorization widget, set up Customization:
   • Specify the Authorization button name. Maximum length — 30 characters.
   • Upload your logo. Recommended size: 24px × 24px. Supported formats: JPG, PNG and SVG.
   • Set the authorization button color.
   • Click Save changes.
8. If you are using integration through the Login API methods, configure the transmission of your provider ID in the provider_name in the following format: “<authorization_name>-<publisher_id>”, where <authorization_name> — is the integration name you specified in the provider settings, аnd <publisher_id> — is the ID of your project in Publisher Account:
   • When authorizing using the JWT protocol, pass the provider_name parameter in the following methods:
     • Auth via social network
     • Get link for social auth
   • When authorizing using the OAuth 2.0 protocol, pass the provider_name parameter in the following methods:
     • Auth via social network
     • Get link for social auth