Skip to content

Commit 54719d3

Browse files
jamesottingerGitHub Enterprise
authored andcommitted
Merge pull request #122 from jsager/moveAuthentication
Changed Authentication section of openapi.yaml
2 parents 025a9fc + 74aec53 commit 54719d3

File tree

2 files changed

+12
-5
lines changed

2 files changed

+12
-5
lines changed

index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@
1818
</style>
1919
</head>
2020
<body>
21-
<redoc spec-url="/openapi.yaml" expand-responses="200" hide-download-button path-in-middle-panel required-props-first></redoc>
21+
<redoc spec-url="/openapi.yaml" expand-responses="200" hide-download-button path-in-middle-panel required-props-first no-auto-auth></redoc>
2222
<script src="/redoc.standalone.js"> </script>
2323
</body>
2424
</html>

openapi.yaml

Lines changed: 11 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ info:
2828
[View our Changelog](/changelog) to see release
2929
notes on all changes made to our API.
3030
31-
# Access
31+
# Access and Authentication
3232
3333
Some endpoints are publicly accessible without requiring authentication.
3434
All endpoints affecting your Account, however, require either a Personal
@@ -44,6 +44,12 @@ info:
4444
All scopes for the OAuth security model (defined below) apply to this
4545
security model as well.
4646
47+
### Authentication
48+
49+
| Security Scheme Type: | HTTP |
50+
|-----------------------|------|
51+
| **HTTP Authorization Scheme** | bearer |
52+
4753
## OAuth
4854
4955
The OAuth workflow is a three-step process to authenticate a User before an
@@ -91,10 +97,11 @@ info:
9197
Authorization: Bearer 03d084436a6c91fbafd5c4b20c82e5056a2e9ce1635920c30dc8d81dc7a6665c
9298
```
9399
94-
## Authentication Schema
100+
### Authentication
95101
96-
See our [Authentication Schema](/#section/Authentication) for
97-
information on scopes and authorization/token URLs.
102+
| Security Scheme Type: | Oauth2 |
103+
|-----------------------|--------|
104+
| **AuthorizationCode Oauth Flow** | **Authorization URL:** https://login.linode.com/oauth/authorize<br />**Token URL:** https://login.linode.com/oauth/token<br />**Scopes:**<br /><ul><li>`account:read_only` - Allows access to GET information about your Account.</li><li>`account:read_write` - Allows access to all endpoints related to your Account.</li><li>`domains:read_only` - Allows access to GET Domains on your Account.</li><li>`domains:read_write` - Allows access to all Domain endpoints.</li><li>`events:read_only` - Allows access to GET your Events.</li><li>`events:read_write` - Allows access to all endpoints related to your Events.</li><li>`images:read_only` - Allows access to GET your Images.</li><li>`images:read_write` - Allows access to all endpoints related to your Images.</li><li>`ips:read_only` - Allows access to GET your ips.</li><li>`ips:read_write` - Allows access to all endpoints related to your ips.</li><li>`linodes:read_only` - Allows access to GET Linodes on your Account.</li><li>`linodes:read_write` - Allow access to all endpoints related to your Linodes.</li><li>`longview:read_only` - Allows access to GET your Longview Clients.</li><li>`longview:read_write` - Allows access to all endpoints related to your Longview Clients.</li><li>`nodebalancers:read_only` - Allows access to GET NodeBalancers on your Account.</li><li>`nodebalancers:read_write` - Allows access to all NodeBalancer endpoints.</li><li>`stackscripts:read_only` - Allows access to GET your StackScripts.</li><li>`stackscripts:read_write` - Allows access to all endpoints related to your StackScripts.</li><li>`volumes:read_only` - Allows access to GET your Volumes.</li><li>`volumes:read_write` - Allows access to all endpoints related to your Volumes.</li></ul><br />|
98105
99106
# Requests
100107

0 commit comments

Comments
 (0)