-
Notifications
You must be signed in to change notification settings - Fork 15
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Manage Project and Manage Credentials #391
Merged
Merged
Changes from all commits
Commits
Show all changes
15 commits
Select commit
Hold shift + click to select a range
1947b56
manage project first draft
ritazagoni afd41e0
managing credentials first draft
ritazagoni 714e9aa
add screenshots
ritazagoni 383e5b4
add images
ritazagoni 91cdb86
update sidebars-main.js
ritazagoni 22d30ee
add permissions file to match main
aleksa-krolls d95ae65
Merge branch 'main' into project
aleksa-krolls 7ea52aa
fix image paths and warning labels
aleksa-krolls c64bca5
fixing formatting, adding page subsections, adding tips boxes, adjust…
aleksa-krolls 075091f
draft Share Credentials section
aleksa-krolls 1782dc3
credentials pages
ritazagoni 681b613
Update user-credentials.md
aleksa-krolls c639c86
Update manage-credentials.md
aleksa-krolls a96336e
Merge branch 'main' into project
aleksa-krolls 6ef2edd
Update manage-credentials.md
aleksa-krolls File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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 |
---|---|---|
@@ -0,0 +1,59 @@ | ||
--- | ||
title: Manage Credentials | ||
--- | ||
|
||
You can view the Credentials related to a Project under the Project | ||
`Settings > Credentials` page. In this article, you'll learn how to manage your | ||
credentials related to a project. | ||
|
||
### View all Project Credentials | ||
|
||
Via this `Credentials` page, you can see a list of all Credentials, including | ||
the name, type, and owner, and whether they are for a production environment. | ||
|
||
 | ||
|
||
:::info Viewing credential secrets | ||
|
||
All Project Collaborators can view the credential name, type, and owner, but | ||
only the Credential Owner can view the credential secrets (username, password, | ||
etc.). | ||
|
||
::: | ||
|
||
### Create a new Credential | ||
|
||
1. Click on the `New Credential` button, and choose the type of app you want to | ||
connect. | ||
|
||
2. If your app is not listed, choose "Raw JSON" to create your own custom | ||
credential or "configuration" input. For example: | ||
|
||
```json | ||
{ "loginUrl": "https://random-app.com", "username": "test", "password": "pwd" } | ||
``` | ||
|
||
 | ||
|
||
3. Click `Configure Credentials` and add the authentication details for your | ||
app. The credential form will indicate which fields are required. | ||
|
||
 | ||
|
||
:::tip Not sure how to fill in all credential details? | ||
|
||
While creating a new credential form, if you're not sure what some of these | ||
fields require (e.g., "security token"), then head over to the relevant | ||
`Adaptors` docs page to learn more and read about the "configuration schema" or | ||
ask on [Community](https://community.openfn.org). | ||
|
||
::: | ||
|
||
3. Click `Save` and you'll see it listed in your `Credentials` page. You can now | ||
use it across the Project when building and running Workflows. | ||
|
||
 | ||
|
||
### Share Credentials | ||
|
||
If you own a Credential, you can choose which Project has access to it. To update which Projects your Credential is shared with, follow the steps on the User Credentials docs page. |
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
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
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 |
---|---|---|
@@ -0,0 +1,42 @@ | ||
--- | ||
title: Manage User Credentials | ||
sidebar_label: User Credentials | ||
slug: /user-credentials | ||
--- | ||
|
||
You can manage all the Credentials you own under the `Credentials` page of your profile. This article, we'll walk you through how to manage and share the Credentials you own across projects. | ||
|
||
### All your Credentials in one place | ||
|
||
The `Credentials` page of your `User Settings` allows you to add, view, edit or delete the Credentials you own. It is the central place to manage your Credentials across all projects you collaborate on. | ||
|
||
 | ||
|
||
 | ||
|
||
For guidance on how to set up a new Credential, head over to our [Manage Credentials](/documentation/next/manage-projects/manage-credentials) page. | ||
|
||
You can update the name and login details of a Credential after clicking `Edit`. | ||
|
||
 | ||
|
||
|
||
### Share Credentials | ||
|
||
You can also allow multiple projects to have access to a Credential you own. | ||
|
||
To add or remove project access, click `Edit` on the Credential you want to share, and choose the project from the dropdown under `Project Access`. | ||
|
||
 | ||
|
||
:::info Shared Credentials remain secret | ||
|
||
If you share a Credential with a Project, Collaborators of that Project can _use_ the Credential in their Workflows, but they won't be able to see the login details contained. | ||
|
||
::: | ||
|
||
:::tip | ||
|
||
If you want to share the login details contained in the Credential, use a secure sharing protocol like a password manager or an encrypted messaging platform. | ||
|
||
::: |
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
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
hey @ritazagoni I made some edits to align more with Nick's guidance - see slack thread.
Can you please fill in the correct info for
Share Credentials
(a section I added to the manage-credentials page). See my notes in the page