-
Notifications
You must be signed in to change notification settings - Fork 18
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #104 from equinor/postman-guidelines
Postman guidelines
- Loading branch information
Showing
2 changed files
with
26 additions
and
1 deletion.
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
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,24 @@ | ||
# Guidelines on using Postman | ||
|
||
## Lightweight API Client | ||
|
||
- This is the default client before the user is logged in to Postman services. | ||
- The lightweight API client only stores client save data locally. | ||
- Our recommendation is to use the lightweight client unless you need features from the logged-in client. | ||
|
||
## Logged-in client | ||
|
||
Logging in with a user account enables most of the features within Postman, this however comes with some security caveats. | ||
|
||
- When using workspaces, collections and environments you potentially expose data. | ||
|
||
**Best practices**: | ||
|
||
- Avoid storing sensitive data anywhere except in environments. | ||
- Storing variable values **only** in the `Current value` field, will ensure that the data is never shared with Postman. | ||
- You should also use environment variables with a secret type to store sensitive data and credentials, including API keys and access tokens. | ||
|
||
### Resources to read more on Postman | ||
|
||
- [Postman Security & Trust Portal](https://security.postman.com/) | ||
- [Security | Postman Trust Center](https://www.postman.com/trust/security/) |