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 SDK API</a> . <a href="admin_directory_v1.schemas.html">schemas</a></h1> 76<h2>Instance Methods</h2> 77<p class="toc_element"> 78 <code><a href="#close">close()</a></code></p> 79<p class="firstline">Close httplib2 connections.</p> 80<p class="toc_element"> 81 <code><a href="#delete">delete(customerId, schemaKey, x__xgafv=None)</a></code></p> 82<p class="firstline">Deletes a schema.</p> 83<p class="toc_element"> 84 <code><a href="#get">get(customerId, schemaKey, x__xgafv=None)</a></code></p> 85<p class="firstline">Retrieves a schema.</p> 86<p class="toc_element"> 87 <code><a href="#insert">insert(customerId, body=None, x__xgafv=None)</a></code></p> 88<p class="firstline">Creates a schema.</p> 89<p class="toc_element"> 90 <code><a href="#list">list(customerId, x__xgafv=None)</a></code></p> 91<p class="firstline">Retrieves all schemas for a customer.</p> 92<p class="toc_element"> 93 <code><a href="#patch">patch(customerId, schemaKey, body=None, x__xgafv=None)</a></code></p> 94<p class="firstline">Patches a schema.</p> 95<p class="toc_element"> 96 <code><a href="#update">update(customerId, schemaKey, body=None, x__xgafv=None)</a></code></p> 97<p class="firstline">Updates a schema.</p> 98<h3>Method Details</h3> 99<div class="method"> 100 <code class="details" id="close">close()</code> 101 <pre>Close httplib2 connections.</pre> 102</div> 103 104<div class="method"> 105 <code class="details" id="delete">delete(customerId, schemaKey, x__xgafv=None)</code> 106 <pre>Deletes a schema. 107 108Args: 109 customerId: string, Immutable ID of the Google Workspace account. (required) 110 schemaKey: string, Name or immutable ID of the schema. (required) 111 x__xgafv: string, V1 error format. 112 Allowed values 113 1 - v1 error format 114 2 - v2 error format 115</pre> 116</div> 117 118<div class="method"> 119 <code class="details" id="get">get(customerId, schemaKey, x__xgafv=None)</code> 120 <pre>Retrieves a schema. 121 122Args: 123 customerId: string, Immutable ID of the Google Workspace account. (required) 124 schemaKey: string, Name or immutable ID of the schema. (required) 125 x__xgafv: string, V1 error format. 126 Allowed values 127 1 - v1 error format 128 2 - v2 error format 129 130Returns: 131 An object of the form: 132 133 { # The type of API resource. For Schema resources, this is always `admin#directory#schema`. 134 "displayName": "A String", # Display name for the schema. 135 "etag": "A String", # The ETag of the resource. 136 "fields": [ # A list of fields in the schema. 137 { # 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](/admin-sdk/directory/v1/guides/manage-schemas). 138 "displayName": "A String", # Display Name of the field. 139 "etag": "A String", # The ETag of the field. 140 "fieldId": "A String", # The unique identifier of the field (Read-only) 141 "fieldName": "A String", # The name of the field. 142 "fieldType": "A String", # The type of the field. 143 "indexed": true, # Boolean specifying whether the field is indexed or not. Default: `true`. 144 "kind": "admin#directory#schema#fieldspec", # The kind of resource this is. For schema fields this is always `admin#directory#schema#fieldspec`. 145 "multiValued": True or False, # A boolean specifying whether this is a multi-valued field or not. Default: `false`. 146 "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. 147 "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. 148 "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. 149 }, 150 "readAccessType": "ALL_DOMAIN_USERS", # Specifies who can view values of this field. See [Retrieve users as a non-administrator](/admin-sdk/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. 151 }, 152 ], 153 "kind": "admin#directory#schema", # Kind of resource this is. 154 "schemaId": "A String", # The unique identifier of the schema (Read-only) 155 "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. 156}</pre> 157</div> 158 159<div class="method"> 160 <code class="details" id="insert">insert(customerId, body=None, x__xgafv=None)</code> 161 <pre>Creates a schema. 162 163Args: 164 customerId: string, Immutable ID of the Google Workspace account. (required) 165 body: object, The request body. 166 The object takes the form of: 167 168{ # The type of API resource. For Schema resources, this is always `admin#directory#schema`. 169 "displayName": "A String", # Display name for the schema. 170 "etag": "A String", # The ETag of the resource. 171 "fields": [ # A list of fields in the schema. 172 { # 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](/admin-sdk/directory/v1/guides/manage-schemas). 173 "displayName": "A String", # Display Name of the field. 174 "etag": "A String", # The ETag of the field. 175 "fieldId": "A String", # The unique identifier of the field (Read-only) 176 "fieldName": "A String", # The name of the field. 177 "fieldType": "A String", # The type of the field. 178 "indexed": true, # Boolean specifying whether the field is indexed or not. Default: `true`. 179 "kind": "admin#directory#schema#fieldspec", # The kind of resource this is. For schema fields this is always `admin#directory#schema#fieldspec`. 180 "multiValued": True or False, # A boolean specifying whether this is a multi-valued field or not. Default: `false`. 181 "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. 182 "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. 183 "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. 184 }, 185 "readAccessType": "ALL_DOMAIN_USERS", # Specifies who can view values of this field. See [Retrieve users as a non-administrator](/admin-sdk/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. 186 }, 187 ], 188 "kind": "admin#directory#schema", # Kind of resource this is. 189 "schemaId": "A String", # The unique identifier of the schema (Read-only) 190 "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. 191} 192 193 x__xgafv: string, V1 error format. 194 Allowed values 195 1 - v1 error format 196 2 - v2 error format 197 198Returns: 199 An object of the form: 200 201 { # The type of API resource. For Schema resources, this is always `admin#directory#schema`. 202 "displayName": "A String", # Display name for the schema. 203 "etag": "A String", # The ETag of the resource. 204 "fields": [ # A list of fields in the schema. 205 { # 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](/admin-sdk/directory/v1/guides/manage-schemas). 206 "displayName": "A String", # Display Name of the field. 207 "etag": "A String", # The ETag of the field. 208 "fieldId": "A String", # The unique identifier of the field (Read-only) 209 "fieldName": "A String", # The name of the field. 210 "fieldType": "A String", # The type of the field. 211 "indexed": true, # Boolean specifying whether the field is indexed or not. Default: `true`. 212 "kind": "admin#directory#schema#fieldspec", # The kind of resource this is. For schema fields this is always `admin#directory#schema#fieldspec`. 213 "multiValued": True or False, # A boolean specifying whether this is a multi-valued field or not. Default: `false`. 214 "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. 215 "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. 216 "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. 217 }, 218 "readAccessType": "ALL_DOMAIN_USERS", # Specifies who can view values of this field. See [Retrieve users as a non-administrator](/admin-sdk/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. 219 }, 220 ], 221 "kind": "admin#directory#schema", # Kind of resource this is. 222 "schemaId": "A String", # The unique identifier of the schema (Read-only) 223 "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. 224}</pre> 225</div> 226 227<div class="method"> 228 <code class="details" id="list">list(customerId, x__xgafv=None)</code> 229 <pre>Retrieves all schemas for a customer. 230 231Args: 232 customerId: string, Immutable ID of the Google Workspace account. (required) 233 x__xgafv: string, V1 error format. 234 Allowed values 235 1 - v1 error format 236 2 - v2 error format 237 238Returns: 239 An object of the form: 240 241 { # JSON response template for List Schema operation in Directory API. 242 "etag": "A String", # ETag of the resource. 243 "kind": "admin#directory#schemas", # Kind of resource this is. 244 "schemas": [ # List of UserSchema objects. 245 { # The type of API resource. For Schema resources, this is always `admin#directory#schema`. 246 "displayName": "A String", # Display name for the schema. 247 "etag": "A String", # The ETag of the resource. 248 "fields": [ # A list of fields in the schema. 249 { # 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](/admin-sdk/directory/v1/guides/manage-schemas). 250 "displayName": "A String", # Display Name of the field. 251 "etag": "A String", # The ETag of the field. 252 "fieldId": "A String", # The unique identifier of the field (Read-only) 253 "fieldName": "A String", # The name of the field. 254 "fieldType": "A String", # The type of the field. 255 "indexed": true, # Boolean specifying whether the field is indexed or not. Default: `true`. 256 "kind": "admin#directory#schema#fieldspec", # The kind of resource this is. For schema fields this is always `admin#directory#schema#fieldspec`. 257 "multiValued": True or False, # A boolean specifying whether this is a multi-valued field or not. Default: `false`. 258 "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. 259 "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. 260 "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. 261 }, 262 "readAccessType": "ALL_DOMAIN_USERS", # Specifies who can view values of this field. See [Retrieve users as a non-administrator](/admin-sdk/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. 263 }, 264 ], 265 "kind": "admin#directory#schema", # Kind of resource this is. 266 "schemaId": "A String", # The unique identifier of the schema (Read-only) 267 "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. 268 }, 269 ], 270}</pre> 271</div> 272 273<div class="method"> 274 <code class="details" id="patch">patch(customerId, schemaKey, body=None, x__xgafv=None)</code> 275 <pre>Patches a schema. 276 277Args: 278 customerId: string, Immutable ID of the Google Workspace account. (required) 279 schemaKey: string, Name or immutable ID of the schema. (required) 280 body: object, The request body. 281 The object takes the form of: 282 283{ # The type of API resource. For Schema resources, this is always `admin#directory#schema`. 284 "displayName": "A String", # Display name for the schema. 285 "etag": "A String", # The ETag of the resource. 286 "fields": [ # A list of fields in the schema. 287 { # 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](/admin-sdk/directory/v1/guides/manage-schemas). 288 "displayName": "A String", # Display Name of the field. 289 "etag": "A String", # The ETag of the field. 290 "fieldId": "A String", # The unique identifier of the field (Read-only) 291 "fieldName": "A String", # The name of the field. 292 "fieldType": "A String", # The type of the field. 293 "indexed": true, # Boolean specifying whether the field is indexed or not. Default: `true`. 294 "kind": "admin#directory#schema#fieldspec", # The kind of resource this is. For schema fields this is always `admin#directory#schema#fieldspec`. 295 "multiValued": True or False, # A boolean specifying whether this is a multi-valued field or not. Default: `false`. 296 "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. 297 "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. 298 "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. 299 }, 300 "readAccessType": "ALL_DOMAIN_USERS", # Specifies who can view values of this field. See [Retrieve users as a non-administrator](/admin-sdk/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. 301 }, 302 ], 303 "kind": "admin#directory#schema", # Kind of resource this is. 304 "schemaId": "A String", # The unique identifier of the schema (Read-only) 305 "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. 306} 307 308 x__xgafv: string, V1 error format. 309 Allowed values 310 1 - v1 error format 311 2 - v2 error format 312 313Returns: 314 An object of the form: 315 316 { # The type of API resource. For Schema resources, this is always `admin#directory#schema`. 317 "displayName": "A String", # Display name for the schema. 318 "etag": "A String", # The ETag of the resource. 319 "fields": [ # A list of fields in the schema. 320 { # 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](/admin-sdk/directory/v1/guides/manage-schemas). 321 "displayName": "A String", # Display Name of the field. 322 "etag": "A String", # The ETag of the field. 323 "fieldId": "A String", # The unique identifier of the field (Read-only) 324 "fieldName": "A String", # The name of the field. 325 "fieldType": "A String", # The type of the field. 326 "indexed": true, # Boolean specifying whether the field is indexed or not. Default: `true`. 327 "kind": "admin#directory#schema#fieldspec", # The kind of resource this is. For schema fields this is always `admin#directory#schema#fieldspec`. 328 "multiValued": True or False, # A boolean specifying whether this is a multi-valued field or not. Default: `false`. 329 "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. 330 "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. 331 "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. 332 }, 333 "readAccessType": "ALL_DOMAIN_USERS", # Specifies who can view values of this field. See [Retrieve users as a non-administrator](/admin-sdk/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. 334 }, 335 ], 336 "kind": "admin#directory#schema", # Kind of resource this is. 337 "schemaId": "A String", # The unique identifier of the schema (Read-only) 338 "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. 339}</pre> 340</div> 341 342<div class="method"> 343 <code class="details" id="update">update(customerId, schemaKey, body=None, x__xgafv=None)</code> 344 <pre>Updates a schema. 345 346Args: 347 customerId: string, Immutable ID of the Google Workspace account. (required) 348 schemaKey: string, Name or immutable ID of the schema. (required) 349 body: object, The request body. 350 The object takes the form of: 351 352{ # The type of API resource. For Schema resources, this is always `admin#directory#schema`. 353 "displayName": "A String", # Display name for the schema. 354 "etag": "A String", # The ETag of the resource. 355 "fields": [ # A list of fields in the schema. 356 { # 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](/admin-sdk/directory/v1/guides/manage-schemas). 357 "displayName": "A String", # Display Name of the field. 358 "etag": "A String", # The ETag of the field. 359 "fieldId": "A String", # The unique identifier of the field (Read-only) 360 "fieldName": "A String", # The name of the field. 361 "fieldType": "A String", # The type of the field. 362 "indexed": true, # Boolean specifying whether the field is indexed or not. Default: `true`. 363 "kind": "admin#directory#schema#fieldspec", # The kind of resource this is. For schema fields this is always `admin#directory#schema#fieldspec`. 364 "multiValued": True or False, # A boolean specifying whether this is a multi-valued field or not. Default: `false`. 365 "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. 366 "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. 367 "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. 368 }, 369 "readAccessType": "ALL_DOMAIN_USERS", # Specifies who can view values of this field. See [Retrieve users as a non-administrator](/admin-sdk/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. 370 }, 371 ], 372 "kind": "admin#directory#schema", # Kind of resource this is. 373 "schemaId": "A String", # The unique identifier of the schema (Read-only) 374 "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. 375} 376 377 x__xgafv: string, V1 error format. 378 Allowed values 379 1 - v1 error format 380 2 - v2 error format 381 382Returns: 383 An object of the form: 384 385 { # The type of API resource. For Schema resources, this is always `admin#directory#schema`. 386 "displayName": "A String", # Display name for the schema. 387 "etag": "A String", # The ETag of the resource. 388 "fields": [ # A list of fields in the schema. 389 { # 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](/admin-sdk/directory/v1/guides/manage-schemas). 390 "displayName": "A String", # Display Name of the field. 391 "etag": "A String", # The ETag of the field. 392 "fieldId": "A String", # The unique identifier of the field (Read-only) 393 "fieldName": "A String", # The name of the field. 394 "fieldType": "A String", # The type of the field. 395 "indexed": true, # Boolean specifying whether the field is indexed or not. Default: `true`. 396 "kind": "admin#directory#schema#fieldspec", # The kind of resource this is. For schema fields this is always `admin#directory#schema#fieldspec`. 397 "multiValued": True or False, # A boolean specifying whether this is a multi-valued field or not. Default: `false`. 398 "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. 399 "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. 400 "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. 401 }, 402 "readAccessType": "ALL_DOMAIN_USERS", # Specifies who can view values of this field. See [Retrieve users as a non-administrator](/admin-sdk/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. 403 }, 404 ], 405 "kind": "admin#directory#schema", # Kind of resource this is. 406 "schemaId": "A String", # The unique identifier of the schema (Read-only) 407 "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. 408}</pre> 409</div> 410 411</body></html>