-
Notifications
You must be signed in to change notification settings - Fork 14
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
6b93e66
commit 1a6c6f6
Showing
2 changed files
with
28 additions
and
31 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -42,35 +42,31 @@ Oauth clients can be set up either on the | |
[project credentials page](../manage-projects/manage-credentials.md) or the | ||
[user credentials page](../manage-users/user-credentials.md). | ||
|
||
### Creating an OAuth client (Super Users) | ||
### Creating an OAuth client | ||
|
||
:::note Currently only users with | ||
[super user privileges](https://docs.openfn.org/documentation/manage-projects/user-roles-permissions#super-user-privileges) | ||
can create and manage OAuth clients. If you're using the OpenFn cloud-hosted | ||
platform SaaS, contact [[email protected]](mailto://[email protected]) for | ||
assistance adding a new Oauth client. ::: | ||
|
||
If you have not created a client before or a superuser has not created a client | ||
for the projects/users in the deployment, you will see an empty block with a | ||
button prompting you to create a client as shown below. | ||
If you do not have an OAuth client already set up for your project, you will see | ||
an empty section with a button prompting you to create a client as shown below. | ||
|
||
![New client](/img/create_new_oauth_client.png) | ||
|
||
Alternatively, you will see the list of existing OAuth clients you have access | ||
to. In this case click on the `New credential` button and select | ||
to. To create a new client, click the `Add new` button and select | ||
`OAuth client [Advanced]` in the dropdown. | ||
|
||
![OAuth dropdown](/img/oauth_dropdown.png) | ||
|
||
:::note Make sure you add https://app.openfn.org/authenticate/callback as the | ||
callback URL for the application when enabling OAuth authentication for the | ||
third party application. (Note: You should substitue `https://app.openfn.org/` | ||
with _your_ OpenFn's deployment base URL if you're not using app.openfn.org.) | ||
::: | ||
:::tip | ||
|
||
Make sure you add https://app.openfn.org/authenticate/callback as the callback | ||
URL for the application when enabling OAuth authentication for the third party | ||
application. (Note: You should substitue `https://app.openfn.org/` with _your_ | ||
OpenFn's deployment base URL if you're not using app.openfn.org.) | ||
|
||
:::tip For app-specific guidance (e.g., how to set up an Oauth Client | ||
For app-specific guidance (e.g., how to set up an Oauth Client | ||
[for Google Sheets](./adaptors/googlesheets)), refer to the relevant | ||
[Adaptor documentation](./adaptors) for app-specific guidance ::: | ||
[Adaptor documentation](./adaptors) for app-specific guidance | ||
|
||
::: | ||
|
||
### Sharing OAuth Clients | ||
|
||
|
@@ -113,15 +109,13 @@ Every client requires an authentication token to authenticate requests made to | |
the application on behalf of the user. On OpenFn, these tokens are created as | ||
credentials and are associated with clients. | ||
|
||
1. To create a credential from an Oauth client, click on create a new credential | ||
or click on the button as show below: | ||
1. To create a credential from an Oauth client, click on "Add new" button and | ||
select `Credential` from the dropdown or click on the | ||
`create a new credential` button. | ||
|
||
![Create new cred](/img/create_new_cred.png) | ||
![New credential](/img/oauth_dropdown.png) | ||
|
||
![New credential](/img/new_cred.png) | ||
|
||
:::tip Unlike for OAuth clients, project owners or admins can also create | ||
credentials, not only super users. ::: | ||
![Create new cred](/img/create_new_cred.png) | ||
|
||
2. Then, in the credential type modal, find and select the Oauth client to use | ||
for creating the OAuth credential. This will open a new modal for you to | ||
|
@@ -132,12 +126,15 @@ credentials, not only super users. ::: | |
Clicking this button will open a new tab for you to grant OpenFn an | ||
authorization token to authenticate your requests. | ||
|
||
:::note When you have siged in, you will be required to grant OpenFn access by | ||
clicking `Allow` on the permissions modal. Please note that this might look | ||
different for different applications but the intent is to grant OpenFn | ||
perimission to carry out certain actions to the application on your behalf. The | ||
user authenticating OAuth clients should have the required permissions in the | ||
application. ::: | ||
:::note | ||
|
||
When you have signed in, you will be required to grant OpenFn access by clicking | ||
`Allow` on the permissions modal. Please note that this might look different for | ||
different applications but the intent is to grant OpenFn perimission to carry | ||
out certain actions to the application on your behalf. The user authenticating | ||
OAuth clients should have the required permissions in the application. | ||
|
||
::: | ||
|
||
### Deleting Clients and Credentials | ||
|
||
|
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.