• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1<html><body>
2<style>
3
4body, h1, h2, h3, div, span, p, pre, a {
5  margin: 0;
6  padding: 0;
7  border: 0;
8  font-weight: inherit;
9  font-style: inherit;
10  font-size: 100%;
11  font-family: inherit;
12  vertical-align: baseline;
13}
14
15body {
16  font-size: 13px;
17  padding: 1em;
18}
19
20h1 {
21  font-size: 26px;
22  margin-bottom: 1em;
23}
24
25h2 {
26  font-size: 24px;
27  margin-bottom: 1em;
28}
29
30h3 {
31  font-size: 20px;
32  margin-bottom: 1em;
33  margin-top: 1em;
34}
35
36pre, code {
37  line-height: 1.5;
38  font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42  margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46  font-family: Arial, sans serif;
47}
48
49h1, h2, h3 {
50  border-bottom: solid #CCC 1px;
51}
52
53.toc_element {
54  margin-top: 0.5em;
55}
56
57.firstline {
58  margin-left: 2 em;
59}
60
61.method  {
62  margin-top: 1em;
63  border: solid 1px #CCC;
64  padding: 1em;
65  background: #EEE;
66}
67
68.details {
69  font-weight: bold;
70  font-size: 14px;
71}
72
73</style>
74
75<h1><a href="admin_directory_v1.html">Admin Directory API</a> . <a href="admin_directory_v1.tokens.html">tokens</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78  <code><a href="#delete">delete(userKey, clientId)</a></code></p>
79<p class="firstline">Delete all access tokens issued by a user for an application.</p>
80<p class="toc_element">
81  <code><a href="#get">get(userKey, clientId)</a></code></p>
82<p class="firstline">Get information about an access token issued by a user.</p>
83<p class="toc_element">
84  <code><a href="#list">list(userKey)</a></code></p>
85<p class="firstline">Returns the set of tokens specified user has issued to 3rd party applications.</p>
86<h3>Method Details</h3>
87<div class="method">
88    <code class="details" id="delete">delete(userKey, clientId)</code>
89  <pre>Delete all access tokens issued by a user for an application.
90
91Args:
92  userKey: string, Identifies the user in the API request. The value can be the user's primary email address, alias email address, or unique user ID. (required)
93  clientId: string, The Client ID of the application the token is issued to. (required)
94</pre>
95</div>
96
97<div class="method">
98    <code class="details" id="get">get(userKey, clientId)</code>
99  <pre>Get information about an access token issued by a user.
100
101Args:
102  userKey: string, Identifies the user in the API request. The value can be the user's primary email address, alias email address, or unique user ID. (required)
103  clientId: string, The Client ID of the application the token is issued to. (required)
104
105Returns:
106  An object of the form:
107
108    { # JSON template for token resource in Directory API.
109    "scopes": [ # A list of authorization scopes the application is granted.
110      "A String",
111    ],
112    "kind": "admin#directory#token", # The type of the API resource. This is always admin#directory#token.
113    "nativeApp": True or False, # Whether the token is issued to an installed application. The value is true if the application is installed to a desktop or mobile device.
114    "clientId": "A String", # The Client ID of the application the token is issued to.
115    "etag": "A String", # ETag of the resource.
116    "displayText": "A String", # The displayable name of the application the token is issued to.
117    "anonymous": True or False, # Whether the application is registered with Google. The value is true if the application has an anonymous Client ID.
118    "userKey": "A String", # The unique ID of the user that issued the token.
119  }</pre>
120</div>
121
122<div class="method">
123    <code class="details" id="list">list(userKey)</code>
124  <pre>Returns the set of tokens specified user has issued to 3rd party applications.
125
126Args:
127  userKey: string, Identifies the user in the API request. The value can be the user's primary email address, alias email address, or unique user ID. (required)
128
129Returns:
130  An object of the form:
131
132    { # JSON response template for List tokens operation in Directory API.
133    "items": [ # A list of Token resources.
134      { # JSON template for token resource in Directory API.
135        "scopes": [ # A list of authorization scopes the application is granted.
136          "A String",
137        ],
138        "kind": "admin#directory#token", # The type of the API resource. This is always admin#directory#token.
139        "nativeApp": True or False, # Whether the token is issued to an installed application. The value is true if the application is installed to a desktop or mobile device.
140        "clientId": "A String", # The Client ID of the application the token is issued to.
141        "etag": "A String", # ETag of the resource.
142        "displayText": "A String", # The displayable name of the application the token is issued to.
143        "anonymous": True or False, # Whether the application is registered with Google. The value is true if the application has an anonymous Client ID.
144        "userKey": "A String", # The unique ID of the user that issued the token.
145      },
146    ],
147    "kind": "admin#directory#tokenList", # The type of the API resource. This is always admin#directory#tokenList.
148    "etag": "A String", # ETag of the resource.
149  }</pre>
150</div>
151
152</body></html>