Summary
Integrations lets you connect single sign-on identity providers to an account. For an OAuth provider, you complete a structured form of connection fields, including the grant type, OAuth version, the provider's endpoints, the requested scope, and your client credentials. This article explains how to set up an OAuth identity provider.
Introduction
Integrations manages the single sign-on identity providers attached to an account. Each identity provider has an SSO type, either SAML or OAuth. When you choose OAuth, KnowledgeCity presents a structured form where you enter the provider's endpoints and client credentials, so your users can sign in with that provider instead of a separate KnowledgeCity password.
This workflow is used by administrators who manage account level authentication. It gives them a clear, field by field way to define an OAuth connection using the values their identity provider supplies.
Key Concepts
- SSO Identity Provider: an external service that authenticates your users so they can sign in through single sign-on. Integrations stores one or more of these connections per account.
- SSO type: whether a connection uses SAML or OAuth. Selecting OAuth shows the OAuth connection fields.
- Grant Type: the OAuth grant the provider uses to issue tokens.
- OAuth Version: whether the provider uses OAuth 2.0 or 1.0.
- Dialog URL: the provider's authorization endpoint, where the user is sent to sign in and approve access.
- Access Token URL: the provider endpoint KnowledgeCity calls to obtain an access token after authorization succeeds.
- User Info URL: the provider endpoint that returns the signed-in user's profile details.
- Scope: the access the request asks the provider to grant.
- Client ID and Client Secret: the credentials the provider issues to identify and authorize KnowledgeCity. Treat the client secret like a password.
Steps to Follow
Open the SSO settings
Open the account's SSO settings, where the identity provider connections for the account are listed and managed.
Add an OAuth identity provider
Add a new identity provider and set the SSO type to OAuth. KnowledgeCity then shows the OAuth connection fields for you to complete.
Enter the OAuth connection details
Complete the OAuth fields using the values your identity provider supplies:
- Grant Type
- OAuth Version (2.0 or 1.0)
- Dialog URL (the provider's authorization endpoint)
- Access Token URL
- User Info URL
- Scope
- Client ID
- Client Secret
Enter each value exactly as the provider specifies, and keep the client secret secure.
Save the connection
Save the connection to store it. You can return to the SSO settings later to update the fields, or remove a connection you no longer need.
Conclusion
Configuring an OAuth identity provider in Integrations means selecting the OAuth SSO type and completing its structured connection fields, the grant type, OAuth version, endpoints, scope, and client credentials, then saving. With the connection in place, your users can sign in through the OAuth provider they already use.