1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
|
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="admin_directory_v1.html">Admin Directory API</a> . <a href="admin_directory_v1.schemas.html">schemas</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#delete">delete(customerId, schemaKey)</a></code></p>
<p class="firstline">Delete schema</p>
<p class="toc_element">
<code><a href="#get">get(customerId, schemaKey)</a></code></p>
<p class="firstline">Retrieve schema</p>
<p class="toc_element">
<code><a href="#insert">insert(customerId, body)</a></code></p>
<p class="firstline">Create schema.</p>
<p class="toc_element">
<code><a href="#list">list(customerId)</a></code></p>
<p class="firstline">Retrieve all schemas for a customer</p>
<p class="toc_element">
<code><a href="#patch">patch(customerId, schemaKey, body)</a></code></p>
<p class="firstline">Update schema. This method supports patch semantics.</p>
<p class="toc_element">
<code><a href="#update">update(customerId, schemaKey, body)</a></code></p>
<p class="firstline">Update schema</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="delete">delete(customerId, schemaKey)</code>
<pre>Delete schema
Args:
customerId: string, Immutable id of the Google Apps account (required)
schemaKey: string, Name or immutable Id of the schema (required)
</pre>
</div>
<div class="method">
<code class="details" id="get">get(customerId, schemaKey)</code>
<pre>Retrieve schema
Args:
customerId: string, Immutable id of the Google Apps account (required)
schemaKey: string, Name or immutable Id of the schema (required)
Returns:
An object of the form:
{ # JSON template for Schema resource in Directory API.
"fields": [ # Fields of Schema
{ # JSON template for FieldSpec resource for Schemas in Directory API.
"kind": "admin#directory#schema#fieldspec", # Kind of resource this is.
"etag": "A String", # ETag of the resource.
"fieldName": "A String", # Name of the field.
"fieldType": "A String", # Type of the field.
"indexed": true, # Boolean specifying whether the field is indexed or not.
"readAccessType": "ALL_DOMAIN_USERS", # Read ACLs on the field specifying who can view values of this field. Valid values are "ALL_DOMAIN_USERS" and "ADMINS_AND_SELF".
"numericIndexingSpec": { # Indexing spec for a numeric field. By default, only exact match queries will be supported for numeric fields. Setting the numericIndexingSpec allows range queries to be supported.
"maxValue": 3.14, # Maximum value of this field. This is meant to be indicative rather than enforced. Values outside this range will still be indexed, but search may not be as performant.
"minValue": 3.14, # Minimum value of this field. This is meant to be indicative rather than enforced. Values outside this range will still be indexed, but search may not be as performant.
},
"fieldId": "A String", # Unique identifier of Field (Read-only)
"multiValued": True or False, # Boolean specifying whether this is a multi-valued field or not.
},
],
"kind": "admin#directory#schema", # Kind of resource this is.
"etag": "A String", # ETag of the resource.
"schemaId": "A String", # Unique identifier of Schema (Read-only)
"schemaName": "A String", # Schema name
}</pre>
</div>
<div class="method">
<code class="details" id="insert">insert(customerId, body)</code>
<pre>Create schema.
Args:
customerId: string, Immutable id of the Google Apps account (required)
body: object, The request body. (required)
The object takes the form of:
{ # JSON template for Schema resource in Directory API.
"fields": [ # Fields of Schema
{ # JSON template for FieldSpec resource for Schemas in Directory API.
"kind": "admin#directory#schema#fieldspec", # Kind of resource this is.
"etag": "A String", # ETag of the resource.
"fieldName": "A String", # Name of the field.
"fieldType": "A String", # Type of the field.
"indexed": true, # Boolean specifying whether the field is indexed or not.
"readAccessType": "ALL_DOMAIN_USERS", # Read ACLs on the field specifying who can view values of this field. Valid values are "ALL_DOMAIN_USERS" and "ADMINS_AND_SELF".
"numericIndexingSpec": { # Indexing spec for a numeric field. By default, only exact match queries will be supported for numeric fields. Setting the numericIndexingSpec allows range queries to be supported.
"maxValue": 3.14, # Maximum value of this field. This is meant to be indicative rather than enforced. Values outside this range will still be indexed, but search may not be as performant.
"minValue": 3.14, # Minimum value of this field. This is meant to be indicative rather than enforced. Values outside this range will still be indexed, but search may not be as performant.
},
"fieldId": "A String", # Unique identifier of Field (Read-only)
"multiValued": True or False, # Boolean specifying whether this is a multi-valued field or not.
},
],
"kind": "admin#directory#schema", # Kind of resource this is.
"etag": "A String", # ETag of the resource.
"schemaId": "A String", # Unique identifier of Schema (Read-only)
"schemaName": "A String", # Schema name
}
Returns:
An object of the form:
{ # JSON template for Schema resource in Directory API.
"fields": [ # Fields of Schema
{ # JSON template for FieldSpec resource for Schemas in Directory API.
"kind": "admin#directory#schema#fieldspec", # Kind of resource this is.
"etag": "A String", # ETag of the resource.
"fieldName": "A String", # Name of the field.
"fieldType": "A String", # Type of the field.
"indexed": true, # Boolean specifying whether the field is indexed or not.
"readAccessType": "ALL_DOMAIN_USERS", # Read ACLs on the field specifying who can view values of this field. Valid values are "ALL_DOMAIN_USERS" and "ADMINS_AND_SELF".
"numericIndexingSpec": { # Indexing spec for a numeric field. By default, only exact match queries will be supported for numeric fields. Setting the numericIndexingSpec allows range queries to be supported.
"maxValue": 3.14, # Maximum value of this field. This is meant to be indicative rather than enforced. Values outside this range will still be indexed, but search may not be as performant.
"minValue": 3.14, # Minimum value of this field. This is meant to be indicative rather than enforced. Values outside this range will still be indexed, but search may not be as performant.
},
"fieldId": "A String", # Unique identifier of Field (Read-only)
"multiValued": True or False, # Boolean specifying whether this is a multi-valued field or not.
},
],
"kind": "admin#directory#schema", # Kind of resource this is.
"etag": "A String", # ETag of the resource.
"schemaId": "A String", # Unique identifier of Schema (Read-only)
"schemaName": "A String", # Schema name
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(customerId)</code>
<pre>Retrieve all schemas for a customer
Args:
customerId: string, Immutable id of the Google Apps account (required)
Returns:
An object of the form:
{ # JSON response template for List Schema operation in Directory API.
"kind": "admin#directory#schemas", # Kind of resource this is.
"etag": "A String", # ETag of the resource.
"schemas": [ # List of UserSchema objects.
{ # JSON template for Schema resource in Directory API.
"fields": [ # Fields of Schema
{ # JSON template for FieldSpec resource for Schemas in Directory API.
"kind": "admin#directory#schema#fieldspec", # Kind of resource this is.
"etag": "A String", # ETag of the resource.
"fieldName": "A String", # Name of the field.
"fieldType": "A String", # Type of the field.
"indexed": true, # Boolean specifying whether the field is indexed or not.
"readAccessType": "ALL_DOMAIN_USERS", # Read ACLs on the field specifying who can view values of this field. Valid values are "ALL_DOMAIN_USERS" and "ADMINS_AND_SELF".
"numericIndexingSpec": { # Indexing spec for a numeric field. By default, only exact match queries will be supported for numeric fields. Setting the numericIndexingSpec allows range queries to be supported.
"maxValue": 3.14, # Maximum value of this field. This is meant to be indicative rather than enforced. Values outside this range will still be indexed, but search may not be as performant.
"minValue": 3.14, # Minimum value of this field. This is meant to be indicative rather than enforced. Values outside this range will still be indexed, but search may not be as performant.
},
"fieldId": "A String", # Unique identifier of Field (Read-only)
"multiValued": True or False, # Boolean specifying whether this is a multi-valued field or not.
},
],
"kind": "admin#directory#schema", # Kind of resource this is.
"etag": "A String", # ETag of the resource.
"schemaId": "A String", # Unique identifier of Schema (Read-only)
"schemaName": "A String", # Schema name
},
],
}</pre>
</div>
<div class="method">
<code class="details" id="patch">patch(customerId, schemaKey, body)</code>
<pre>Update schema. This method supports patch semantics.
Args:
customerId: string, Immutable id of the Google Apps account (required)
schemaKey: string, Name or immutable Id of the schema. (required)
body: object, The request body. (required)
The object takes the form of:
{ # JSON template for Schema resource in Directory API.
"fields": [ # Fields of Schema
{ # JSON template for FieldSpec resource for Schemas in Directory API.
"kind": "admin#directory#schema#fieldspec", # Kind of resource this is.
"etag": "A String", # ETag of the resource.
"fieldName": "A String", # Name of the field.
"fieldType": "A String", # Type of the field.
"indexed": true, # Boolean specifying whether the field is indexed or not.
"readAccessType": "ALL_DOMAIN_USERS", # Read ACLs on the field specifying who can view values of this field. Valid values are "ALL_DOMAIN_USERS" and "ADMINS_AND_SELF".
"numericIndexingSpec": { # Indexing spec for a numeric field. By default, only exact match queries will be supported for numeric fields. Setting the numericIndexingSpec allows range queries to be supported.
"maxValue": 3.14, # Maximum value of this field. This is meant to be indicative rather than enforced. Values outside this range will still be indexed, but search may not be as performant.
"minValue": 3.14, # Minimum value of this field. This is meant to be indicative rather than enforced. Values outside this range will still be indexed, but search may not be as performant.
},
"fieldId": "A String", # Unique identifier of Field (Read-only)
"multiValued": True or False, # Boolean specifying whether this is a multi-valued field or not.
},
],
"kind": "admin#directory#schema", # Kind of resource this is.
"etag": "A String", # ETag of the resource.
"schemaId": "A String", # Unique identifier of Schema (Read-only)
"schemaName": "A String", # Schema name
}
Returns:
An object of the form:
{ # JSON template for Schema resource in Directory API.
"fields": [ # Fields of Schema
{ # JSON template for FieldSpec resource for Schemas in Directory API.
"kind": "admin#directory#schema#fieldspec", # Kind of resource this is.
"etag": "A String", # ETag of the resource.
"fieldName": "A String", # Name of the field.
"fieldType": "A String", # Type of the field.
"indexed": true, # Boolean specifying whether the field is indexed or not.
"readAccessType": "ALL_DOMAIN_USERS", # Read ACLs on the field specifying who can view values of this field. Valid values are "ALL_DOMAIN_USERS" and "ADMINS_AND_SELF".
"numericIndexingSpec": { # Indexing spec for a numeric field. By default, only exact match queries will be supported for numeric fields. Setting the numericIndexingSpec allows range queries to be supported.
"maxValue": 3.14, # Maximum value of this field. This is meant to be indicative rather than enforced. Values outside this range will still be indexed, but search may not be as performant.
"minValue": 3.14, # Minimum value of this field. This is meant to be indicative rather than enforced. Values outside this range will still be indexed, but search may not be as performant.
},
"fieldId": "A String", # Unique identifier of Field (Read-only)
"multiValued": True or False, # Boolean specifying whether this is a multi-valued field or not.
},
],
"kind": "admin#directory#schema", # Kind of resource this is.
"etag": "A String", # ETag of the resource.
"schemaId": "A String", # Unique identifier of Schema (Read-only)
"schemaName": "A String", # Schema name
}</pre>
</div>
<div class="method">
<code class="details" id="update">update(customerId, schemaKey, body)</code>
<pre>Update schema
Args:
customerId: string, Immutable id of the Google Apps account (required)
schemaKey: string, Name or immutable Id of the schema. (required)
body: object, The request body. (required)
The object takes the form of:
{ # JSON template for Schema resource in Directory API.
"fields": [ # Fields of Schema
{ # JSON template for FieldSpec resource for Schemas in Directory API.
"kind": "admin#directory#schema#fieldspec", # Kind of resource this is.
"etag": "A String", # ETag of the resource.
"fieldName": "A String", # Name of the field.
"fieldType": "A String", # Type of the field.
"indexed": true, # Boolean specifying whether the field is indexed or not.
"readAccessType": "ALL_DOMAIN_USERS", # Read ACLs on the field specifying who can view values of this field. Valid values are "ALL_DOMAIN_USERS" and "ADMINS_AND_SELF".
"numericIndexingSpec": { # Indexing spec for a numeric field. By default, only exact match queries will be supported for numeric fields. Setting the numericIndexingSpec allows range queries to be supported.
"maxValue": 3.14, # Maximum value of this field. This is meant to be indicative rather than enforced. Values outside this range will still be indexed, but search may not be as performant.
"minValue": 3.14, # Minimum value of this field. This is meant to be indicative rather than enforced. Values outside this range will still be indexed, but search may not be as performant.
},
"fieldId": "A String", # Unique identifier of Field (Read-only)
"multiValued": True or False, # Boolean specifying whether this is a multi-valued field or not.
},
],
"kind": "admin#directory#schema", # Kind of resource this is.
"etag": "A String", # ETag of the resource.
"schemaId": "A String", # Unique identifier of Schema (Read-only)
"schemaName": "A String", # Schema name
}
Returns:
An object of the form:
{ # JSON template for Schema resource in Directory API.
"fields": [ # Fields of Schema
{ # JSON template for FieldSpec resource for Schemas in Directory API.
"kind": "admin#directory#schema#fieldspec", # Kind of resource this is.
"etag": "A String", # ETag of the resource.
"fieldName": "A String", # Name of the field.
"fieldType": "A String", # Type of the field.
"indexed": true, # Boolean specifying whether the field is indexed or not.
"readAccessType": "ALL_DOMAIN_USERS", # Read ACLs on the field specifying who can view values of this field. Valid values are "ALL_DOMAIN_USERS" and "ADMINS_AND_SELF".
"numericIndexingSpec": { # Indexing spec for a numeric field. By default, only exact match queries will be supported for numeric fields. Setting the numericIndexingSpec allows range queries to be supported.
"maxValue": 3.14, # Maximum value of this field. This is meant to be indicative rather than enforced. Values outside this range will still be indexed, but search may not be as performant.
"minValue": 3.14, # Minimum value of this field. This is meant to be indicative rather than enforced. Values outside this range will still be indexed, but search may not be as performant.
},
"fieldId": "A String", # Unique identifier of Field (Read-only)
"multiValued": True or False, # Boolean specifying whether this is a multi-valued field or not.
},
],
"kind": "admin#directory#schema", # Kind of resource this is.
"etag": "A String", # ETag of the resource.
"schemaId": "A String", # Unique identifier of Schema (Read-only)
"schemaName": "A String", # Schema name
}</pre>
</div>
</body></html>
|
