Method: schemas.list
Mantenha tudo organizado com as coleções
Salve e categorize o conteúdo com base nas suas preferências.
Recupera todos os esquemas de um cliente.
Solicitação HTTP
GET https://admin.googleapis.com/admin/directory/v1/customer/{customerId}/schemas
O URL usa a sintaxe de transcodificação gRPC.
Parâmetros de caminho
| Parâmetros |
customerId |
string
O ID exclusivo da conta do Google Workspace do cliente. No caso de uma conta com vários domínios, para buscar todos os grupos de um cliente, use esse campo em vez de domain. Também é possível usar o alias my_customer para representar o customerId da sua conta. O customerId também é retornado como parte do recurso Users. Forneça o parâmetro customer ou domain.
|
Corpo da solicitação
O corpo da solicitação precisa estar vazio.
Corpo da resposta
Modelo de resposta JSON para a operação de esquema schemas.list na API Directory.
Se bem-sucedido, o corpo da resposta incluirá dados com a estrutura a seguir:
| Representação JSON |
{
"kind": string,
"etag": string,
"schemas": [
{
object (Schema)
}
]
} |
| Campos |
kind |
string
Tipo de recurso.
|
etag |
string
ETag do recurso.
|
schemas[] |
object (Schema)
Uma lista de objetos UserSchema.
|
Escopos de autorização
Requer um dos seguintes escopos do OAuth:
https://www.googleapis.com/auth/admin.directory.userschema
https://www.googleapis.com/auth/admin.directory.userschema.readonly
Para mais informações, consulte o guia de autorização.
Exceto em caso de indicação contrária, o conteúdo desta página é licenciado de acordo com a Licença de atribuição 4.0 do Creative Commons, e as amostras de código são licenciadas de acordo com a Licença Apache 2.0. Para mais detalhes, consulte as políticas do site do Google Developers. Java é uma marca registrada da Oracle e/ou afiliadas.
Última atualização 2025-07-25 UTC.
[null,null,["Última atualização 2025-07-25 UTC."],[],[],null,["# Method: schemas.list\n\nRetrieves all schemas for a customer.\n\n### HTTP request\n\n`GET https://admin.googleapis.com/admin/directory/v1/customer/{customerId}/schemas`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|--------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `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. |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nJSON response template for schemas.list Schema operation in Directory API.\n\nIf successful, the response body contains data with the following structure:\n\n| JSON representation |\n|-------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"kind\": string, \"etag\": string, \"schemas\": [ { object (/workspace/admin/directory/reference/rest/v1/schemas#Schema) } ] } ``` |\n\n| Fields ||\n|-------------|------------------------------------------------------------------------------------------------------------------|\n| `kind` | `string` Kind of resource this is. |\n| `etag` | `string` ETag of the resource. |\n| `schemas[]` | `object (`[Schema](/workspace/admin/directory/reference/rest/v1/schemas#Schema)`)` A list of UserSchema objects. |\n\n### Authorization scopes\n\nRequires one of the following OAuth scopes:\n\n- `https://www.googleapis.com/auth/admin.directory.userschema`\n- `\n https://www.googleapis.com/auth/admin.directory.userschema.readonly`\n\nFor more information, see the [Authorization guide](/workspace/guides/configure-oauth-consent)."]]
