A two-step wizard: pick an App, then fill in the credentials. Includes instructions for every field.
Creating an auth config is a two-step wizard: pick the App first, then fill in the credentials that App requires.
Have the credentials for the target App ready. Different Apps need different things, so check the table below first:
For where to obtain each credential, see OAuth 2.0 configuration and API Key configuration.
You do not have to visit the auth config page first. From an App's connect dialog:
Once you have an auth config, connecting these Apps is just a matter of selecting it:
Once the connector is created, it appears in the Connected users section of the App details page. For how to manage it, see Connected accounts.
Before you start
Have the credentials for the target App ready. Different Apps need different things, so check the table below first:
| App | What to prepare |
|---|---|
| Salesforce | Org domain, plus the Client ID and Client Secret of a Connected App |
| MaxCompute | No credentials required, only an optional authorization scope |
| Yuque | A Yuque API Key |
Creation steps
1
Open the auth config page
In the left-side navigation of the console, click Auth configs. The first time you open it, the page tells you to complete an auth config first.Click Create auth config.
2
Select an App
The first step of the wizard is Select an App, and the page prompts you to select a toolkit to set up authentication for.The list shows only the Apps that require an auth config, with the authentication method labeled on the right of each entry:
Select the target App and click Next.
| App | Authentication method |
|---|---|
| Salesforce | OAuth2 |
| Yuque | API Key |
| MAX_COMPUTE | OAuth2 |
3
Fill in the config
The second step of the wizard is Auth config. The three fields at the top are common to all Apps:
Below them are the credential fields specific to that App. They differ per App — see OAuth 2.0 configuration and API Key configuration.
| Field | Required | Description |
|---|---|---|
| Connected App | — | Read-only, shows the App selected in the previous step |
| Config name | No | Distinguishes multiple configs under the same App. State the purpose clearly, for example production or test |
| Authentication method | — | Read-only, determined by the App, shows either OAuth 2.0 or API Key |
4
Finish
Click Finish to save the config. To change what you selected in the previous step, click Previous to go back.After it is saved, the config appears in the Auth configs list and is available when you create a connector.
Create one directly from the connect flow
You do not have to visit the auth config page first. From an App's connect dialog:
1
Open the connect dialog
On the Apps page, find the target App and click Connect.
2
Expand the drop-down list
Click the Select auth config drop-down list. When the current App has no config yet, the list shows that no config exists and invites you to click the button below to create one.
3
Jump to creation
Click Create auth config. The console opens the creation page with the current App and its authentication method already selected, so you only need to fill in the credentials.
This path opens a new page. After you save the config, return to the Apps page and reopen the connect dialog — the new config now appears in the drop-down list.
Use a config to create a connector
Once you have an auth config, connecting these Apps is just a matter of selecting it:
1
Open the connect dialog
On the Apps page, find the target App and click Connect.
2
Select a config
In the Select auth config drop-down list, select the config you want to use. This is the only required field in that dialog.
3
Confirm
Click OK. Apps that use OAuth 2.0 redirect you to the target system to sign in and authorize, and return to the console once authorization succeeds.
Frequently asked questions
| Symptom | Cause | What to do |
|---|---|---|
| The config you want is missing from the drop-down list | The config belongs to a different App | Auth configs are bound to an App, so create one specifically for the current App |
| The Finish button does nothing | Required fields are incomplete | Check the fields marked with an asterisk. Credential fields are usually all required |
| The connector still fails after saving | Wrong credentials or insufficient permissions | Verify that the credentials were copied in full, and that the app is enabled in the target system |