GOgoogle
customers

GET /v1/customers/{customersId}/policySchemas/{policySchemasId}

Get a specific policy schema for a customer by its resource name.

Request

  • Base URL
    https://chromepolicy.googleapis.com
  • Auth
    • OAuth 2 and OAuth 2
      Implicithttps://accounts.google.com/o/oauth2/auth
      Scopeshttps://www.googleapis.com/auth/chrome.management.policy
      Authorization codehttps://accounts.google.com/o/oauth2/auth
      Token URLhttps://accounts.google.com/o/oauth2/token
      Scopeshttps://www.googleapis.com/auth/chrome.management.policy
    • or OAuth 2 and OAuth 2
      Implicithttps://accounts.google.com/o/oauth2/auth
      Scopeshttps://www.googleapis.com/auth/chrome.management.policy.readonly
      Authorization codehttps://accounts.google.com/o/oauth2/auth
      Token URLhttps://accounts.google.com/o/oauth2/token
      Scopeshttps://www.googleapis.com/auth/chrome.management.policy.readonly
  • TypeScript
    A function with typed inputs. Its response is checked against the schema.

Path parameters

customersIdstring required
policySchemasIdstring required

Response

Successful response

accessRestrictionsstring[]

Output only. Specific access restrictions related to this policy.

categoryTitlestring

Title of the category in which a setting belongs.

namestring

Format: name=customers/{customer}/policySchemas/{schema_namespace}

policyDescriptionstring

Output only. Description about the policy schema for user consumption.

schemaNamestring

Output only. The fully qualified name of the policy schema. This value is used to fill the field policy_schema in PolicyValue when calling BatchInheritOrgUnitPolicies BatchModifyOrgUnitPolicies BatchModifyGroupPolicies or BatchDeleteGroupPolicies.

supportUristring

Output only. URI to related support article for this schema.

supportedPlatformsstring[]

Output only. List indicates that the policy will only apply to devices/users on these platforms.

validTargetResourcesstring[]

Output only. Information about applicable target resources for the policy.

Changes

No recorded changes to this operation across all 4 revisions of this API.