• 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.verificationCodes.html">verificationCodes</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78  <code><a href="#generate">generate(userKey)</a></code></p>
79<p class="firstline">Generate new backup verification codes for the user.</p>
80<p class="toc_element">
81  <code><a href="#invalidate">invalidate(userKey)</a></code></p>
82<p class="firstline">Invalidate the current backup verification codes for the user.</p>
83<p class="toc_element">
84  <code><a href="#list">list(userKey)</a></code></p>
85<p class="firstline">Returns the current set of valid backup verification codes for the specified user.</p>
86<h3>Method Details</h3>
87<div class="method">
88    <code class="details" id="generate">generate(userKey)</code>
89  <pre>Generate new backup verification codes for the user.
90
91Args:
92  userKey: string, Email or immutable ID of the user (required)
93</pre>
94</div>
95
96<div class="method">
97    <code class="details" id="invalidate">invalidate(userKey)</code>
98  <pre>Invalidate the current backup verification codes for the user.
99
100Args:
101  userKey: string, Email or immutable ID of the user (required)
102</pre>
103</div>
104
105<div class="method">
106    <code class="details" id="list">list(userKey)</code>
107  <pre>Returns the current set of valid backup verification codes for the specified user.
108
109Args:
110  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)
111
112Returns:
113  An object of the form:
114
115    { # JSON response template for List verification codes operation in Directory API.
116    "items": [ # A list of verification code resources.
117      { # JSON template for verification codes in Directory API.
118        "kind": "admin#directory#verificationCode", # The type of the resource. This is always admin#directory#verificationCode.
119        "etag": "A String", # ETag of the resource.
120        "userId": "A String", # The obfuscated unique ID of the user.
121        "verificationCode": "A String", # A current verification code for the user. Invalidated or used verification codes are not returned as part of the result.
122      },
123    ],
124    "kind": "admin#directory#verificationCodesList", # The type of the resource. This is always admin#directory#verificationCodesList.
125    "etag": "A String", # ETag of the resource.
126  }</pre>
127</div>
128
129</body></html>