← Back to branch summary

~nskaggs/+junk/xenial-test

« back to all changes in this revision

Viewing changes to src/google.golang.org/api/oauth2/v1/oauth2-api.json

  • Committer: Nicholas Skaggs
  • Date: 2016-10-24 20:56:05 UTC
  • Revision ID: nicholas.skaggs@canonical.com-20161024205605-z8lta0uvuhtxwzwl
Initi with beta15

Show diffs side-by-side

added added

removed removed

Lines of Context:
src/google.golang.org/api/oauth2/v1/oauth2-api.json
 
1
{
 
2
 "kind": "discovery#restDescription",
 
3
 "etag": "\"l66ggWbucbkBw9Lpos72oziyefE/g--M527nWAL87owNTr8x3Q5-90U\"",
 
4
 "discoveryVersion": "v1",
 
5
 "id": "oauth2:v1",
 
6
 "name": "oauth2",
 
7
 "version": "v1",
 
8
 "revision": "20141029",
 
9
 "title": "Google OAuth2 API",
 
10
 "description": "Lets you access OAuth2 protocol related APIs.",
 
11
 "ownerDomain": "google.com",
 
12
 "ownerName": "Google",
 
13
 "icons": {
 
14
  "x16": "http://www.google.com/images/icons/product/search-16.gif",
 
15
  "x32": "http://www.google.com/images/icons/product/search-32.gif"
 
16
 },
 
17
 "documentationLink": "https://developers.google.com/accounts/docs/OAuth2",
 
18
 "protocol": "rest",
 
19
 "baseUrl": "https://www.googleapis.com/",
 
20
 "basePath": "/",
 
21
 "rootUrl": "https://www.googleapis.com/",
 
22
 "servicePath": "",
 
23
 "batchPath": "batch",
 
24
 "parameters": {
 
25
  "alt": {
 
26
   "type": "string",
 
27
   "description": "Data format for the response.",
 
28
   "default": "json",
 
29
   "enum": [
 
30
    "json"
 
31
   ],
 
32
   "enumDescriptions": [
 
33
    "Responses with Content-Type of application/json"
 
34
   ],
 
35
   "location": "query"
 
36
  },
 
37
  "fields": {
 
38
   "type": "string",
 
39
   "description": "Selector specifying which fields to include in a partial response.",
 
40
   "location": "query"
 
41
  },
 
42
  "key": {
 
43
   "type": "string",
 
44
   "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
 
45
   "location": "query"
 
46
  },
 
47
  "oauth_token": {
 
48
   "type": "string",
 
49
   "description": "OAuth 2.0 token for the current user.",
 
50
   "location": "query"
 
51
  },
 
52
  "prettyPrint": {
 
53
   "type": "boolean",
 
54
   "description": "Returns response with indentations and line breaks.",
 
55
   "default": "true",
 
56
   "location": "query"
 
57
  },
 
58
  "quotaUser": {
 
59
   "type": "string",
 
60
   "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.",
 
61
   "location": "query"
 
62
  },
 
63
  "userIp": {
 
64
   "type": "string",
 
65
   "description": "IP address of the site where the request originates. Use this if you want to enforce per-user limits.",
 
66
   "location": "query"
 
67
  }
 
68
 },
 
69
 "auth": {
 
70
  "oauth2": {
 
71
   "scopes": {
 
72
    "https://www.googleapis.com/auth/plus.login": {
 
73
     "description": "Know your basic profile info and list of people in your circles."
 
74
    },
 
75
    "https://www.googleapis.com/auth/plus.me": {
 
76
     "description": "Know who you are on Google"
 
77
    },
 
78
    "https://www.googleapis.com/auth/userinfo.email": {
 
79
     "description": "View your email address"
 
80
    },
 
81
    "https://www.googleapis.com/auth/userinfo.profile": {
 
82
     "description": "View your basic profile info"
 
83
    }
 
84
   }
 
85
  }
 
86
 },
 
87
 "schemas": {
 
88
  "Tokeninfo": {
 
89
   "id": "Tokeninfo",
 
90
   "type": "object",
 
91
   "properties": {
 
92
    "access_type": {
 
93
     "type": "string",
 
94
     "description": "The access type granted with this token. It can be offline or online."
 
95
    },
 
96
    "audience": {
 
97
     "type": "string",
 
98
     "description": "Who is the intended audience for this token. In general the same as issued_to."
 
99
    },
 
100
    "email": {
 
101
     "type": "string",
 
102
     "description": "The email address of the user. Present only if the email scope is present in the request."
 
103
    },
 
104
    "email_verified": {
 
105
     "type": "boolean",
 
106
     "description": "Boolean flag which is true if the email address is verified. Present only if the email scope is present in the request."
 
107
    },
 
108
    "expires_in": {
 
109
     "type": "integer",
 
110
     "description": "The expiry time of the token, as number of seconds left until expiry.",
 
111
     "format": "int32"
 
112
    },
 
113
    "issued_at": {
 
114
     "type": "integer",
 
115
     "description": "The issue time of the token, as number of seconds.",
 
116
     "format": "int32"
 
117
    },
 
118
    "issued_to": {
 
119
     "type": "string",
 
120
     "description": "To whom was the token issued to. In general the same as audience."
 
121
    },
 
122
    "issuer": {
 
123
     "type": "string",
 
124
     "description": "Who issued the token."
 
125
    },
 
126
    "nonce": {
 
127
     "type": "string",
 
128
     "description": "Nonce of the id token."
 
129
    },
 
130
    "scope": {
 
131
     "type": "string",
 
132
     "description": "The space separated list of scopes granted to this token."
 
133
    },
 
134
    "user_id": {
 
135
     "type": "string",
 
136
     "description": "The Gaia obfuscated user id."
 
137
    },
 
138
    "verified_email": {
 
139
     "type": "boolean",
 
140
     "description": "Boolean flag which is true if the email address is verified. Present only if the email scope is present in the request."
 
141
    }
 
142
   }
 
143
  },
 
144
  "Userinfoplus": {
 
145
   "id": "Userinfoplus",
 
146
   "type": "object",
 
147
   "properties": {
 
148
    "email": {
 
149
     "type": "string",
 
150
     "description": "The user's email address."
 
151
    },
 
152
    "family_name": {
 
153
     "type": "string",
 
154
     "description": "The user's last name."
 
155
    },
 
156
    "gender": {
 
157
     "type": "string",
 
158
     "description": "The user's gender."
 
159
    },
 
160
    "given_name": {
 
161
     "type": "string",
 
162
     "description": "The user's first name."
 
163
    },
 
164
    "hd": {
 
165
     "type": "string",
 
166
     "description": "The hosted domain e.g. example.com if the user is Google apps user."
 
167
    },
 
168
    "id": {
 
169
     "type": "string",
 
170
     "description": "The focus obfuscated gaia id of the user."
 
171
    },
 
172
    "link": {
 
173
     "type": "string",
 
174
     "description": "URL of the profile page."
 
175
    },
 
176
    "locale": {
 
177
     "type": "string",
 
178
     "description": "The user's preferred locale."
 
179
    },
 
180
    "name": {
 
181
     "type": "string",
 
182
     "description": "The user's full name."
 
183
    },
 
184
    "picture": {
 
185
     "type": "string",
 
186
     "description": "URL of the user's picture image."
 
187
    },
 
188
    "verified_email": {
 
189
     "type": "boolean",
 
190
     "description": "Boolean flag which is true if the email address is verified. Always verified because we only return the user's primary email address.",
 
191
     "default": "true"
 
192
    }
 
193
   }
 
194
  }
 
195
 },
 
196
 "methods": {
 
197
  "tokeninfo": {
 
198
   "id": "oauth2.tokeninfo",
 
199
   "path": "oauth2/v1/tokeninfo",
 
200
   "httpMethod": "POST",
 
201
   "description": "Get token info",
 
202
   "parameters": {
 
203
    "access_token": {
 
204
     "type": "string",
 
205
     "description": "The oauth2 access token",
 
206
     "location": "query"
 
207
    },
 
208
    "id_token": {
 
209
     "type": "string",
 
210
     "description": "The ID token",
 
211
     "location": "query"
 
212
    }
 
213
   },
 
214
   "response": {
 
215
    "$ref": "Tokeninfo"
 
216
   }
 
217
  }
 
218
 },
 
219
 "resources": {
 
220
  "userinfo": {
 
221
   "methods": {
 
222
    "get": {
 
223
     "id": "oauth2.userinfo.get",
 
224
     "path": "oauth2/v1/userinfo",
 
225
     "httpMethod": "GET",
 
226
     "description": "Get user info",
 
227
     "response": {
 
228
      "$ref": "Userinfoplus"
 
229
     },
 
230
     "scopes": [
 
231
      "https://www.googleapis.com/auth/plus.login",
 
232
      "https://www.googleapis.com/auth/plus.me",
 
233
      "https://www.googleapis.com/auth/userinfo.email",
 
234
      "https://www.googleapis.com/auth/userinfo.profile"
 
235
     ]
 
236
    }
 
237
   },
 
238
   "resources": {
 
239
    "v2": {
 
240
     "resources": {
 
241
      "me": {
 
242
       "methods": {
 
243
        "get": {
 
244
         "id": "oauth2.userinfo.v2.me.get",
 
245
         "path": "userinfo/v2/me",
 
246
         "httpMethod": "GET",
 
247
         "description": "Get user info",
 
248
         "response": {
 
249
          "$ref": "Userinfoplus"
 
250
         },
 
251
         "scopes": [
 
252
          "https://www.googleapis.com/auth/plus.login",
 
253
          "https://www.googleapis.com/auth/plus.me",
 
254
          "https://www.googleapis.com/auth/userinfo.email",
 
255
          "https://www.googleapis.com/auth/userinfo.profile"
 
256
         ]
 
257
        }
 
258
       }
 
259
      }
 
260
     }
 
261
    }
 
262
   }
 
263
  }
 
264
 }
 
265
}