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.
- Python
- TypeScript
use_case_id = "use_case_id-123"
response = client.use_case_policy_packs.list(
use_case_id=use_case_id,
)
const { data, error } = await client.useCases.policyPacks.list('use_case_id-123');
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.
- Python
- TypeScript
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,
)
const { data, error } = await client.useCases.policyPacks.attach('use_case_id-123', {
id: 'policy_packs-456',
});
Parameters:
use_case_id(str, required) - Resource identifierdata(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).
- Python
- TypeScript
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,
)
const { data, error } = await client.useCases.policyPacks.update(
'use_case_id-123',
'attachment_id-123',
{ id: 'policy_packs-456' },
);
Parameters:
use_case_id(str, required) - Resource identifierattachment_id(str, required) - Resource identifierdata(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.
- Python
- TypeScript
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,
)
const { data, error } = await client.useCases.policyPacks.detach(
'use_case_id-123',
'attachment_id-123',
);
Parameters:
use_case_id(str, required) - Resource identifierattachment_id(str, required) - Resource identifier
Returns: Response object
Example: Working with Use Cases Policy Packs
- Python
- TypeScript
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"
)
import { createCredoAIClient } from '@credo-ai/sdk';
const client = createCredoAIClient('your-tenant');
// List policy packs for a use_case
const { data } = await client.useCases.policyPacks.list('use_case-123');
for (const item of data.items) {
console.log(item.id);
}
// Attach a policy pack
await client.useCases.policyPacks.attach('use_case-123', {
id: 'policy_pack-456',
});
// Detach a policy pack
await client.useCases.policyPacks.detach('use_case-123', 'policy_pack-456');