Skip to content

Atlassian: Policies schemas

9 Atlassian schemas with complete fields and constraints.

← Policies operations · All schemas

Apply a policy to projects — request body — body

FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
projectIdsarrayOptional
projectIds[]integerEach itemFormat: int64

Apply a policy to projects — response body

FieldTypePresenceDescription and constraints
$objectRoot
failedJSONOptional
failed (anyOf 1)arrayAlternative
failed (anyOf 1)[]ModelEach itemExpand Apply a policy to projects — response body — failed array item
failed (anyOf 2)nullAlternative
successfulJSONOptional
successful (anyOf 1)arrayAlternative
successful (anyOf 1)[]ModelEach itemExpand Apply a policy to projects — response body — failed array item
successful (anyOf 2)nullAlternative

Referenced models: Apply a policy to projects — response body — failed array item

Apply a policy to projects — response body — failed array item

FieldTypePresenceDescription and constraints
$objectRoot
errorsJSONOptional
errors (anyOf 1)arrayAlternative
errors (anyOf 1)[]ModelEach itemExpand Apply a policy to projects — response body — failed array item errors array item
errors (anyOf 2)nullAlternative
messageJSONOptional
message (anyOf 1)stringAlternative
message (anyOf 2)nullAlternative
projectIdJSONOptional
projectId (anyOf 1)JSONAlternative
projectId (anyOf 1) (anyOf 1)integerAlternativeFormat: int64
projectId (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
projectId (anyOf 2)nullAlternative

Referenced models: Apply a policy to projects — response body — failed array item errors array item

Apply a policy to projects — response body — failed array item errors array item

FieldTypePresenceDescription and constraints
$objectRoot
entityIdJSONOptional
entityId (anyOf 1)stringAlternative
entityId (anyOf 2)nullAlternative
entityNameJSONOptional
entityName (anyOf 1)stringAlternative
entityName (anyOf 2)nullAlternative
entityTypeJSONOptional
entityType (anyOf 1)stringAlternative
entityType (anyOf 2)nullAlternative
remediationHintJSONOptional
remediationHint (anyOf 1)stringAlternative
remediationHint (anyOf 2)nullAlternative
ruleTypeIdJSONOptional
ruleTypeId (anyOf 1)stringAlternative
ruleTypeId (anyOf 2)nullAlternative

Get all policies — response body

FieldTypePresenceDescription and constraints
$objectRoot
isLastJSONOptional
isLast (anyOf 1)booleanAlternative
isLast (anyOf 2)nullAlternative
maxResultsJSONOptional
maxResults (anyOf 1)JSONAlternative
maxResults (anyOf 1) (anyOf 1)integerAlternativeFormat: int32
maxResults (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
maxResults (anyOf 2)nullAlternative
nextPageCursorJSONOptional
nextPageCursor (anyOf 1)stringAlternative
nextPageCursor (anyOf 2)nullAlternative
startAtJSONOptional
startAt (anyOf 1)JSONAlternative
startAt (anyOf 1) (anyOf 1)integerAlternativeFormat: int64
startAt (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
startAt (anyOf 2)nullAlternative
totalJSONOptional
total (anyOf 1)JSONAlternative
total (anyOf 1) (anyOf 1)integerAlternativeFormat: int64
total (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
total (anyOf 2)nullAlternative
valuesJSONOptional
values (anyOf 1)arrayAlternative
values (anyOf 1)[]ModelEach itemExpand Get all policies — response body — values array item
values (anyOf 2)nullAlternative

Referenced models: Get all policies — response body — values array item

Get all policies — response body — values array item

FieldTypePresenceDescription and constraints
$objectRoot
appliedProjectIdsJSONOptional
appliedProjectIds (anyOf 1)arrayAlternative
appliedProjectIds (anyOf 1)[]JSONEach item
appliedProjectIds (anyOf 1)[] (anyOf 1)integerAlternativeFormat: int64
appliedProjectIds (anyOf 1)[] (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
appliedProjectIds (anyOf 2)nullAlternative
idJSONOptional
id (anyOf 1)stringAlternative
id (anyOf 2)nullAlternative
isDefaultJSONOptional
isDefault (anyOf 1)booleanAlternative
isDefault (anyOf 2)nullAlternative
policyDescriptionJSONOptional
policyDescription (anyOf 1)stringAlternative
policyDescription (anyOf 2)nullAlternative
policyNameJSONOptional
policyName (anyOf 1)stringAlternative
policyName (anyOf 2)nullAlternative
versionJSONOptional
version (anyOf 1)JSONAlternative
version (anyOf 1) (anyOf 1)integerAlternativeFormat: int64
version (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
version (anyOf 2)nullAlternative

Get project policy rules — response body — item

FieldTypePresenceDescription and constraints
$objectRoot
descriptionJSONOptional
description (anyOf 1)stringAlternative
description (anyOf 2)nullAlternative
domainJSONOptional
domain (anyOf 1)stringAlternative
domain (anyOf 2)nullAlternative
propertiesJSONOptional
properties (anyOf 1)objectAlternativeAdditional keys: see wildcard field
properties (anyOf 1).*JSONAdditional keys
properties (anyOf 2)nullAlternative
ruleIdJSONOptional
ruleId (anyOf 1)stringAlternative
ruleId (anyOf 2)nullAlternative
ruleTypeIdJSONOptional
ruleTypeId (anyOf 1)stringAlternative
ruleTypeId (anyOf 2)nullAlternative

Get project policy state — response body — item

FieldTypePresenceDescription and constraints
$objectRoot
idJSONOptional
id (anyOf 1)stringAlternative
id (anyOf 2)nullAlternative
isDefaultJSONOptional
isDefault (anyOf 1)booleanAlternative
isDefault (anyOf 2)nullAlternative
policyDescriptionJSONOptional
policyDescription (anyOf 1)stringAlternative
policyDescription (anyOf 2)nullAlternative
policyNameJSONOptional
policyName (anyOf 1)stringAlternative
policyName (anyOf 2)nullAlternative
rulesByDomainJSONOptional
rulesByDomain (anyOf 1)objectAlternativeAdditional keys: see wildcard field
rulesByDomain (anyOf 1).*arrayAdditional keys
rulesByDomain (anyOf 1).*[]ModelEach itemExpand Get project policy rules — response body — item
rulesByDomain (anyOf 2)nullAlternative
versionJSONOptional
version (anyOf 1)JSONAlternative
version (anyOf 1) (anyOf 1)integerAlternativeFormat: int64
version (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
version (anyOf 2)nullAlternative

Referenced models: Get project policy rules — response body — item

Set the policies applied to a project — request body — body

FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
policyIdsarrayOptional
policyIds[]stringEach item

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.