Skip to main content

Use Cases Policy Packs

Manage policy packs associated with use cases.

Methods​

list​

List Use Case Policy Packs List all policy packs attached to a use case.

This endpoint retrieves all policy pack attachments for a specific use case.

use_case_id = "use_case_id-123"

response = client.use_case_policy_packs.list(
    use_case_id=use_case_id,
)

Parameters:

  • use_case_id (str, required) - Resource identifier

Returns: Response object

attach​

Attach Policy Pack to Use Case Attach a policy pack to a use case.

This endpoint attaches a specific version of a policy pack to a use case.

from credoai import PolicyPackAttachment

use_case_id = "use_case_id-123"

data = PolicyPackAttachment(
    id="policy_packs-456"
)

response = client.use_case_policy_packs.attach(
    use_case_id=use_case_id,
    data=data,
)

Parameters:

  • use_case_id (str, required) - Resource identifier
  • data (PolicyPackAttachment, required) - Request payload

Returns: Response object

update​

Update Use Case Policy Pack Update a policy pack attachment on a use case.

This endpoint updates the attachment (e.g., version upgrade, due date).

from credoai import PolicyPackAttachmentUpdate

use_case_id = "use_case_id-123"
attachment_id = "attachment_id-123"

data = PolicyPackAttachmentUpdate(
    id="policy_packs-456"
)

response = client.use_case_policy_packs.update(
    use_case_id=use_case_id,
    attachment_id=attachment_id,
    data=data,
)

Parameters:

  • use_case_id (str, required) - Resource identifier
  • attachment_id (str, required) - Resource identifier
  • data (PolicyPackAttachmentUpdate, required) - Request payload

Returns: Response object

detach​

Detach Policy Pack from Use Case Detach a policy pack from a use case.

This endpoint removes a policy pack attachment from a use case.

use_case_id = "use_case_id-123"
attachment_id = "attachment_id-123"

response = client.use_case_policy_packs.detach(
    use_case_id=use_case_id,
    attachment_id=attachment_id,
)

Parameters:

  • use_case_id (str, required) - Resource identifier
  • attachment_id (str, required) - Resource identifier

Returns: Response object

Example: Working with Use Cases Policy Packs​

from credoai import CredoAI, RelationshipAdd

client = CredoAI()

# List policy_packs for a use_case
policy_packs = client.use_case_policy_packs.list(use_case_id="use_case-123")
for item in policy_packs.items:
    print(f"\\{item.id}")

# Add a policy_pack
client.use_case_policy_packs.add(
    use_case_id="use_case-123",
    data=RelationshipAdd(id="policy_pack-456")
)

# Remove a policy_pack
client.use_case_policy_packs.remove(
    use_case_id="use_case-123",
    policy_pack_id="policy_pack-456"
)