Skip to content

Commit 34a543c

Browse files
RobertDeRoseRobertDeRose
committed
Renamed Clients to OAuth Clients
1 parent c039c1a commit 34a543c

File tree

1 file changed

+36
-26
lines changed

1 file changed

+36
-26
lines changed

‎docs/src/data/endpoints/account.yaml

Lines changed: 36 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -52,8 +52,8 @@ endpoints:
5252
my_settings.country = 'US'
5353
my_settings.email = '[email protected]'
5454
my_settings.save()
55-
/account/clients:
56-
group: Clients
55+
/account/oauth-clients:
56+
group: OAuth Clients
5757
authenticated: true
5858
description: >
5959
Manage the collection of OAuth client applications your account may access.
@@ -63,11 +63,13 @@ endpoints:
6363
paginationKey: clients
6464
oauth: clients:view
6565
description: >
66-
Returns a list of clients.
66+
Returns a list of OAuth clients for your user. If you are an admin
67+
user, you will see all OAuth clients associated with all users on your
68+
account.
6769
examples:
6870
curl: |
6971
curl -H "Authorization: Bearer $TOKEN" \
70-
https://$api_root/$version/account/clients
72+
https://$api_root/$version/account/oauth-clients
7173
python: |
7274
my_clients = client.account.get_oauth_clients()
7375
POST:
@@ -83,6 +85,11 @@ endpoints:
8385
description: A URL to redirect to after the OAuth flow has completed.
8486
type: String
8587
limit: "1-512 characters"
88+
public:
89+
description: Whether this client is intended will use the implicit
90+
OAuth flow because it cannot safely store the client_secrete.
91+
An example of this would be a Single-Page Application (SPA) for
92+
the Web.
8693
examples:
8794
curl: |
8895
curl -H "Content-Type: application/json" \
@@ -91,15 +98,16 @@ endpoints:
9198
"label": "Example app",
9299
"redirect_uri": "https://oauthreturn.example.org/",
93100
}' \
94-
https://$api_root/$version/account/clients
101+
https://$api_root/$version/account/oauth-clients
95102
python: |
96103
new_client = client.account.create_oauth_client('Example app', 'https://oauthreturn.example.org/')
97-
/account/clients/$id:
98-
group: Clients
104+
/account/oauth-clients/$id:
105+
group: OAuth Clients
99106
type: resource
100107
authenticated: true
101108
description: >
102109
Manage a particular OAuth client application your account may access.
110+
Admin users can manage any OAuth client associated with this account.
103111
methods:
104112
GET:
105113
response: client
@@ -109,7 +117,7 @@ endpoints:
109117
examples:
110118
curl: |
111119
curl -H "Authorization: Bearer $TOKEN" \
112-
https://$api_root/$version/account/clients/$client_id
120+
https://$api_root/$version/account/oauth-clients/$client_id
113121
python: |
114122
my_client = linode.OAuthClient(client, 123)
115123
PUT:
@@ -124,7 +132,7 @@ endpoints:
124132
"name": "Updated app name",
125133
"redirect_uri": "https://newredirect.example.org/",
126134
}' \
127-
https://$api_root/$version/account/clients/$client_id
135+
https://$api_root/$version/account/oauth-clients/$client_id
128136
python: |
129137
my_client.name = 'Updated app name'
130138
my_client.save()
@@ -133,16 +141,18 @@ endpoints:
133141
dangerous: true
134142
description: >
135143
Delete this OAuth application. This action cannot be undone.
144+
Once an OAuth Application is deleted, all associated OAuth
145+
tokens that were generated on its behalf are expired as well.
136146
examples:
137147
curl: |
138148
curl -H "Authorization: Bearer $TOKEN" \
139149
-X DELETE \
140-
https://$api_root/$version/account/clients/$client_id
150+
https://$api_root/$version/account/oauth-clients/$client_id
141151
python: |
142152
my_client = linode.OAuthClient(client, 123)
143153
my_client.delete()
144-
/account/clients/$id/reset_secret:
145-
group: Clients
154+
/account/oauth-clients/$id/reset_secret:
155+
group: OAuth Clients
146156
type: Action
147157
authenticated: true
148158
description: >
@@ -156,12 +166,12 @@ endpoints:
156166
curl -H "Content-Type: application/json" \
157167
-H "Authorization: Bearer $TOKEN" \
158168
-X POST \
159-
https://$api_root/$version/account/clients/$client_id/reset_secret
169+
https://$api_root/$version/account/oauth-clients/$client_id/reset_secret
160170
python: |
161171
my_client = linode.OAuthClient(client, 123)
162172
new_secret = my_client.reset_secret()
163-
/account/clients/$id/thumbnail:
164-
group: Clients
173+
/account/oauth-clients/$id/thumbnail:
174+
group: OAuth Clients
165175
type: Action
166176
authenticated: true
167177
description: >
@@ -174,7 +184,7 @@ endpoints:
174184
examples:
175185
curl: |
176186
curl -H "Authorization: Bearer $TOKEN" \
177-
https://$api_root/$version/account/clients/$client_id/thumbnail
187+
https://$api_root/$version/account/oauth-clients/$client_id/thumbnail
178188
python: |
179189
img = my_client.get_thumbnail()
180190
@@ -191,7 +201,7 @@ endpoints:
191201
-H "Authorization: Bearer $TOKEN" \
192202
-X PUT \
193203
--data-binary "@/path/to/image"
194-
https://$api_root/$version/account/clients/$client_id/thumbnail
204+
https://$api_root/$version/account/oauth-clients/$client_id/thumbnail
195205
python: |
196206
my_client = linode.OAuthClient(client, 123)
197207
my_client.set_thumbnail('/path/to/image')
@@ -342,8 +352,8 @@ endpoints:
342352
343353
my_user.grants.global.add_linodes = True
344354
my_user.grants.save()
345-
/account/clients:
346-
group: Clients
355+
/account/oauth-clients:
356+
group: OAuth Clients
347357
authenticated: true
348358
description: >
349359
Manage the collection of OAuth client applications your account may access.
@@ -357,7 +367,7 @@ endpoints:
357367
examples:
358368
curl: |
359369
curl -H "Authorization: Bearer $TOKEN" \
360-
https://$api_root/$version/account/clients
370+
https://$api_root/$version/account/oauth-clients
361371
POST:
362372
oauth: clients:create
363373
description: >
@@ -379,9 +389,9 @@ endpoints:
379389
"name": "Example app",
380390
"redirect_uri": "https://oauthreturn.example.org/",
381391
}' \
382-
https://$api_root/$version/account/clients
383-
/account/clients/$id:
384-
group: Clients
392+
https://$api_root/$version/account/oauth-clients
393+
/account/oauth-clients/$id:
394+
group: OAuth Clients
385395
type: resource
386396
authenticated: true
387397
description: >
@@ -395,7 +405,7 @@ endpoints:
395405
examples:
396406
curl: |
397407
curl -H "Authorization: Bearer $TOKEN" \
398-
https://$api_root/$version/account/clients/$client_id
408+
https://$api_root/$version/account/oauth-clients/$client_id
399409
PUT:
400410
oauth: clients:modify
401411
description: >
@@ -408,7 +418,7 @@ endpoints:
408418
"name": "Updated app name",
409419
"redirect_uri": "https://newredirect.example.org/",
410420
}' \
411-
https://$api_root/$version/account/clients/$client_id
421+
https://$api_root/$version/account/oauth-clients/$client_id
412422
DELETE:
413423
oauth: clients:delete
414424
dangerous: true
@@ -418,7 +428,7 @@ endpoints:
418428
curl: |
419429
curl -H "Authorization: Bearer $TOKEN" \
420430
-X DELETE \
421-
https://$api_root/$version/account/clients/$client_id
431+
https://$api_root/$version/account/oauth-clients/$client_id
422432
/account/events:
423433
group: Events
424434
authenticated: true

0 commit comments

Comments
 (0)