Policy Control Types

Types for policy control bases and versions.

PolicyControlBaseCreate

Schema for creating a policy control base.

Fields

Field	Type	Required	Description
id	str	✓	Unique identifier for the policy control base

Example

from credoai import PolicyControlBaseCreate

obj = PolicyControlBaseCreate(
    id="example",
)

---

PolicyControlBaseResponse

Schema for a policy control base response.

Fields

Field	Type	Required	Description
id	str	✓	-
archived	Any		-
deprecated	Any		-
ownership_type	Any		-
transferred_at	Any		-
inserted_at	Any		-
updated_at	Any		-

Example

from credoai import PolicyControlBaseResponse

obj = PolicyControlBaseResponse(
    id="example",
)

---

PolicyControlBaseUpdate

Schema for updating a policy control base.

Fields

Field	Type	Required	Description
archived	Any		-

Example

from credoai import PolicyControlBaseUpdate

obj = PolicyControlBaseUpdate(
)

---

PolicyControlInfo

Nested info object for policy control details.

Fields

Field	Type	Required	Description
name	Any		-
description	Any		-
long_description	Any		-
control_type	Any		-

Example

from credoai import PolicyControlInfo

obj = PolicyControlInfo(
)

---

PolicyControlResponse

Schema for a policy control definition response.

Fields

Field	Type	Required	Description
key	str	✓	-
version	str	✓	-
info	Any		-

Example

from credoai import PolicyControlResponse

obj = PolicyControlResponse(
    key="example",
    version="example",
)

---

PolicyControlVersionCreate

Schema for creating a policy control version.

Fields

Field	Type	Required	Description
draft	bool		Whether this version is a draft
info	Any		-
risk_type_ids	List[str]		-
evidence_requirements	List[EvidenceRequirement]		-

Example

from credoai import PolicyControlVersionCreate

obj = PolicyControlVersionCreate(
)

---

PolicyControlVersionResponse

Schema for a policy control version response.

Fields

Field	Type	Required	Description
id	str	✓	-
base_id	str	✓	-
version	int	✓	-
draft	bool		-
info	Any		-
risk_type_ids	List[str]		-
evidence_requirements	List[EvidenceRequirement]		-
archived	Any		-
deprecated	Any		-
ownership_type	Any		-
transferred_at	Any		-
inserted_at	Any		-
updated_at	Any		-

Example

from credoai import PolicyControlVersionResponse

obj = PolicyControlVersionResponse(
    id="example",
    base_id="example",
    version=123,
)

---

PolicyControlVersionUpdate

Schema for updating a policy control version.

Note: Versions can only be updated when in draft state.

Fields

Field	Type	Required	Description
draft	Any		-
info	Any		-
risk_type_ids	Any		-
evidence_requirements	Any		-

Example

from credoai import PolicyControlVersionUpdate

obj = PolicyControlVersionUpdate(
)

---

PolicyControlBaseCreateRequest

Request wrapper for PolicyControlBaseCreate with validation and JSON:API support. Combines the PolicyControlBaseCreate data model with client request functionality, providing automatic validation and JSON:API format conversion for API requests.

Fields

Field	Type	Required	Description
id	str	✓	Unique identifier for the policy control base

Example

from credoai import PolicyControlBaseCreateRequest

obj = PolicyControlBaseCreateRequest(
    id="example",
)

---

PolicyControlBaseResponseWrapper

Response wrapper for PolicyControlBaseResponse with metadata and validation. Extends ClientResponse to provide type-safe access to PolicyControlBaseResponse data along with HTTP response metadata.

Fields

Field	Type	Required	Description
status_code	int	✓	HTTP response status code
headers	ForwardRef('Dict[str, str]')		HTTP response headers
request_id	ForwardRef('Optional[str]')		Unique request identifier for tracing
data	ForwardRef('PolicyControlBaseResponse')	✓	Validated response data

Example

from credoai import PolicyControlBaseResponseWrapper

obj = PolicyControlBaseResponseWrapper(
    status_code=123,
    data=None,
)

---

PolicyControlResponseWrapper

Response wrapper for PolicyControlResponse with metadata and validation. Extends ClientResponse to provide type-safe access to PolicyControlResponse data along with HTTP response metadata.

Fields

Field	Type	Required	Description
status_code	int	✓	HTTP response status code
headers	ForwardRef('Dict[str, str]')		HTTP response headers
request_id	ForwardRef('Optional[str]')		Unique request identifier for tracing
data	ForwardRef('PolicyControlResponse')	✓	Validated response data

Example

from credoai import PolicyControlResponseWrapper

obj = PolicyControlResponseWrapper(
    status_code=123,
    data=None,
)

---

PolicyControlVersionCreateRequest

Request wrapper for PolicyControlVersionCreate with validation and JSON:API support. Combines the PolicyControlVersionCreate data model with client request functionality, providing automatic validation and JSON:API format conversion for API requests.

Fields

Field	Type	Required	Description
draft	ForwardRef('Optional[bool]')		Whether this version is a draft. Example: True
info	ForwardRef('Optional[Any]')		-
risk_type_ids	ForwardRef('Optional[List[str]]')		-
evidence_requirements	ForwardRef('Optional[List[EvidenceRequirement]]')		-

Example

from credoai import PolicyControlVersionCreateRequest

obj = PolicyControlVersionCreateRequest(
)

---

PolicyControlVersionResponseWrapper

Response wrapper for PolicyControlVersionResponse with metadata and validation. Extends ClientResponse to provide type-safe access to PolicyControlVersionResponse data along with HTTP response metadata.

Fields

Field	Type	Required	Description
status_code	int	✓	HTTP response status code
headers	ForwardRef('Dict[str, str]')		HTTP response headers
request_id	ForwardRef('Optional[str]')		Unique request identifier for tracing
data	ForwardRef('PolicyControlVersionResponse')	✓	Validated response data

Example

from credoai import PolicyControlVersionResponseWrapper

obj = PolicyControlVersionResponseWrapper(
    status_code=123,
    data=None,
)

---