Uniform Policies API
The Policies API from Uniform — 1 operation(s) for policies.
OpenAPI Specification
openapi: 3.0.3
info:
title: Uniform Platform Aggregates Policies API
version: '2.0'
tags:
- name: Policies
paths:
/api/v1/policy-documents:
get:
description: Reads policy documents for a project. Team admin permissions are required.
parameters:
- schema:
type: string
required: true
name: projectId
in: query
responses:
'200':
description: Policy documents read
content:
application/json:
schema:
type: object
additionalProperties:
type: object
properties:
allowing:
type: array
items:
type: object
properties:
entityGroup:
type: string
enum:
- compositions
- entries
- assets
- componentPatterns
- compositionPatterns
- entryPatterns
- aiPrompts
- components
- contentTypes
- dataSources
- dataTypes
- enrichments
- intentsAndAudiences
- labels
- manifest
- projectMap
- quirks
- redirects
- releases
- signals
- tests
- utmMapper
permission:
anyOf:
- type: string
enum:
- LBL_CREATE
- LBL_DELETE
- LBL_UPDATE
- OPT_CREATE_ENRICHMENTS
- OPT_CREATE_INTENTS
- OPT_CREATE_QUIRKS
- OPT_CREATE_SIGNALS
- OPT_CREATE_TESTS
- OPT_DELETE_ENRICHMENTS
- OPT_DELETE_INTENTS
- OPT_DELETE_QUIRKS
- OPT_DELETE_SIGNALS
- OPT_DELETE_TESTS
- OPT_PUB
- OPT_PUBLISH
- OPT_READ
- OPT_WRITE_ENRICHMENTS
- OPT_WRITE_INTENTS
- OPT_WRITE_QUIRKS
- OPT_WRITE_SIGNALS
- OPT_WRITE_TESTS
- PRM_SCHEMA
- PROJECT
- RDT_ADVANCED
- RDT_CREATE
- RDT_DELETE
- RDT_UPDATE
- UPM_COMPOSITION_SCHEMA
- UPM_CREATE
- UPM_DATACONN
- UPM_DATATYPE
- UPM_DELETE
- UPM_ENTRY_SCHEMA
- UPM_PROMPT_SCHEMA
- UPM_PUB
- UPM_PUBLISH
- UPM_READ
- UPM_RELEASE_CREATE
- UPM_RELEASE_DELETE
- UPM_RELEASE_LAUNCH
- UPM_RELEASE_UPDATE
- UPM_SCHEMA
- UPM_WRITE
- UTM_PUB
- UTM_WRITE
- type: array
items:
type: string
enum:
- LBL_CREATE
- LBL_DELETE
- LBL_UPDATE
- OPT_CREATE_ENRICHMENTS
- OPT_CREATE_INTENTS
- OPT_CREATE_QUIRKS
- OPT_CREATE_SIGNALS
- OPT_CREATE_TESTS
- OPT_DELETE_ENRICHMENTS
- OPT_DELETE_INTENTS
- OPT_DELETE_QUIRKS
- OPT_DELETE_SIGNALS
- OPT_DELETE_TESTS
- OPT_PUB
- OPT_PUBLISH
- OPT_READ
- OPT_WRITE_ENRICHMENTS
- OPT_WRITE_INTENTS
- OPT_WRITE_QUIRKS
- OPT_WRITE_SIGNALS
- OPT_WRITE_TESTS
- PRM_SCHEMA
- PROJECT
- RDT_ADVANCED
- RDT_CREATE
- RDT_DELETE
- RDT_UPDATE
- UPM_COMPOSITION_SCHEMA
- UPM_CREATE
- UPM_DATACONN
- UPM_DATATYPE
- UPM_DELETE
- UPM_ENTRY_SCHEMA
- UPM_PROMPT_SCHEMA
- UPM_PUB
- UPM_PUBLISH
- UPM_READ
- UPM_RELEASE_CREATE
- UPM_RELEASE_DELETE
- UPM_RELEASE_LAUNCH
- UPM_RELEASE_UPDATE
- UPM_SCHEMA
- UPM_WRITE
- UTM_PUB
- UTM_WRITE
minItems: 1
condition:
anyOf:
- type: object
properties:
property:
type: string
enum:
- id
- type
- pattern
value:
anyOf:
- type: string
- type: array
items:
type: string
minItems: 1
required:
- property
- value
- type: array
items:
type: object
properties:
property:
type: string
enum:
- id
- type
- pattern
value:
anyOf:
- type: string
- type: array
items:
type: string
minItems: 1
required:
- property
- value
required:
- entityGroup
- permission
denying:
type: array
items:
type: object
properties:
entityGroup:
type: string
enum:
- compositions
- entries
- assets
- componentPatterns
- compositionPatterns
- entryPatterns
- aiPrompts
- components
- contentTypes
- dataSources
- dataTypes
- enrichments
- intentsAndAudiences
- labels
- manifest
- projectMap
- quirks
- redirects
- releases
- signals
- tests
- utmMapper
permission:
anyOf:
- type: string
enum:
- LBL_CREATE
- LBL_DELETE
- LBL_UPDATE
- OPT_CREATE_ENRICHMENTS
- OPT_CREATE_INTENTS
- OPT_CREATE_QUIRKS
- OPT_CREATE_SIGNALS
- OPT_CREATE_TESTS
- OPT_DELETE_ENRICHMENTS
- OPT_DELETE_INTENTS
- OPT_DELETE_QUIRKS
- OPT_DELETE_SIGNALS
- OPT_DELETE_TESTS
- OPT_PUB
- OPT_PUBLISH
- OPT_READ
- OPT_WRITE_ENRICHMENTS
- OPT_WRITE_INTENTS
- OPT_WRITE_QUIRKS
- OPT_WRITE_SIGNALS
- OPT_WRITE_TESTS
- PRM_SCHEMA
- PROJECT
- RDT_ADVANCED
- RDT_CREATE
- RDT_DELETE
- RDT_UPDATE
- UPM_COMPOSITION_SCHEMA
- UPM_CREATE
- UPM_DATACONN
- UPM_DATATYPE
- UPM_DELETE
- UPM_ENTRY_SCHEMA
- UPM_PROMPT_SCHEMA
- UPM_PUB
- UPM_PUBLISH
- UPM_READ
- UPM_RELEASE_CREATE
- UPM_RELEASE_DELETE
- UPM_RELEASE_LAUNCH
- UPM_RELEASE_UPDATE
- UPM_SCHEMA
- UPM_WRITE
- UTM_PUB
- UTM_WRITE
- type: array
items:
type: string
enum:
- LBL_CREATE
- LBL_DELETE
- LBL_UPDATE
- OPT_CREATE_ENRICHMENTS
- OPT_CREATE_INTENTS
- OPT_CREATE_QUIRKS
- OPT_CREATE_SIGNALS
- OPT_CREATE_TESTS
- OPT_DELETE_ENRICHMENTS
- OPT_DELETE_INTENTS
- OPT_DELETE_QUIRKS
- OPT_DELETE_SIGNALS
- OPT_DELETE_TESTS
- OPT_PUB
- OPT_PUBLISH
- OPT_READ
- OPT_WRITE_ENRICHMENTS
- OPT_WRITE_INTENTS
- OPT_WRITE_QUIRKS
- OPT_WRITE_SIGNALS
- OPT_WRITE_TESTS
- PRM_SCHEMA
- PROJECT
- RDT_ADVANCED
- RDT_CREATE
- RDT_DELETE
- RDT_UPDATE
- UPM_COMPOSITION_SCHEMA
- UPM_CREATE
- UPM_DATACONN
- UPM_DATATYPE
- UPM_DELETE
- UPM_ENTRY_SCHEMA
- UPM_PROMPT_SCHEMA
- UPM_PUB
- UPM_PUBLISH
- UPM_READ
- UPM_RELEASE_CREATE
- UPM_RELEASE_DELETE
- UPM_RELEASE_LAUNCH
- UPM_RELEASE_UPDATE
- UPM_SCHEMA
- UPM_WRITE
- UTM_PUB
- UTM_WRITE
minItems: 1
condition:
anyOf:
- type: object
properties:
property:
type: string
enum:
- id
- type
- pattern
value:
anyOf:
- type: string
- type: array
items:
type: string
minItems: 1
required:
- property
- value
- type: array
items:
type: object
properties:
property:
type: string
enum:
- id
- type
- pattern
value:
anyOf:
- type: string
- type: array
items:
type: string
minItems: 1
required:
- property
- value
required:
- entityGroup
- permission
'400':
$ref: '#/components/responses/BadRequestError'
'401':
$ref: '#/components/responses/UnauthorizedError'
'403':
$ref: '#/components/responses/ForbiddenError'
'429':
$ref: '#/components/responses/RateLimitError'
'500':
$ref: '#/components/responses/InternalServerError'
tags:
- Policies
security:
- ApiKeyAuth: []
- BearerAuth: []
put:
description: Writes policy documents for a project. Team admin permissions are required.
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
projectId:
type: string
documents:
type: object
additionalProperties:
type: object
properties:
allowing:
type: array
items:
type: object
properties:
entityGroup:
type: string
enum:
- compositions
- entries
- assets
- componentPatterns
- compositionPatterns
- entryPatterns
- aiPrompts
- components
- contentTypes
- dataSources
- dataTypes
- enrichments
- intentsAndAudiences
- labels
- manifest
- projectMap
- quirks
- redirects
- releases
- signals
- tests
- utmMapper
permission:
anyOf:
- type: string
enum:
- LBL_CREATE
- LBL_DELETE
- LBL_UPDATE
- OPT_CREATE_ENRICHMENTS
- OPT_CREATE_INTENTS
- OPT_CREATE_QUIRKS
- OPT_CREATE_SIGNALS
- OPT_CREATE_TESTS
- OPT_DELETE_ENRICHMENTS
- OPT_DELETE_INTENTS
- OPT_DELETE_QUIRKS
- OPT_DELETE_SIGNALS
- OPT_DELETE_TESTS
- OPT_PUB
- OPT_PUBLISH
- OPT_READ
- OPT_WRITE_ENRICHMENTS
- OPT_WRITE_INTENTS
- OPT_WRITE_QUIRKS
- OPT_WRITE_SIGNALS
- OPT_WRITE_TESTS
- PRM_SCHEMA
- PROJECT
- RDT_ADVANCED
- RDT_CREATE
- RDT_DELETE
- RDT_UPDATE
- UPM_COMPOSITION_SCHEMA
- UPM_CREATE
- UPM_DATACONN
- UPM_DATATYPE
- UPM_DELETE
- UPM_ENTRY_SCHEMA
- UPM_PROMPT_SCHEMA
- UPM_PUB
- UPM_PUBLISH
- UPM_READ
- UPM_RELEASE_CREATE
- UPM_RELEASE_DELETE
- UPM_RELEASE_LAUNCH
- UPM_RELEASE_UPDATE
- UPM_SCHEMA
- UPM_WRITE
- UTM_PUB
- UTM_WRITE
- type: array
items:
type: string
enum:
- LBL_CREATE
- LBL_DELETE
- LBL_UPDATE
- OPT_CREATE_ENRICHMENTS
- OPT_CREATE_INTENTS
- OPT_CREATE_QUIRKS
- OPT_CREATE_SIGNALS
- OPT_CREATE_TESTS
- OPT_DELETE_ENRICHMENTS
- OPT_DELETE_INTENTS
- OPT_DELETE_QUIRKS
- OPT_DELETE_SIGNALS
- OPT_DELETE_TESTS
- OPT_PUB
- OPT_PUBLISH
- OPT_READ
- OPT_WRITE_ENRICHMENTS
- OPT_WRITE_INTENTS
- OPT_WRITE_QUIRKS
- OPT_WRITE_SIGNALS
- OPT_WRITE_TESTS
- PRM_SCHEMA
- PROJECT
- RDT_ADVANCED
- RDT_CREATE
- RDT_DELETE
- RDT_UPDATE
- UPM_COMPOSITION_SCHEMA
- UPM_CREATE
- UPM_DATACONN
- UPM_DATATYPE
- UPM_DELETE
- UPM_ENTRY_SCHEMA
- UPM_PROMPT_SCHEMA
- UPM_PUB
- UPM_PUBLISH
- UPM_READ
- UPM_RELEASE_CREATE
- UPM_RELEASE_DELETE
- UPM_RELEASE_LAUNCH
- UPM_RELEASE_UPDATE
- UPM_SCHEMA
- UPM_WRITE
- UTM_PUB
- UTM_WRITE
minItems: 1
condition:
anyOf:
- type: object
properties:
property:
type: string
enum:
- id
- type
- pattern
value:
anyOf:
- type: string
- type: array
items:
type: string
minItems: 1
required:
- property
- value
- type: array
items:
type: object
properties:
property:
type: string
enum:
- id
- type
- pattern
value:
anyOf:
- type: string
- type: array
items:
type: string
minItems: 1
required:
- property
- value
required:
- entityGroup
- permission
denying:
type: array
items:
type: object
properties:
entityGroup:
type: string
enum:
- compositions
- entries
- assets
- componentPatterns
- compositionPatterns
- entryPatterns
- aiPrompts
- components
- contentTypes
- dataSources
- dataTypes
- enrichments
- intentsAndAudiences
- labels
- manifest
- projectMap
- quirks
- redirects
- releases
- signals
- tests
- utmMapper
permission:
anyOf:
- type: string
enum:
- LBL_CREATE
- LBL_DELETE
- LBL_UPDATE
- OPT_CREATE_ENRICHMENTS
- OPT_CREATE_INTENTS
- OPT_CREATE_QUIRKS
- OPT_CREATE_SIGNALS
- OPT_CREATE_TESTS
- OPT_DELETE_ENRICHMENTS
- OPT_DELETE_INTENTS
- OPT_DELETE_QUIRKS
- OPT_DELETE_SIGNALS
- OPT_DELETE_TESTS
- OPT_PUB
- OPT_PUBLISH
- OPT_READ
- OPT_WRITE_ENRICHMENTS
- OPT_WRITE_INTENTS
- OPT_WRITE_QUIRKS
- OPT_WRITE_SIGNALS
- OPT_WRITE_TESTS
- PRM_SCHEMA
- PROJECT
- RDT_ADVANCED
- RDT_CREATE
- RDT_DELETE
- RDT_UPDATE
- UPM_COMPOSITION_SCHEMA
- UPM_CREATE
- UPM_DATACONN
- UPM_DATATYPE
- UPM_DELETE
- UPM_ENTRY_SCHEMA
- UPM_PROMPT_SCHEMA
- UPM_PUB
- UPM_PUBLISH
- UPM_READ
- UPM_RELEASE_CREATE
- UPM_RELEASE_DELETE
- UPM_RELEASE_LAUNCH
- UPM_RELEASE_UPDATE
- UPM_SCHEMA
- UPM_WRITE
- UTM_PUB
- UTM_WRITE
- type: array
items:
type: string
enum:
- LBL_CREATE
- LBL_DELETE
- LBL_UPDATE
- OPT_CREATE_ENRICHMENTS
- OPT_CREATE_INTENTS
- OPT_CREATE_QUIRKS
- OPT_CREATE_SIGNALS
- OPT_CREATE_TESTS
- OPT_DELETE_ENRICHMENTS
- OPT_DELETE_INTENTS
- OPT_DELETE_QUIRKS
- OPT_DELETE_SIGNALS
- OPT_DELETE_TESTS
- OPT_PUB
- OPT_PUBLISH
- OPT_READ
- OPT_WRITE_ENRICHMENTS
- OPT_WRITE_INTENTS
- OPT_WRITE_QUIRKS
- OPT_WRITE_SIGNALS
- OPT_WRITE_TESTS
- PRM_SCHEMA
- PROJECT
- RDT_ADVANCED
- RDT_CREATE
- RDT_DELETE
- RDT_UPDATE
- UPM_COMPOSITION_SCHEMA
- UPM_CREATE
- UPM_DATACONN
- UPM_DATATYPE
- UPM_DELETE
- UPM_ENTRY_SCHEMA
- UPM_PROMPT_SCHEMA
- UPM_PUB
- UPM_PUBLISH
- UPM_READ
- UPM_RELEASE_CREATE
- UPM_RELEASE_DELETE
- UPM_RELEASE_LAUNCH
- UPM_RELEASE_UPDATE
- UPM_SCHEMA
- UPM_WRITE
- UTM_PUB
- UTM_WRITE
minItems: 1
condition:
anyOf:
- type: object
properties:
property:
type: string
enum:
- id
- type
- pattern
value:
anyOf:
- type: string
- type: array
items:
type: string
minItems: 1
required:
- property
- value
- type: array
items:
type: object
properties:
property:
type: string
enum:
- id
- type
- pattern
value:
anyOf:
- type: string
- type: array
items:
type: string
minItems: 1
# --- truncated at 32 KB (34 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/uniform/refs/heads/main/openapi/uniform-policies-api-openapi.yml