Skip to content
PrefactorPrefactorPrefactor Docs

Update a risk profile

PUT
/api/v1/risk_profile/{risk_profile_id}
curl --request PUT \
  --url https://app.prefactorai.com/api/v1/risk_profile/013xrzp12g3nqk8ns6jadrqmpgrjkeny \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "description": null, "name": "example", "ruleset": null }'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
risk_profile_id
required
RiskProfile_Id

A valid risk profile ID

string
Example
013xrzp12g3nqk8ns6jadrqmpgrjkeny

Request Body

Section titled “Request Body”
RiskProfile_ForUpdate
object
description
One of:
string
name
string
ruleset
One of:
RiskProfile_Ruleset
object
action_multipliers
required
RiskProfile_Ruleset_ActionMultipliers
object
create_data
required
One of:

Multiplier when the span creates data (null = N/A, valid range 1.0–5.0 in steps of 0.5)

number
destroy_data
required
One of:

Multiplier when the span destroys data (null = N/A, valid range 1.0–5.0 in steps of 0.5)

number
external_communication
required
One of:

Multiplier for external communication actions (null = N/A, valid range 1.0–5.0 in steps of 0.5)

number
financial_transactions
required
One of:

Multiplier for financial transaction actions (null = N/A, valid range 1.0–5.0 in steps of 0.5)

number
read_data
required
One of:

Multiplier when the span reads data (null = N/A, valid range 1.0–5.0 in steps of 0.5)

number
update_data
required
One of:

Multiplier when the span updates data (null = N/A, valid range 1.0–5.0 in steps of 0.5)

number
category_weights
required
RiskProfile_Ruleset_CategoryWeights

Weights per sensitive data category; each field is a non-negative integer (included; 0 contributes no score) or null (excluded from this profile)

object
authentication_and_secrets
required
One of:

Non-negative integer weight (0 is included with no contribution) or null if the category is not part of this profile

integer
behavioural_and_inferred
required
One of:

Non-negative integer weight (0 is included with no contribution) or null if the category is not part of this profile

integer
contact_information
required
One of:

Non-negative integer weight (0 is included with no contribution) or null if the category is not part of this profile

integer
criminal_justice
required
One of:

Non-negative integer weight (0 is included with no contribution) or null if the category is not part of this profile

integer
financial_information
required
One of:

Non-negative integer weight (0 is included with no contribution) or null if the category is not part of this profile

integer
gdpr_biometric_for_identification
required
One of:

Non-negative integer weight (0 is included with no contribution) or null if the category is not part of this profile

integer
gdpr_genetic_data
required
One of:

Non-negative integer weight (0 is included with no contribution) or null if the category is not part of this profile

integer
gdpr_political_opinions
required
One of:

Non-negative integer weight (0 is included with no contribution) or null if the category is not part of this profile

integer
gdpr_racial_or_ethnic_origin
required
One of:

Non-negative integer weight (0 is included with no contribution) or null if the category is not part of this profile

integer
gdpr_religious_or_philosophical_beliefs
required
One of:

Non-negative integer weight (0 is included with no contribution) or null if the category is not part of this profile

integer
gdpr_sex_life_or_sexual_orientation
required
One of:

Non-negative integer weight (0 is included with no contribution) or null if the category is not part of this profile

integer
gdpr_trade_union_membership
required
One of:

Non-negative integer weight (0 is included with no contribution) or null if the category is not part of this profile

integer
health_and_medical
required
One of:

Non-negative integer weight (0 is included with no contribution) or null if the category is not part of this profile

integer
location_and_tracking
required
One of:

Non-negative integer weight (0 is included with no contribution) or null if the category is not part of this profile

integer
minors_data
required
One of:

Non-negative integer weight (0 is included with no contribution) or null if the category is not part of this profile

integer
organisational_confidential
required
One of:

Non-negative integer weight (0 is included with no contribution) or null if the category is not part of this profile

integer
personal_identifiers
required
One of:

Non-negative integer weight (0 is included with no contribution) or null if the category is not part of this profile

integer
thresholds
required
RiskProfile_Ruleset_Thresholds
object
critical
required

Scores above this map to critical risk

integer
high
required

Scores above this map to at least high risk

integer
medium
required

Scores above this (after medium) map to at least medium risk

integer

Responses

Section titled “Responses”

200

Section titled “200”

Success

Media typeapplication/json
object
details
RiskProfile_Details
object
agreed_data_risk
DataRisk
object
action_profile
required
ActionProfile
object
create_data
required

Creates data

string
Allowed values: unknown allowed disallowed
destroy_data
required

Destroys data

string
Allowed values: unknown allowed disallowed
external_communication
required

Sends external communications

string
Allowed values: unknown allowed disallowed
financial_transactions
required

Performs financial transactions

string
Allowed values: unknown allowed disallowed
read_data
required

Reads data

string
Allowed values: unknown allowed disallowed
update_data
required

Updates data

string
Allowed values: unknown allowed disallowed
params_data_categories
required
DataCategories
object
authentication_and_secrets
required

Authentication and secrets present

string
Allowed values: unknown included excluded
behavioural_and_inferred
required

Behavioural and inferred data present

string
Allowed values: unknown included excluded
classification
required

Classification level

string
Allowed values: unknown public internal confidential restricted secret
contact_information
required

Contact information present

string
Allowed values: unknown included excluded
criminal_justice
required

Criminal justice data present

string
Allowed values: unknown included excluded
financial_information
required

Financial information present

string
Allowed values: unknown included excluded
gdpr_biometric_for_identification
required

GDPR: biometric data for identification

string
Allowed values: unknown included excluded
gdpr_genetic_data
required

GDPR: genetic data

string
Allowed values: unknown included excluded
gdpr_political_opinions
required

GDPR: political opinions

string
Allowed values: unknown included excluded
gdpr_racial_or_ethnic_origin
required

GDPR: racial or ethnic origin

string
Allowed values: unknown included excluded
gdpr_religious_or_philosophical_beliefs
required

GDPR: religious or philosophical beliefs

string
Allowed values: unknown included excluded
gdpr_sex_life_or_sexual_orientation
required

GDPR: sex life or sexual orientation

string
Allowed values: unknown included excluded
gdpr_trade_union_membership
required

GDPR: trade union membership

string
Allowed values: unknown included excluded
health_and_medical
required

Health and medical data present

string
Allowed values: unknown included excluded
location_and_tracking
required

Location and tracking data present

string
Allowed values: unknown included excluded
minors_data
required

Minors data present

string
Allowed values: unknown included excluded
organisational_confidential
required

Organisational confidential data present

string
Allowed values: unknown included excluded
personal_identifiers
required

Personal identifiers present

string
Allowed values: unknown included excluded
result_data_categories
required
DataCategories
object
authentication_and_secrets
required

Authentication and secrets present

string
Allowed values: unknown included excluded
behavioural_and_inferred
required

Behavioural and inferred data present

string
Allowed values: unknown included excluded
classification
required

Classification level

string
Allowed values: unknown public internal confidential restricted secret
contact_information
required

Contact information present

string
Allowed values: unknown included excluded
criminal_justice
required

Criminal justice data present

string
Allowed values: unknown included excluded
financial_information
required

Financial information present

string
Allowed values: unknown included excluded
gdpr_biometric_for_identification
required

GDPR: biometric data for identification

string
Allowed values: unknown included excluded
gdpr_genetic_data
required

GDPR: genetic data

string
Allowed values: unknown included excluded
gdpr_political_opinions
required

GDPR: political opinions

string
Allowed values: unknown included excluded
gdpr_racial_or_ethnic_origin
required

GDPR: racial or ethnic origin

string
Allowed values: unknown included excluded
gdpr_religious_or_philosophical_beliefs
required

GDPR: religious or philosophical beliefs

string
Allowed values: unknown included excluded
gdpr_sex_life_or_sexual_orientation
required

GDPR: sex life or sexual orientation

string
Allowed values: unknown included excluded
gdpr_trade_union_membership
required

GDPR: trade union membership

string
Allowed values: unknown included excluded
health_and_medical
required

Health and medical data present

string
Allowed values: unknown included excluded
location_and_tracking
required

Location and tracking data present

string
Allowed values: unknown included excluded
minors_data
required

Minors data present

string
Allowed values: unknown included excluded
organisational_confidential
required

Organisational confidential data present

string
Allowed values: unknown included excluded
personal_identifiers
required

Personal identifiers present

string
Allowed values: unknown included excluded
description
One of:

Risk profile description

string
id
RiskProfile_Id

A valid risk profile ID

string
inserted_at

When the risk profile was created

string format: date-time
name

Risk profile name

string
ruleset
RiskProfile_Ruleset
object
action_multipliers
required
RiskProfile_Ruleset_ActionMultipliers
object
create_data
required
One of:

Multiplier when the span creates data (null = N/A, valid range 1.0–5.0 in steps of 0.5)

number
destroy_data
required
One of:

Multiplier when the span destroys data (null = N/A, valid range 1.0–5.0 in steps of 0.5)

number
external_communication
required
One of:

Multiplier for external communication actions (null = N/A, valid range 1.0–5.0 in steps of 0.5)

number
financial_transactions
required
One of:

Multiplier for financial transaction actions (null = N/A, valid range 1.0–5.0 in steps of 0.5)

number
read_data
required
One of:

Multiplier when the span reads data (null = N/A, valid range 1.0–5.0 in steps of 0.5)

number
update_data
required
One of:

Multiplier when the span updates data (null = N/A, valid range 1.0–5.0 in steps of 0.5)

number
category_weights
required
RiskProfile_Ruleset_CategoryWeights

Weights per sensitive data category; each field is a non-negative integer (included; 0 contributes no score) or null (excluded from this profile)

object
authentication_and_secrets
required
One of:

Non-negative integer weight (0 is included with no contribution) or null if the category is not part of this profile

integer
behavioural_and_inferred
required
One of:

Non-negative integer weight (0 is included with no contribution) or null if the category is not part of this profile

integer
contact_information
required
One of:

Non-negative integer weight (0 is included with no contribution) or null if the category is not part of this profile

integer
criminal_justice
required
One of:

Non-negative integer weight (0 is included with no contribution) or null if the category is not part of this profile

integer
financial_information
required
One of:

Non-negative integer weight (0 is included with no contribution) or null if the category is not part of this profile

integer
gdpr_biometric_for_identification
required
One of:

Non-negative integer weight (0 is included with no contribution) or null if the category is not part of this profile

integer
gdpr_genetic_data
required
One of:

Non-negative integer weight (0 is included with no contribution) or null if the category is not part of this profile

integer
gdpr_political_opinions
required
One of:

Non-negative integer weight (0 is included with no contribution) or null if the category is not part of this profile

integer
gdpr_racial_or_ethnic_origin
required
One of:

Non-negative integer weight (0 is included with no contribution) or null if the category is not part of this profile

integer
gdpr_religious_or_philosophical_beliefs
required
One of:

Non-negative integer weight (0 is included with no contribution) or null if the category is not part of this profile

integer
gdpr_sex_life_or_sexual_orientation
required
One of:

Non-negative integer weight (0 is included with no contribution) or null if the category is not part of this profile

integer
gdpr_trade_union_membership
required
One of:

Non-negative integer weight (0 is included with no contribution) or null if the category is not part of this profile

integer
health_and_medical
required
One of:

Non-negative integer weight (0 is included with no contribution) or null if the category is not part of this profile

integer
location_and_tracking
required
One of:

Non-negative integer weight (0 is included with no contribution) or null if the category is not part of this profile

integer
minors_data
required
One of:

Non-negative integer weight (0 is included with no contribution) or null if the category is not part of this profile

integer
organisational_confidential
required
One of:

Non-negative integer weight (0 is included with no contribution) or null if the category is not part of this profile

integer
personal_identifiers
required
One of:

Non-negative integer weight (0 is included with no contribution) or null if the category is not part of this profile

integer
thresholds
required
RiskProfile_Ruleset_Thresholds
object
critical
required

Scores above this map to critical risk

integer
high
required

Scores above this map to at least high risk

integer
medium
required

Scores above this (after medium) map to at least medium risk

integer
type

Type of resource (always ‘risk_profile’)

string
Allowed values: risk_profile
updated_at

When the risk profile was last updated

string format: date-time
status
string
Allowed values: success
Example
{
  "details": {
    "agreed_data_risk": {
      "action_profile": {
        "create_data": "unknown",
        "destroy_data": "unknown",
        "external_communication": "unknown",
        "financial_transactions": "unknown",
        "read_data": "unknown",
        "update_data": "unknown"
      },
      "params_data_categories": {
        "authentication_and_secrets": "unknown",
        "behavioural_and_inferred": "unknown",
        "classification": "unknown",
        "contact_information": "unknown",
        "criminal_justice": "unknown",
        "financial_information": "unknown",
        "gdpr_biometric_for_identification": "unknown",
        "gdpr_genetic_data": "unknown",
        "gdpr_political_opinions": "unknown",
        "gdpr_racial_or_ethnic_origin": "unknown",
        "gdpr_religious_or_philosophical_beliefs": "unknown",
        "gdpr_sex_life_or_sexual_orientation": "unknown",
        "gdpr_trade_union_membership": "unknown",
        "health_and_medical": "unknown",
        "location_and_tracking": "unknown",
        "minors_data": "unknown",
        "organisational_confidential": "unknown",
        "personal_identifiers": "unknown"
      },
      "result_data_categories": {
        "authentication_and_secrets": "unknown",
        "behavioural_and_inferred": "unknown",
        "classification": "unknown",
        "contact_information": "unknown",
        "criminal_justice": "unknown",
        "financial_information": "unknown",
        "gdpr_biometric_for_identification": "unknown",
        "gdpr_genetic_data": "unknown",
        "gdpr_political_opinions": "unknown",
        "gdpr_racial_or_ethnic_origin": "unknown",
        "gdpr_religious_or_philosophical_beliefs": "unknown",
        "gdpr_sex_life_or_sexual_orientation": "unknown",
        "gdpr_trade_union_membership": "unknown",
        "health_and_medical": "unknown",
        "location_and_tracking": "unknown",
        "minors_data": "unknown",
        "organisational_confidential": "unknown",
        "personal_identifiers": "unknown"
      }
    },
    "description": null,
    "id": "013xrzp12g3nqk8ns6jadrqmpgrjkeny",
    "name": "High Risk",
    "ruleset": {
      "action_multipliers": {
        "create_data": null,
        "destroy_data": null,
        "external_communication": null,
        "financial_transactions": null,
        "read_data": null,
        "update_data": null
      },
      "category_weights": {
        "authentication_and_secrets": null,
        "behavioural_and_inferred": null,
        "contact_information": null,
        "criminal_justice": null,
        "financial_information": null,
        "gdpr_biometric_for_identification": null,
        "gdpr_genetic_data": null,
        "gdpr_political_opinions": null,
        "gdpr_racial_or_ethnic_origin": null,
        "gdpr_religious_or_philosophical_beliefs": null,
        "gdpr_sex_life_or_sexual_orientation": null,
        "gdpr_trade_union_membership": null,
        "health_and_medical": null,
        "location_and_tracking": null,
        "minors_data": null,
        "organisational_confidential": null,
        "personal_identifiers": null
      }
    },
    "type": "risk_profile"
  },
  "status": "success"
}

default

Section titled “default”

Error

Media typeapplication/json
One of:
object
code
string
Allowed values: bad_request bad_authtoken not_authenticated not_permitted not_implemented unknown not_found unexpected_ref_type unexpected invalid_action alert_unknown alert_already_cleared invalid_value required_value idempotency_key_already_used
message
string
status
string
Allowed values: error
Example
{
  "code": "bad_request",
  "status": "error"
}