Get Involved

PolicyType

PolicyType

Represents a PolicyType defined within a Mod.

For more information, please see Policy Types & Categories and Mods.


`category`	ControlCategory	The `category` information for this `PolicyType`.
`categoryUri`	String!	Unique identifier for the category.
`children`	PolicyTypes	The immediate `children` for this `PolicyType`.
`controls`	Controls	Returns any `controls` for this `PolicyType` that you have permission to get, subject to the optional `filter` and `paging` arguments.
`defaultTemplate`	String	Optional Nunjucks template used to calculate the default policy value for any targeted resources.
`defaultTemplateInput`	Scalar	Optional GraphQL query used to calculate the default policy value for any targeted resources.
`descendants`	PolicyTypes	The `descendants` of this `PolicyType`.
`description`	String	Short human-friendly description.
`icon`	String	FontAwesome `icon` reference, used for display in the product and documentation. Will be in the format `fal-<icon>`, `far-<icon>` or `fas-<icon>` for light, regular and solid icon classes respectively.
`input`	[String]
`modUri`	String!	Unique identifier for the defining mod.
`policySettings`	PolicySettings	Returns any `policySettings` for this `PolicyType` that you have permission to get, subject to the optional `filter` and `paging` arguments.
`policyValues`	PolicyValues	Returns any `policyValues` for this `PolicyType` that you have permission to get, subject to the optional `filter` and `paging` arguments.
`readOnly`	Boolean	If `true` user-defined policy settings are blocked from being created.
`resolvedSchema`	Scalar	JSON schema with fully-resolved URI references, defining the allowed schema for policy values for any targeted resources.
`resources`	Resources	The `resources` of this `PolicyType`, subject to the optional `filter` and `paging` arguments.
`schema`	Scalar	JSON schema defining the allowed schema for policy values for any targeted resources.
`secret`	Boolean	If `true` any non-calculated policy settings and policy values for targeted resources will be encrypted at rest.
`secretLevel`	SecretLevel
`targets`	[String!]	Target resource interface / type URIs.
`title`	String!	Display title.
`trunk`	TrunkItems	The `trunk` for this `PolicyType`, subject to the optional `filter` and `paging` arguments. This will show the resource type hierarchy from the root down to this `PolicyType`.
`turbot`	TurbotPolicyTypeMetadata!	Turbot metadata for this `PolicyType`.
`uri`	String!	Mod-specific unique identifier.
`hidden`	Boolean	DEPRECATED: Unused field. Will be removed in a forthcoming release.