Method: schemas.get

Retrieves a schema.

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 OAuth 2.0 Overview.