Method: schemas.get
HTTP request
GET https://admin.googleapis.com/admin/directory/v1/customer/{customerId}/schemas/{schemaKey}
The URL uses gRPC Transcoding syntax.
Path parameters
| Parameters |
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 resource. You must provide either the customer or the domain parameter.
|
schemaKey |
string
Name or immutable ID of the schema.
|
Request body
The request body must be empty.
Response body
If successful, the response body contains an instance of Schema.
Authorization scopes
Requires one of the following OAuth scopes:
https://www.googleapis.com/auth/admin.directory.userschema
https://www.googleapis.com/auth/admin.directory.userschema.readonly
For more information, see the Authorization guide.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-08-22 UTC.
[null,null,["Last updated 2024-08-22 UTC."],[[["Retrieves a specific schema for a Google Workspace customer account using the provided `customerId` and `schemaKey`."],["Requires providing either the `customer` or `domain` parameter to identify the target account."],["The response returns details of the schema if successful, including its properties and data types."],["Requires authorization with specific OAuth scopes related to user schema management."]]],[]]
