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
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
|
<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 SDK API</a> . <a href="admin_directory_v1.schemas.html">schemas</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
<code><a href="#delete">delete(customerId, schemaKey, x__xgafv=None)</a></code></p>
<p class="firstline">Deletes a schema.</p>
<p class="toc_element">
<code><a href="#get">get(customerId, schemaKey, x__xgafv=None)</a></code></p>
<p class="firstline">Retrieves a schema.</p>
<p class="toc_element">
<code><a href="#insert">insert(customerId, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Creates a schema.</p>
<p class="toc_element">
<code><a href="#list">list(customerId, x__xgafv=None)</a></code></p>
<p class="firstline">Retrieves all schemas for a customer.</p>
<p class="toc_element">
<code><a href="#patch">patch(customerId, schemaKey, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Patches a schema.</p>
<p class="toc_element">
<code><a href="#update">update(customerId, schemaKey, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Updates a schema.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="close">close()</code>
<pre>Close httplib2 connections.</pre>
</div>
<div class="method">
<code class="details" id="delete">delete(customerId, schemaKey, x__xgafv=None)</code>
<pre>Deletes a schema.
Args:
customerId: string, Immutable ID of the Google Workspace account. (required)
schemaKey: string, Name or immutable ID of the schema. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
</pre>
</div>
<div class="method">
<code class="details" id="get">get(customerId, schemaKey, x__xgafv=None)</code>
<pre>Retrieves a schema.
Args:
customerId: string, The unique ID for the customer's Google Workspace account. In case of a multi-domain account, to fetch all groups for a customer, use this field instead of `domain`. You can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users](https://developers.google.com/workspace/admin/directory/v1/reference/users) resource. You must provide either the `customer` or the `domain` parameter. (required)
schemaKey: string, Name or immutable ID of the schema. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # The type of API resource. For Schema resources, this is always `admin#directory#schema`.
"displayName": "A String", # Display name for the schema.
"etag": "A String", # The ETag of the resource.
"fields": [ # A list of fields in the schema.
{ # You can use schemas to add custom fields to user profiles. You can use these fields to store information such as the projects your users work on, their physical locations, their hire dates, or whatever else fits your business needs. For more information, see [Custom User Fields](https://developers.google.com/workspace/admin/directory/v1/guides/manage-schemas).
"displayName": "A String", # Display Name of the field.
"etag": "A String", # The ETag of the field.
"fieldId": "A String", # The unique identifier of the field (Read-only)
"fieldName": "A String", # The name of the field.
"fieldType": "A String", # The type of the field.
"indexed": true, # Boolean specifying whether the field is indexed or not. Default: `true`.
"kind": "admin#directory#schema#fieldspec", # The kind of resource this is. For schema fields this is always `admin#directory#schema#fieldspec`.
"multiValued": True or False, # A boolean specifying whether this is a multi-valued field or not. Default: `false`.
"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.
},
"readAccessType": "ALL_DOMAIN_USERS", # Specifies who can view values of this field. See [Retrieve users as a non-administrator](https://developers.google.com/workspace/admin/directory/v1/guides/manage-users#retrieve_users_non_admin) for more information. Note: It may take up to 24 hours for changes to this field to be reflected.
},
],
"kind": "admin#directory#schema", # Kind of resource this is.
"schemaId": "A String", # The unique identifier of the schema (Read-only)
"schemaName": "A String", # The schema's name. Each `schema_name` must be unique within a customer. Reusing a name results in a `409: Entity already exists` error.
}</pre>
</div>
<div class="method">
<code class="details" id="insert">insert(customerId, body=None, x__xgafv=None)</code>
<pre>Creates a schema.
Args:
customerId: string, Immutable ID of the Google Workspace account. (required)
body: object, The request body.
The object takes the form of:
{ # The type of API resource. For Schema resources, this is always `admin#directory#schema`.
"displayName": "A String", # Display name for the schema.
"etag": "A String", # The ETag of the resource.
"fields": [ # A list of fields in the schema.
{ # You can use schemas to add custom fields to user profiles. You can use these fields to store information such as the projects your users work on, their physical locations, their hire dates, or whatever else fits your business needs. For more information, see [Custom User Fields](https://developers.google.com/workspace/admin/directory/v1/guides/manage-schemas).
"displayName": "A String", # Display Name of the field.
"etag": "A String", # The ETag of the field.
"fieldId": "A String", # The unique identifier of the field (Read-only)
"fieldName": "A String", # The name of the field.
"fieldType": "A String", # The type of the field.
"indexed": true, # Boolean specifying whether the field is indexed or not. Default: `true`.
"kind": "admin#directory#schema#fieldspec", # The kind of resource this is. For schema fields this is always `admin#directory#schema#fieldspec`.
"multiValued": True or False, # A boolean specifying whether this is a multi-valued field or not. Default: `false`.
"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.
},
"readAccessType": "ALL_DOMAIN_USERS", # Specifies who can view values of this field. See [Retrieve users as a non-administrator](https://developers.google.com/workspace/admin/directory/v1/guides/manage-users#retrieve_users_non_admin) for more information. Note: It may take up to 24 hours for changes to this field to be reflected.
},
],
"kind": "admin#directory#schema", # Kind of resource this is.
"schemaId": "A String", # The unique identifier of the schema (Read-only)
"schemaName": "A String", # The schema's name. Each `schema_name` must be unique within a customer. Reusing a name results in a `409: Entity already exists` error.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # The type of API resource. For Schema resources, this is always `admin#directory#schema`.
"displayName": "A String", # Display name for the schema.
"etag": "A String", # The ETag of the resource.
"fields": [ # A list of fields in the schema.
{ # You can use schemas to add custom fields to user profiles. You can use these fields to store information such as the projects your users work on, their physical locations, their hire dates, or whatever else fits your business needs. For more information, see [Custom User Fields](https://developers.google.com/workspace/admin/directory/v1/guides/manage-schemas).
"displayName": "A String", # Display Name of the field.
"etag": "A String", # The ETag of the field.
"fieldId": "A String", # The unique identifier of the field (Read-only)
"fieldName": "A String", # The name of the field.
"fieldType": "A String", # The type of the field.
"indexed": true, # Boolean specifying whether the field is indexed or not. Default: `true`.
"kind": "admin#directory#schema#fieldspec", # The kind of resource this is. For schema fields this is always `admin#directory#schema#fieldspec`.
"multiValued": True or False, # A boolean specifying whether this is a multi-valued field or not. Default: `false`.
"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.
},
"readAccessType": "ALL_DOMAIN_USERS", # Specifies who can view values of this field. See [Retrieve users as a non-administrator](https://developers.google.com/workspace/admin/directory/v1/guides/manage-users#retrieve_users_non_admin) for more information. Note: It may take up to 24 hours for changes to this field to be reflected.
},
],
"kind": "admin#directory#schema", # Kind of resource this is.
"schemaId": "A String", # The unique identifier of the schema (Read-only)
"schemaName": "A String", # The schema's name. Each `schema_name` must be unique within a customer. Reusing a name results in a `409: Entity already exists` error.
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(customerId, x__xgafv=None)</code>
<pre>Retrieves all schemas for a customer.
Args:
customerId: string, The unique ID for the customer's Google Workspace account. In case of a multi-domain account, to fetch all groups for a customer, use this field instead of `domain`. You can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users](https://developers.google.com/workspace/admin/directory/v1/reference/users) resource. You must provide either the `customer` or the `domain` parameter. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # JSON response template for List Schema operation in Directory API.
"etag": "A String", # ETag of the resource.
"kind": "admin#directory#schemas", # Kind of resource this is.
"schemas": [ # A list of UserSchema objects.
{ # The type of API resource. For Schema resources, this is always `admin#directory#schema`.
"displayName": "A String", # Display name for the schema.
"etag": "A String", # The ETag of the resource.
"fields": [ # A list of fields in the schema.
{ # You can use schemas to add custom fields to user profiles. You can use these fields to store information such as the projects your users work on, their physical locations, their hire dates, or whatever else fits your business needs. For more information, see [Custom User Fields](https://developers.google.com/workspace/admin/directory/v1/guides/manage-schemas).
"displayName": "A String", # Display Name of the field.
"etag": "A String", # The ETag of the field.
"fieldId": "A String", # The unique identifier of the field (Read-only)
"fieldName": "A String", # The name of the field.
"fieldType": "A String", # The type of the field.
"indexed": true, # Boolean specifying whether the field is indexed or not. Default: `true`.
"kind": "admin#directory#schema#fieldspec", # The kind of resource this is. For schema fields this is always `admin#directory#schema#fieldspec`.
"multiValued": True or False, # A boolean specifying whether this is a multi-valued field or not. Default: `false`.
"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.
},
"readAccessType": "ALL_DOMAIN_USERS", # Specifies who can view values of this field. See [Retrieve users as a non-administrator](https://developers.google.com/workspace/admin/directory/v1/guides/manage-users#retrieve_users_non_admin) for more information. Note: It may take up to 24 hours for changes to this field to be reflected.
},
],
"kind": "admin#directory#schema", # Kind of resource this is.
"schemaId": "A String", # The unique identifier of the schema (Read-only)
"schemaName": "A String", # The schema's name. Each `schema_name` must be unique within a customer. Reusing a name results in a `409: Entity already exists` error.
},
],
}</pre>
</div>
<div class="method">
<code class="details" id="patch">patch(customerId, schemaKey, body=None, x__xgafv=None)</code>
<pre>Patches a schema.
Args:
customerId: string, Immutable ID of the Google Workspace account. (required)
schemaKey: string, Name or immutable ID of the schema. (required)
body: object, The request body.
The object takes the form of:
{ # The type of API resource. For Schema resources, this is always `admin#directory#schema`.
"displayName": "A String", # Display name for the schema.
"etag": "A String", # The ETag of the resource.
"fields": [ # A list of fields in the schema.
{ # You can use schemas to add custom fields to user profiles. You can use these fields to store information such as the projects your users work on, their physical locations, their hire dates, or whatever else fits your business needs. For more information, see [Custom User Fields](https://developers.google.com/workspace/admin/directory/v1/guides/manage-schemas).
"displayName": "A String", # Display Name of the field.
"etag": "A String", # The ETag of the field.
"fieldId": "A String", # The unique identifier of the field (Read-only)
"fieldName": "A String", # The name of the field.
"fieldType": "A String", # The type of the field.
"indexed": true, # Boolean specifying whether the field is indexed or not. Default: `true`.
"kind": "admin#directory#schema#fieldspec", # The kind of resource this is. For schema fields this is always `admin#directory#schema#fieldspec`.
"multiValued": True or False, # A boolean specifying whether this is a multi-valued field or not. Default: `false`.
"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.
},
"readAccessType": "ALL_DOMAIN_USERS", # Specifies who can view values of this field. See [Retrieve users as a non-administrator](https://developers.google.com/workspace/admin/directory/v1/guides/manage-users#retrieve_users_non_admin) for more information. Note: It may take up to 24 hours for changes to this field to be reflected.
},
],
"kind": "admin#directory#schema", # Kind of resource this is.
"schemaId": "A String", # The unique identifier of the schema (Read-only)
"schemaName": "A String", # The schema's name. Each `schema_name` must be unique within a customer. Reusing a name results in a `409: Entity already exists` error.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # The type of API resource. For Schema resources, this is always `admin#directory#schema`.
"displayName": "A String", # Display name for the schema.
"etag": "A String", # The ETag of the resource.
"fields": [ # A list of fields in the schema.
{ # You can use schemas to add custom fields to user profiles. You can use these fields to store information such as the projects your users work on, their physical locations, their hire dates, or whatever else fits your business needs. For more information, see [Custom User Fields](https://developers.google.com/workspace/admin/directory/v1/guides/manage-schemas).
"displayName": "A String", # Display Name of the field.
"etag": "A String", # The ETag of the field.
"fieldId": "A String", # The unique identifier of the field (Read-only)
"fieldName": "A String", # The name of the field.
"fieldType": "A String", # The type of the field.
"indexed": true, # Boolean specifying whether the field is indexed or not. Default: `true`.
"kind": "admin#directory#schema#fieldspec", # The kind of resource this is. For schema fields this is always `admin#directory#schema#fieldspec`.
"multiValued": True or False, # A boolean specifying whether this is a multi-valued field or not. Default: `false`.
"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.
},
"readAccessType": "ALL_DOMAIN_USERS", # Specifies who can view values of this field. See [Retrieve users as a non-administrator](https://developers.google.com/workspace/admin/directory/v1/guides/manage-users#retrieve_users_non_admin) for more information. Note: It may take up to 24 hours for changes to this field to be reflected.
},
],
"kind": "admin#directory#schema", # Kind of resource this is.
"schemaId": "A String", # The unique identifier of the schema (Read-only)
"schemaName": "A String", # The schema's name. Each `schema_name` must be unique within a customer. Reusing a name results in a `409: Entity already exists` error.
}</pre>
</div>
<div class="method">
<code class="details" id="update">update(customerId, schemaKey, body=None, x__xgafv=None)</code>
<pre>Updates a schema.
Args:
customerId: string, Immutable ID of the Google Workspace account. (required)
schemaKey: string, Name or immutable ID of the schema. (required)
body: object, The request body.
The object takes the form of:
{ # The type of API resource. For Schema resources, this is always `admin#directory#schema`.
"displayName": "A String", # Display name for the schema.
"etag": "A String", # The ETag of the resource.
"fields": [ # A list of fields in the schema.
{ # You can use schemas to add custom fields to user profiles. You can use these fields to store information such as the projects your users work on, their physical locations, their hire dates, or whatever else fits your business needs. For more information, see [Custom User Fields](https://developers.google.com/workspace/admin/directory/v1/guides/manage-schemas).
"displayName": "A String", # Display Name of the field.
"etag": "A String", # The ETag of the field.
"fieldId": "A String", # The unique identifier of the field (Read-only)
"fieldName": "A String", # The name of the field.
"fieldType": "A String", # The type of the field.
"indexed": true, # Boolean specifying whether the field is indexed or not. Default: `true`.
"kind": "admin#directory#schema#fieldspec", # The kind of resource this is. For schema fields this is always `admin#directory#schema#fieldspec`.
"multiValued": True or False, # A boolean specifying whether this is a multi-valued field or not. Default: `false`.
"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.
},
"readAccessType": "ALL_DOMAIN_USERS", # Specifies who can view values of this field. See [Retrieve users as a non-administrator](https://developers.google.com/workspace/admin/directory/v1/guides/manage-users#retrieve_users_non_admin) for more information. Note: It may take up to 24 hours for changes to this field to be reflected.
},
],
"kind": "admin#directory#schema", # Kind of resource this is.
"schemaId": "A String", # The unique identifier of the schema (Read-only)
"schemaName": "A String", # The schema's name. Each `schema_name` must be unique within a customer. Reusing a name results in a `409: Entity already exists` error.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # The type of API resource. For Schema resources, this is always `admin#directory#schema`.
"displayName": "A String", # Display name for the schema.
"etag": "A String", # The ETag of the resource.
"fields": [ # A list of fields in the schema.
{ # You can use schemas to add custom fields to user profiles. You can use these fields to store information such as the projects your users work on, their physical locations, their hire dates, or whatever else fits your business needs. For more information, see [Custom User Fields](https://developers.google.com/workspace/admin/directory/v1/guides/manage-schemas).
"displayName": "A String", # Display Name of the field.
"etag": "A String", # The ETag of the field.
"fieldId": "A String", # The unique identifier of the field (Read-only)
"fieldName": "A String", # The name of the field.
"fieldType": "A String", # The type of the field.
"indexed": true, # Boolean specifying whether the field is indexed or not. Default: `true`.
"kind": "admin#directory#schema#fieldspec", # The kind of resource this is. For schema fields this is always `admin#directory#schema#fieldspec`.
"multiValued": True or False, # A boolean specifying whether this is a multi-valued field or not. Default: `false`.
"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.
},
"readAccessType": "ALL_DOMAIN_USERS", # Specifies who can view values of this field. See [Retrieve users as a non-administrator](https://developers.google.com/workspace/admin/directory/v1/guides/manage-users#retrieve_users_non_admin) for more information. Note: It may take up to 24 hours for changes to this field to be reflected.
},
],
"kind": "admin#directory#schema", # Kind of resource this is.
"schemaId": "A String", # The unique identifier of the schema (Read-only)
"schemaName": "A String", # The schema's name. Each `schema_name` must be unique within a customer. Reusing a name results in a `409: Entity already exists` error.
}</pre>
</div>
</body></html>
|
