Get Policy Type By Id

• Policy Types

Find a specific policy type based on the input policy type id.

Request

URI

GET

https://{api_host}/policy/api/policyTypes/{id}

COPY

Path Parameters

string

id

Required

Policy type ID

---

Authentication/Authorization

This operation uses the following authentication methods.

bearerAuth

Responses

200

Hide Details

OK

Returns PolicyType of type(s) application/json

{
    "config": {
        "enableDryRun": false,
        "enableEnforcementType": false,
        "enableOpaRegoCriteria": false,
        "enablePolicyValidation": false,
        "enableReconciliation": false,
        "enableSingleProjectScope": false,
        "enableUpdateNotification": false,
        "maxNumberOfPoliciesPerOrg": 0,
        "maxNumberOfPoliciesPerProject": 0
    },
    "definitionSchema": {
        "$data": "string",
        "$dynamicDefault": "string",
        "$ref": "string",
        "additionalProperties": false,
        "allOf": [
            "JsonSchemaImpl Object"
        ],
        "anyOf": [
            "JsonSchemaImpl Object"
        ],
        "const": {},
        "default": {},
        "description": "string",
        "encrypted": false,
        "enum": [
            {}
        ],
        "format": "string",
        "formatMaximum": "string",
        "formatMinimum": "string",
        "items": "ObjectOrListJsonSchemaImpl Object",
        "maxItems": 0,
        "maxLength": 0,
        "maxProperties": 0,
        "maximum": "number",
        "minItems": 0,
        "minLength": 0,
        "minProperties": 0,
        "minimum": "number",
        "not": "JsonSchemaImpl Object",
        "oneOf": [
            "JsonSchemaImpl Object"
        ],
        "pattern": "string",
        "patternProperties": {
            "patternProperties": "JsonSchemaImpl Object"
        },
        "properties": {
            "properties": "JsonSchemaImpl Object"
        },
        "readOnly": false,
        "required": [
            "string"
        ],
        "title": "string",
        "type": "string",
        "uniqueItems": false,
        "writeOnly": false
    },
    "displayName": "string",
    "id": "string",
    "name": "string",
    "targetSchema": {
        "$data": "string",
        "$dynamicDefault": "string",
        "$ref": "string",
        "additionalProperties": false,
        "allOf": [
            "JsonSchemaImpl Object"
        ],
        "anyOf": [
            "JsonSchemaImpl Object"
        ],
        "const": {},
        "default": {},
        "description": "string",
        "encrypted": false,
        "enum": [
            {}
        ],
        "format": "string",
        "formatMaximum": "string",
        "formatMinimum": "string",
        "items": "ObjectOrListJsonSchemaImpl Object",
        "maxItems": 0,
        "maxLength": 0,
        "maxProperties": 0,
        "maximum": "number",
        "minItems": 0,
        "minLength": 0,
        "minProperties": 0,
        "minimum": "number",
        "not": "JsonSchemaImpl Object",
        "oneOf": [
            "JsonSchemaImpl Object"
        ],
        "pattern": "string",
        "patternProperties": {
            "patternProperties": "JsonSchemaImpl Object"
        },
        "properties": {
            "properties": "JsonSchemaImpl Object"
        },
        "readOnly": false,
        "required": [
            "string"
        ],
        "title": "string",
        "type": "string",
        "uniqueItems": false,
        "writeOnly": false
    }
}

object

config

Optional

Defines configuration options for policy type

object

definitionSchema

Required

definitionSchema

string

displayName

Required

Constraints: maxLength: 1024

Policy type display-name/label

string

id

Required

Policy type ID

string

name

Required

Constraints: maxLength: 1024

Policy type name

object

targetSchema

Required

targetSchema

400

Hide Details

Bad Request

Returns PolicyType of type(s) application/json

"PolicyType Object"

object

config

Optional

Defines configuration options for policy type

object

definitionSchema

Required

definitionSchema

string

displayName

Required

Constraints: maxLength: 1024

Policy type display-name/label

string

id

Required

Policy type ID

string

name

Required

Constraints: maxLength: 1024

Policy type name

object

targetSchema

Required

targetSchema

401

Hide Details

Unauthorized

Returns PolicyType of type(s) application/json

"PolicyType Object"

object

config

Optional

Defines configuration options for policy type

object

definitionSchema

Required

definitionSchema

string

displayName

Required

Constraints: maxLength: 1024

Policy type display-name/label

string

id

Required

Policy type ID

string

name

Required

Constraints: maxLength: 1024

Policy type name

object

targetSchema

Required

targetSchema

403

Hide Details

Forbidden

Returns PolicyType of type(s) application/json

"PolicyType Object"

object

config

Optional

Defines configuration options for policy type

object

definitionSchema

Required

definitionSchema

string

displayName

Required

Constraints: maxLength: 1024

Policy type display-name/label

string

id

Required

Policy type ID

string

name

Required

Constraints: maxLength: 1024

Policy type name

object

targetSchema

Required

targetSchema

404

Hide Details

Not Found

Returns PolicyType of type(s) application/json

"PolicyType Object"

object

config

Optional

Defines configuration options for policy type

object

definitionSchema

Required

definitionSchema

string

displayName

Required

Constraints: maxLength: 1024

Policy type display-name/label

string

id

Required

Policy type ID

string

name

Required

Constraints: maxLength: 1024

Policy type name

object

targetSchema

Required

targetSchema

Code Samples

COPY

                    curl -H 'Authorization: <value>' https://{api_host}/policy/api/policyTypes/{id}
                

On This Page

Description

Request

Path Parameters

Authentication/Authorization

Response

200 Response Body

Errors

Policy Types Operations

GET

Get Types

GET

Get Policy Type By Id

GET

Get Policy Type Scope Schema