Policies

Get a policy by fully qualified name

Get a policy by fully qualified name.

get/v1/policies/name/{fqn}

Request

  • Base URL: https://demo.getcollate.io/api
  • URL: https://demo.getcollate.io/api/v1/policies/name/{fqn}
  • Auth: HTTP bearer

Path parameters

fqnstring required

Fully qualified name of the policy

Query parameters

fieldsstring
Example:owners,location,teams,roles

Fields requested in the returned resource

include'all' | 'deleted' | 'non-deleted'

Include all, deleted, or non-deleted entities.

includeRelationsstring
Example:owners:non-deleted,followers:all

Per-relation include control. Format: field:value,field2:value2. Example: owners:non-deleted,followers:all. Valid values: all, deleted, non-deleted. If not specified for a field, uses the entity's include value.

Response

The policy

idstring uuid required
namestring required
fullyQualifiedNamestring
displayNamestring
descriptionstring
hrefstring uri
enabledboolean
versionnumber double
updatedAtinteger
updatedBystring
impersonatedBystring
allowDeleteboolean
allowEditboolean
deletedboolean
provider'system' | 'user' | 'automation'
disabledboolean
extensionobject
entityStatus'Draft' | 'In Review' | 'Approved' | 'Archived' | 'Deprecated' | 'Rejected' | 'Unprocessed'
sourceHashstring

Changes

No recorded changes to this operation across all 1 revision of this API.