← Policies operations · All schemas
Apply a policy to projects — request body — body
| Field | Type | Presence | Description and constraints |
|---|
$ | object | Root | Additional keys: not allowed |
projectIds | array | Optional | |
projectIds[] | integer | Each item | Format: int64 |
Apply a policy to projects — response body
Referenced models: Apply a policy to projects — response body — failed array item
Apply a policy to projects — response body — failed array item
| Field | Type | Presence | Description and constraints |
|---|
$ | object | Root | |
errors | JSON | Optional | |
errors (anyOf 1) | array | Alternative | |
errors (anyOf 1)[] | Model | Each item | Expand Apply a policy to projects — response body — failed array item errors array item |
errors (anyOf 2) | null | Alternative | |
message | JSON | Optional | |
message (anyOf 1) | string | Alternative | |
message (anyOf 2) | null | Alternative | |
projectId | JSON | Optional | |
projectId (anyOf 1) | JSON | Alternative | |
projectId (anyOf 1) (anyOf 1) | integer | Alternative | Format: int64 |
projectId (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
projectId (anyOf 2) | null | Alternative | |
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
| Field | Type | Presence | Description and constraints |
|---|
$ | object | Root | |
entityId | JSON | Optional | |
entityId (anyOf 1) | string | Alternative | |
entityId (anyOf 2) | null | Alternative | |
entityName | JSON | Optional | |
entityName (anyOf 1) | string | Alternative | |
entityName (anyOf 2) | null | Alternative | |
entityType | JSON | Optional | |
entityType (anyOf 1) | string | Alternative | |
entityType (anyOf 2) | null | Alternative | |
remediationHint | JSON | Optional | |
remediationHint (anyOf 1) | string | Alternative | |
remediationHint (anyOf 2) | null | Alternative | |
ruleTypeId | JSON | Optional | |
ruleTypeId (anyOf 1) | string | Alternative | |
ruleTypeId (anyOf 2) | null | Alternative | |
Get all policies — response body
| Field | Type | Presence | Description and constraints |
|---|
$ | object | Root | |
isLast | JSON | Optional | |
isLast (anyOf 1) | boolean | Alternative | |
isLast (anyOf 2) | null | Alternative | |
maxResults | JSON | Optional | |
maxResults (anyOf 1) | JSON | Alternative | |
maxResults (anyOf 1) (anyOf 1) | integer | Alternative | Format: int32 |
maxResults (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
maxResults (anyOf 2) | null | Alternative | |
nextPageCursor | JSON | Optional | |
nextPageCursor (anyOf 1) | string | Alternative | |
nextPageCursor (anyOf 2) | null | Alternative | |
startAt | JSON | Optional | |
startAt (anyOf 1) | JSON | Alternative | |
startAt (anyOf 1) (anyOf 1) | integer | Alternative | Format: int64 |
startAt (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
startAt (anyOf 2) | null | Alternative | |
total | JSON | Optional | |
total (anyOf 1) | JSON | Alternative | |
total (anyOf 1) (anyOf 1) | integer | Alternative | Format: int64 |
total (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
total (anyOf 2) | null | Alternative | |
values | JSON | Optional | |
values (anyOf 1) | array | Alternative | |
values (anyOf 1)[] | Model | Each item | Expand Get all policies — response body — values array item |
values (anyOf 2) | null | Alternative | |
Referenced models: Get all policies — response body — values array item
Get all policies — response body — values array item
| Field | Type | Presence | Description and constraints |
|---|
$ | object | Root | |
appliedProjectIds | JSON | Optional | |
appliedProjectIds (anyOf 1) | array | Alternative | |
appliedProjectIds (anyOf 1)[] | JSON | Each item | |
appliedProjectIds (anyOf 1)[] (anyOf 1) | integer | Alternative | Format: int64 |
appliedProjectIds (anyOf 1)[] (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
appliedProjectIds (anyOf 2) | null | Alternative | |
id | JSON | Optional | |
id (anyOf 1) | string | Alternative | |
id (anyOf 2) | null | Alternative | |
isDefault | JSON | Optional | |
isDefault (anyOf 1) | boolean | Alternative | |
isDefault (anyOf 2) | null | Alternative | |
policyDescription | JSON | Optional | |
policyDescription (anyOf 1) | string | Alternative | |
policyDescription (anyOf 2) | null | Alternative | |
policyName | JSON | Optional | |
policyName (anyOf 1) | string | Alternative | |
policyName (anyOf 2) | null | Alternative | |
version | JSON | Optional | |
version (anyOf 1) | JSON | Alternative | |
version (anyOf 1) (anyOf 1) | integer | Alternative | Format: int64 |
version (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
version (anyOf 2) | null | Alternative | |
Get project policy rules — response body — item
| Field | Type | Presence | Description and constraints |
|---|
$ | object | Root | |
description | JSON | Optional | |
description (anyOf 1) | string | Alternative | |
description (anyOf 2) | null | Alternative | |
domain | JSON | Optional | |
domain (anyOf 1) | string | Alternative | |
domain (anyOf 2) | null | Alternative | |
properties | JSON | Optional | |
properties (anyOf 1) | object | Alternative | Additional keys: see wildcard field |
properties (anyOf 1).* | JSON | Additional keys | |
properties (anyOf 2) | null | Alternative | |
ruleId | JSON | Optional | |
ruleId (anyOf 1) | string | Alternative | |
ruleId (anyOf 2) | null | Alternative | |
ruleTypeId | JSON | Optional | |
ruleTypeId (anyOf 1) | string | Alternative | |
ruleTypeId (anyOf 2) | null | Alternative | |
Get project policy state — response body — item
| Field | Type | Presence | Description and constraints |
|---|
$ | object | Root | |
id | JSON | Optional | |
id (anyOf 1) | string | Alternative | |
id (anyOf 2) | null | Alternative | |
isDefault | JSON | Optional | |
isDefault (anyOf 1) | boolean | Alternative | |
isDefault (anyOf 2) | null | Alternative | |
policyDescription | JSON | Optional | |
policyDescription (anyOf 1) | string | Alternative | |
policyDescription (anyOf 2) | null | Alternative | |
policyName | JSON | Optional | |
policyName (anyOf 1) | string | Alternative | |
policyName (anyOf 2) | null | Alternative | |
rulesByDomain | JSON | Optional | |
rulesByDomain (anyOf 1) | object | Alternative | Additional keys: see wildcard field |
rulesByDomain (anyOf 1).* | array | Additional keys | |
rulesByDomain (anyOf 1).*[] | Model | Each item | Expand Get project policy rules — response body — item |
rulesByDomain (anyOf 2) | null | Alternative | |
version | JSON | Optional | |
version (anyOf 1) | JSON | Alternative | |
version (anyOf 1) (anyOf 1) | integer | Alternative | Format: int64 |
version (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
version (anyOf 2) | null | Alternative | |
Referenced models: Get project policy rules — response body — item
Set the policies applied to a project — request body — body
| Field | Type | Presence | Description and constraints |
|---|
$ | object | Root | Additional keys: not allowed |
policyIds | array | Optional | |
policyIds[] | string | Each item | |