Use Cases Risk Scenarios

Manage risk scenarios associated with use cases.

Methods

list

List Use Case Risk Scenarios List all risk scenarios for a use case.

Returns a paginated list of risk scenarios with optional filters. Each scenario includes control_keys — the keys of linked policy controls.

Python

use_case_id = "use_case_id-123"

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

TypeScript

const { data, error } = await client.useCases.riskScenarios.list('use_case_id-123');

Parameters:

• use_case_id (str, required) - The use case ID

Returns: Response object

---

create

Create Use Case Risk Scenario Create a new risk scenario on a use case.

Provide either risk_scenario_id (to link from library) or name (for ad-hoc).

Python

from credoai import UseCaseRiskScenarioCreate

use_case_id = "use_case_id-123"

data = UseCaseRiskScenarioCreate(
    id="risk_scenarios-456"
)

response = client.use_case_risk_scenarios.create(
    use_case_id=use_case_id,
    data=data,
)

TypeScript

const { data, error } = await client.useCases.riskScenarios.create('use_case_id-123', {
  id: 'risk_scenarios-456',
});

Parameters:

• use_case_id (str, required) - The use case ID
• data (UseCaseRiskScenarioCreate, required) - Request payload

Returns: Response object

---

get

Get Use Case Risk Scenario Get a specific risk scenario on a use case.

The response includes control_keys — the keys of linked policy controls.

Python

use_case_id = "use_case_id-123"
risk_scenario_id = "risk_scenario_id-123"

response = client.use_case_risk_scenarios.get(
    use_case_id=use_case_id,
    risk_scenario_id=risk_scenario_id,
)

TypeScript

const { data, error } = await client.useCases.riskScenarios.get(
  'use_case_id-123',
  'risk_scenario_id-123',
);

Parameters:

• use_case_id (str, required) - The use case ID
• risk_scenario_id (str, required) - The risk scenario ID

Returns: Response object

---

update

Update Use Case Risk Scenario Update a risk scenario on a use case.

Update name, description, risk types, or risk assessment scores.

Python

from credoai import UseCaseRiskScenarioUpdate

use_case_id = "use_case_id-123"
risk_scenario_id = "risk_scenario_id-123"

data = UseCaseRiskScenarioUpdate(
    id="risk_scenarios-456"
)

response = client.use_case_risk_scenarios.update(
    use_case_id=use_case_id,
    risk_scenario_id=risk_scenario_id,
    data=data,
)

TypeScript

const { data, error } = await client.useCases.riskScenarios.update(
  'use_case_id-123',
  'risk_scenario_id-123',
  { id: 'risk_scenarios-456' },
);

Parameters:

• use_case_id (str, required) - The use case ID
• risk_scenario_id (str, required) - The risk scenario ID
• data (UseCaseRiskScenarioUpdate, required) - Request payload

Returns: Response object

---

delete

Delete Use Case Risk Scenario Delete a risk scenario from a use case.

Python

use_case_id = "use_case_id-123"
risk_scenario_id = "risk_scenario_id-123"

response = client.use_case_risk_scenarios.delete(
    use_case_id=use_case_id,
    risk_scenario_id=risk_scenario_id,
)

TypeScript

const { data, error } = await client.useCases.riskScenarios.delete(
  'use_case_id-123',
  'risk_scenario_id-123',
);

Parameters:

• use_case_id (str, required) - The use case ID
• risk_scenario_id (str, required) - The risk scenario ID

Returns: Response object

---

list

List Risk Scenario Controls List policy control keys linked to a risk scenario.

Python

use_case_id = "use_case_id-123"
risk_scenario_id = "risk_scenario_id-123"

response = client.use_case_risk_scenarios.list(
    use_case_id=use_case_id,
    risk_scenario_id=risk_scenario_id,
)

TypeScript

const { data, error } = await client.useCases.riskScenarios.list(
  'use_case_id-123',
  'risk_scenario_id-123',
);

Parameters:

• use_case_id (str, required) - The use case ID
• risk_scenario_id (str, required) - The risk scenario ID

Returns: Response object

---

add

Add Control to Risk Scenario Link a policy control to a risk scenario.

Python

from credoai import RiskScenarioControlAdd

use_case_id = "use_case_id-123"
risk_scenario_id = "risk_scenario_id-123"

data = RiskScenarioControlAdd(
    id="risk_scenarios-456"
)

response = client.use_case_risk_scenarios.add(
    use_case_id=use_case_id,
    risk_scenario_id=risk_scenario_id,
    data=data,
)

TypeScript

const { data, error } = await client.useCases.riskScenarios.add(
  'use_case_id-123',
  'risk_scenario_id-123',
  { id: 'risk_scenarios-456' },
);

Parameters:

• use_case_id (str, required) - The use case ID
• risk_scenario_id (str, required) - The risk scenario ID
• data (RiskScenarioControlAdd, required) - Request payload

Returns: Response object

---

remove

Remove Control from Risk Scenario Remove a linked policy control from a risk scenario.

Python

use_case_id = "use_case_id-123"
risk_scenario_id = "risk_scenario_id-123"
control_key = "control_key-123"

response = client.use_case_risk_scenarios.remove(
    use_case_id=use_case_id,
    risk_scenario_id=risk_scenario_id,
    control_key=control_key,
)

TypeScript

const { data, error } = await client.useCases.riskScenarios.remove(
  'use_case_id-123',
  'risk_scenario_id-123',
  'control_key-123',
);

Parameters:

• use_case_id (str, required) - The use case ID
• risk_scenario_id (str, required) - The risk scenario ID
• control_key (str, required) - The control key to unlink

Returns: Response object

---

Example: Working with Use Cases Risk Scenarios

Python

from credoai import CredoAI

client = CredoAI()

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

# Create a rik_cenario
client.use_case_risk_scenarios.create(
    use_case_id="use_case-123",
)

TypeScript

import { createCredoAIClient } from '@credo-ai/sdk';

const client = createCredoAIClient('your-tenant');

// List risk scenarios for a use_case
const { data } = await client.useCases.riskScenarios.list('use_case-123');
for (const item of data.items) {
  console.log(item.id);
}

// Create a risk scenario
await client.useCases.riskScenarios.create('use_case-123', {
  id: 'risk_scenario-456',
});