Oauth 2.0

External authorization providers

bg-dots
bg-dots

The System → Oauth 2.0 section manages external OAuth authorization providers. Through a provider, users sign in with an external IdP; the server maps response attributes to a VKS account. The page title is “Oauth providers”. Do not confuse this section with System → Auth Settings (server OAuth clients).

Providers list

Lists configured providers. When there are no records, the table is empty (headers only). After a provider is saved, a row appears in the table.

  • “Provider ID” – provider identifier; used to build the callback URL.
  • “Title” – provider display name.
  • “Provider callback URL” – callback URL that must be set in the external provider’s OAuth client settings.
  • “Provider adapter type” – adapter type (for example, “Generic”).
  • “Flow extensions” – enabled OAuth flow extensions.
  • “Create new provider” – opens the create-provider form.

Create new provider

Opened with “Create new provider”. The dialog title is “Create new provider”.

  • “Provider ID” – required alphanumeric identifier; used to construct the provider callback URL.
  • “Provider callback URL” – generated automatically from the provider ID; set this value as the callback in the external OAuth provider console.
  • “Title” – required display name.
  • “Client ID” – required client ID issued by the provider.
  • “Client secret” – required client secret issued by the provider.
  • “Create a subscriber if it is not on the server” – on first successful login, creates an account on the server if it does not exist yet.
  • “Oauth adapter settings” – block of parameters for exchange with the provider.
  • “Provider adapter type” – adapter type. Available values: “Generic”.
  • “Scopes” – scopes requested from the provider.
  • “Scopes separator symbol” – character that separates scopes in the request; default ,.
  • “Verify SSL certificates” – verifies SSL certificates when calling provider URLs.
  • “Authorization URL” – required provider authorization endpoint.
  • “Access token URL” – required provider token endpoint.
  • “Resource owner detail URL” – required endpoint for resource owner (user info) data.
  • “Names of attributes for getting VKS data” – mapping of provider response fields to account data.
  • “Subscriber Number attribute” – attribute name for the account number; default v_number.
  • “The attribute of the displayed name” – attribute name for the display name; default v_display_name.
  • “The email attribute” – attribute name for the email address; default email.
  • “Flow extensions” – additional flow options.
  • “Delegate account login” – delegates account login through the provider.
  • “Cancel” – closes without saving.
  • “Save” – creates the provider.

Creating a provider

Step 1. Open System → Oauth 2.0.
Step 2. Click “Create new provider”.
Step 3. Enter “Provider ID”, “Title”, “Client ID”, and “Client secret”.
Step 4. Copy “Provider callback URL” and set it in the external provider’s OAuth client settings.
Step 5. Fill in authorization, access token, and resource owner URLs; adjust scopes, separator, and VKS attributes if needed.
Step 6. Click “Save”. The provider appears in the list. To discard, use “Cancel”.

Webhooks API keys