Compare commits

...

6 Commits

Author SHA1 Message Date
Robert Wallach
28988e35ed Update oauth.md 2018-04-06 11:00:49 -05:00
Robert Wallach
4f6e343ca4 Update oauth.md 2018-04-05 14:52:46 -05:00
Robert Wallach
2e8e5571ed Update oauth.md 2018-04-05 14:44:06 -05:00
Robert Wallach
0e1f840794 Create oauth.md 2018-04-05 13:39:39 -05:00
Robert Wallach
f597a2cfb9 Create permissions-overview.md 2018-04-03 16:22:40 -05:00
Robert Wallach
a5bb2aa9a5 Add files via upload 2018-04-03 15:41:22 -05:00
3 changed files with 92 additions and 0 deletions

View File

@@ -0,0 +1,36 @@
# Permissions & Governance Overview
## Organizations
| **Organization Actions** | **Guest** | **Member** | **Administrator** | **Owner** |
|---------------------------------|:-----------:|:------------:|:-------------------:|:-----------:|
| Read Public Projects | X | X | X | X |
| View Organization Collaborators | | X | X | X |
| View Organization Teams | | X | X | X |
| Create Projects | | X | X | X |
| Read Private Projects | | X | X | X |
| Write Projects | | | X | X |
| Manage Collaborators | | | X | X |
| Manage Teams | | | X | X |
| Manage Organization Settings | | | | X |
| Manage Organization Billing | | | | X |
| Delete Organization | | | | X |
## Teams
| **Team Actions** | **Member** | **Administrator** | **Owner** |
|-------------------------|:------------:|:-------------------:|:-----------:|
| View Team Collaborators | X | X | X |
| Add Team to Projects | X | X | X |
| Manage Team Collaborators | | X | X |
| Manage Team Settings | | X | X |
| Delete Team | | | X |
## Projects
| **Project Actions** | **Read** | **Write** | **Administrator** |
|------------------------------|:--------:|:---------:|:-----------------:|
| Read Project | X | X | X |
| Write Project | | X | X |
| Manage Project Collaborators | | | X |
| Delete Project | | | X |

56
articles/hubs/oauth.md Normal file
View File

@@ -0,0 +1,56 @@
# OAuth for Hubs
## What
OAuth provides a level of security to your documentation to restrict access to it. Enabling OAuth in Hubs can be accomplished through two different methods: via Modeling or directly into the Hubs code.
> Stoplight supports OAuth 1.0 and 2.0
## How
### Modeling
![OAuth in Modeling](https://github.com/stoplightio/docs/blob/develop/assets/images/hubs-oauth-modeling.png?raw=true)
1. Create a new Modeling file or select an existing one referenced by the Hub you wish to modify
> If you are creating a new Modeling file, make sure to reference it in your Hub
2. Next to **Security** in the left-middle toolbar, Add a Security Scheme by clicking the **+**
3. Input a **key**
4. Select oauth2 under **type**
5. Select **accessCode** under OAuth **flow**
6. Select an **authorization url**
7. Select a **token url**
8. **Add Scope** (optional)
9. Add a **Security scheme description** (optional)
### Hubs
![OAuth in Hubs](https://github.com/stoplightio/docs/blob/develop/assets/images/hubs-oauth-code.png?raw=true)
1. Select the Hub you wish to modify
2. Select **Code View**
3. Add the following lines of code to your Hub:
```
"config": {
"http": {
"oauth2": {
"credentials": {
"authorize_url": "insert authorize url here",
"access_token_url": "insert access token url here",
}
}
}
}
```
---
**Related Articles**
- [Digital Oceans: Introduction to OAuth2](https://www.digitalocean.com/community/tutorials/an-introduction-to-oauth-2)
- [Security Schemes](/modeling/modeling-with-openapi/security-schemes)

Binary file not shown.

After

Width:  |  Height:  |  Size: 1.1 MiB