Skip to main content

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.

use_case_id = "use_case_id-123"

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

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).

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,
)

Parameters:

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.

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,
)

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.

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,
)

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.

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,
)

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.

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,
)

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.

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,
)

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.

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,
)

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​

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",
)