Skip to content
Prefactor Docs

List risk profiles

GET
/api/v1/risk_profile

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Query Parameters

Section titled “Query Parameters ”
pagination[offset]
pagination[page_size]

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Success

object
pagination
One of:
PaginationOutput

Pagination information

object
item_count

The total number of items

integer
item_end

The index of the last item in the page (one-based)

integer
item_start

The index of the first item in the page (one-based)

integer
next_page_offset
One of:

The offset of the next page (null if last page)

integer
page_count

The total number of pages

integer
page_index

The index of the current page (one-based)

integer
page_offset

The offset of the first item in the page (zero-based)

integer
page_size

The number of items per page

integer
previous_page_offset
One of:

The offset of the previous page (null if first page)

integer
Example
{
  "item_count": 200,
  "item_end": 100,
  "item_start": 91,
  "next_page_offset": 110,
  "page_count": 20,
  "page_index": 10,
  "page_offset": 90,
  "page_size": 10,
  "previous_page_offset": 80
}
status
string
Allowed values: success
Example
success
summaries
Array<object>
RiskProfile_Summary
object
description
One of:

Risk profile description

string
Example
Restrictive risk profile for sensitive operations
id
RiskProfile_Id

A valid risk profile ID

string
Example
013xrzp12g3nqk8ns6jadrqmpgrjkeny
name

Risk profile name

string
Example
High Risk
type

Type of resource (always ‘risk_profile’)

string
Allowed values: risk_profile
Example
risk_profile

default

Section titled “default ”

Error

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 invalid_value required_value idempotency_key_already_used
Example
bad_request
message
string
status
string
Allowed values: error
Example
error