Secureframe

App · 20 actions

Read personnel, devices, cloud resources, controls, frameworks, tests, vendors, risks and compliance tasks.

Actions

ActionWhat it does
Get a Cloud ResourceReturns a single Cloud Resource by ID
Get a ControlReturns a Control by ID
Get a DeviceReturns a single Device by ID
Get a FrameworkReturns a Framework by ID
Get a RiskReturns a Risk by ID
Get a TaskReturns a single Task by ID
Get a TestReturns a Test by ID
Get a UserReturns a User by ID
Get a User AccountReturns a single User Account by ID
Get a VendorReturns a single Vendor by ID DEPRECATED - Use the Third Party Risk Management Vendor [endpoint].If you have not done so already, please also migrate your Vendors frontend experience by going to the vendors page and clicking “Take me to new TPRM.”
List Cloud ResourcesReturns a list of Cloud Resources.
List ControlsReturns a list of Controls.
List DevicesReturns a list of Devices.
List FrameworksReturns a list of Frameworks.
List RisksReturns a list of Risks.
List TasksReturns a list of Tasks.
List TestsReturns a list of Tests.
List User AccountsReturns a list of User Accounts.
List UsersReturns a list of Users.
List VendorsReturns a list of Vendors.

Get a Cloud Resource

Returns a single Cloud Resource by ID

Inputs

Cloud resourcecloud_resource_idtextRequired
Scope response to id
Includeincludelist
Comma delimited string of relationships to include. Note: company_vendor_connection is deprecated, please use integration_connection instead.One or more of: company_vendor_connection, integration_connection, owner.
Relationshipsrelationshipstrue/false
Set to true to return the associated relationships data within the response. (default: false)

Outputs

Response.

dataobject
The response returned by the service.
has_moretrue/false
Whether another page is available.
next_cursortext
Pass to the continuation input to read the next page.
Example output
{
  "data": {
    "data": {
      "attributes": {
        "cloud_resource_type": "example",
        "created_at": "2026-11-13T12:00:00Z",
        "id": "00000000-0000-4000-8000-000000000001",
        "in_audit_scope": false,
        "out_of_audit_scope_reason": "development_asset",
        "region": "example",
        "tags": [],
        "third_party_id": "example",
        "updated_at": "2026-11-13T12:00:00Z",
        "vendor_name": "example"
      },
      "id": "00000000-0000-4000-8000-000000000001",
      "links": {},
      "relationships": {},
      "type": "example"
    },
    "included": []
  },
  "has_more": false,
  "next_cursor": null
}

Get a Control

Returns a Control by ID

Inputs

Controlcontrol_idtextRequired
Scope response to id
Includeincludelist
Comma delimited string of relationships to include.One or more of: author, owner.
Relationshipsrelationshipstrue/false
Set to true to return the associated relationships data within the response. (default: false)

Outputs

Response.

dataobject
The response returned by the service.
has_moretrue/false
Whether another page is available.
next_cursortext
Pass to the continuation input to read the next page.
Example output
{
  "data": {
    "data": {
      "attributes": {
        "at_risk_test_count": 0,
        "author_name": "example",
        "created_at": "2026-11-13T12:00:00Z",
        "custom": false,
        "description": "example",
        "disabled_justification": "example",
        "disabled_test_count": 0,
        "enabled": false,
        "failing_test_count": 0,
        "first_failed_at": "2026-11-13T12:00:00Z",
        "framework_ids": [],
        "framework_keys": [],
        "framework_requirement_keys": [],
        "health_status": "example",
        "id": "00000000-0000-4000-8000-000000000001",
        "implementation_date": "2026-11-13T12:00:00Z",
        "implementation_status": "example",
        "key": "example",
        "name": "example",
        "owner_assigned_at": "2026-11-13T12:00:00Z",
        "owner_name": "example",
        "passing_test_count": 0,
        "updated_at": "2026-11-13T12:00:00Z"
      },
      "id": "00000000-0000-4000-8000-000000000001",
      "links": {},
      "relationships": {},
      "type": "example"
    },
    "included": []
  },
  "has_more": false,
  "next_cursor": null
}

Get a Device

Returns a single Device by ID

Inputs

Devicedevice_idtextRequired
Scope response to id
Includeincludelist
Comma delimited string of relationships to include.One or more of: device_user, owner.
Relationshipsrelationshipstrue/false
Set to true to return the associated relationships data within the response. (default: false)

Outputs

Response.

dataobject
The response returned by the service.
has_moretrue/false
Whether another page is available.
next_cursortext
Pass to the continuation input to read the next page.
Example output
{
  "data": {
    "data": {
      "attributes": {
        "cpu": "example",
        "created_at": "2026-11-13T12:00:00Z",
        "device_name": "example",
        "hard_drive_encrypted": false,
        "id": "00000000-0000-4000-8000-000000000001",
        "in_audit_scope": false,
        "last_checkin_at": "2026-11-13T12:00:00Z",
        "local_firewall_enabled": false,
        "mac_address": "example",
        "make": "example",
        "memory": "example",
        "model": "example",
        "native_anti_virus_enabled": false,
        "os": "example",
        "out_of_audit_scope_reason": "development_asset",
        "password_enforcement_enabled": false,
        "remote_ip": "example",
        "serial_number": "example",
        "session_timeout_enabled": false,
        "updated_at": "2026-11-13T12:00:00Z"
      },
      "id": "00000000-0000-4000-8000-000000000001",
      "links": {},
      "relationships": {},
      "type": "example"
    },
    "included": []
  },
  "has_more": false,
  "next_cursor": null
}

Get a Framework

Returns a Framework by ID

Inputs

Frameworkframework_idtextRequired
Scope response to id

Outputs

Response.

dataobject
The response returned by the service.
has_moretrue/false
Whether another page is available.
next_cursortext
Pass to the continuation input to read the next page.
Example output
{
  "data": {
    "data": {
      "attributes": {
        "applicable_controls_count": 0,
        "applicable_framework_requirements_count": 0,
        "at_risk_test_count": 0,
        "created_at": "2026-11-13T12:00:00Z",
        "description": "example",
        "disabled_test_count": 0,
        "discarded_at": "2026-11-13T12:00:00Z",
        "failing_test_count": 0,
        "id": "00000000-0000-4000-8000-000000000001",
        "key": "example",
        "passing_test_count": 0,
        "title": "example",
        "updated_at": "2026-11-13T12:00:00Z"
      },
      "id": "00000000-0000-4000-8000-000000000001",
      "links": {},
      "relationships": {},
      "type": "example"
    },
    "included": []
  },
  "has_more": false,
  "next_cursor": null
}

Get a Risk

Returns a Risk by ID

Inputs

Riskrisk_idtextRequired
Scope response to id
Includeincludelist
Comma delimited string of relationships to include.One or more of: owner.
Relationshipsrelationshipstrue/false
Set to true to return the associated relationships data within the response. (default: false)

Outputs

Response.

dataobject
The response returned by the service.
has_moretrue/false
Whether another page is available.
next_cursortext
Pass to the continuation input to read the next page.
Example output
{
  "data": {
    "data": {
      "attributes": {
        "annualized_rate_of_occurrence": 0,
        "asset_value": 0,
        "categories": [],
        "cia": [],
        "company_id": "00000000-0000-4000-8000-000000000001",
        "created_at": "2026-11-13T12:00:00Z",
        "custom_risk_id": "example",
        "departments": [],
        "description": "example",
        "exposure_factor": 0,
        "id": "00000000-0000-4000-8000-000000000001",
        "impact_justification": "example",
        "likelihood_justification": "example",
        "notes": "example",
        "owner_id": "00000000-0000-4000-8000-000000000001",
        "reference_url": "example",
        "related_tickets": "example",
        "reported_by": "example",
        "residual_impact_justification": "example",
        "residual_likelihood_justification": "example",
        "responsible_team": "example",
        "source": "example",
        "status": "example",
        "treatment": "example",
        "treatment_decision_notes": "example",
        "uncertainty": 0,
        "updated_at": "2026-11-13T12:00:00Z"
      },
      "id": "00000000-0000-4000-8000-000000000001",
      "links": {},
      "relationships": {},
      "type": "example"
    },
    "included": []
  },
  "has_more": false,
  "next_cursor": null
}

Get a Task

Returns a single Task by ID

Inputs

Tasktask_idtextRequired
Scope response to id
Includeincludelist
Comma delimited string of relationships to include.One or more of: creator, owner.
Relationshipsrelationshipstrue/false
Set to true to return the associated relationships data within the response. (default: false)

Outputs

Response.

dataobject
The response returned by the service.
has_moretrue/false
Whether another page is available.
next_cursortext
Pass to the continuation input to read the next page.
Example output
{
  "data": {
    "data": {
      "attributes": {
        "auto_close": false,
        "category": "example",
        "completed_at": "2026-11-13T12:00:00Z",
        "created_at": "2026-11-13T12:00:00Z",
        "creator_id": "00000000-0000-4000-8000-000000000001",
        "description": "example",
        "dismissed_at": "2026-11-13T12:00:00Z",
        "due_at": "2026-11-13T12:00:00Z",
        "id": "00000000-0000-4000-8000-000000000001",
        "optional": false,
        "overdue": false,
        "owner_id": "00000000-0000-4000-8000-000000000001",
        "task_subtype": "example",
        "task_type": "example",
        "taskable_id": "00000000-0000-4000-8000-000000000001",
        "taskable_type": "CompanyTest",
        "title": "example",
        "updated_at": "2026-11-13T12:00:00Z"
      },
      "id": "00000000-0000-4000-8000-000000000001",
      "links": {},
      "relationships": {},
      "type": "example"
    },
    "included": []
  },
  "has_more": false,
  "next_cursor": null
}

Get a Test

Returns a Test by ID

Inputs

Testtest_idtextRequired
Scope response to id
Includeincludelist
Comma delimited string of relationships to include.One or more of: enabled_field_updated_by, owner, promoted_by.
Relationshipsrelationshipstrue/false
Set to true to return the associated relationships data within the response. (default: false)

Outputs

Response.

dataobject
The response returned by the service.
has_moretrue/false
Whether another page is available.
next_cursortext
Pass to the continuation input to read the next page.
Example output
{
  "data": {
    "data": {
      "attributes": {
        "control_ids": [],
        "control_keys": [],
        "created_at": "2026-11-13T12:00:00Z",
        "custom": false,
        "description": "example",
        "detailed_remediation_steps": "example",
        "disabled_justification": "example",
        "enabled": false,
        "enabled_field_updated_by_user_name": "example",
        "failure_message": "example",
        "first_failed_at": "2026-11-13T12:00:00Z",
        "framework_ids": [],
        "framework_keys": [],
        "health_status": "example",
        "id": "00000000-0000-4000-8000-000000000001",
        "key": "example",
        "last_evaluated": "2026-11-13T12:00:00Z",
        "last_passed_at": "2026-11-13T12:00:00Z",
        "next_due_date": "2026-11-13T12:00:00Z",
        "owner_assigned_at": "2026-11-13T12:00:00Z",
        "owner_name": "example",
        "pass": false,
        "passed_with_upload": false,
        "passed_with_upload_justification": "example",
        "promote_at": "2026-11-13T12:00:00Z",
        "promoted_by_name": "example",
        "recommended_action": "example",
        "required_implementation_date": "2026-11-13T12:00:00Z",
        "resource_category": "example",
        "test_domain": "example",
        "test_function": "example",
        "test_interval_seconds": 0,
        "test_type": "upload",
        "title": "example",
        "tolerance_window_seconds": 0,
        "updated_at": "2026-11-13T12:00:00Z",
        "vendor_name": "example"
      },
      "id": "00000000-0000-4000-8000-000000000001",
      "links": {},
      "relationships": {},
      "type": "example"
    },
    "included": []
  },
  "has_more": false,
  "next_cursor": null
}

Get a User

Returns a User by ID

Inputs

Membermember_idtextRequired
Scope response to id
Includeincludelist
Comma delimited string of relationships to include.One or more of: manager.
Relationshipsrelationshipstrue/false
Set to true to return the associated relationships data within the response. (default: false)

Outputs

Response.

dataobject
The response returned by the service.
has_moretrue/false
Whether another page is available.
next_cursortext
Pass to the continuation input to read the next page.
Example output
{
  "data": {
    "data": {
      "attributes": {
        "access_role": "example",
        "active": false,
        "active_source": "example",
        "created_at": "2026-11-13T12:00:00Z",
        "department_id": "example",
        "email": "example",
        "employee_type": "contractor",
        "end_date": "2026-11-13T12:00:00Z",
        "first_name": "example",
        "id": "00000000-0000-4000-8000-000000000001",
        "image_url": "example",
        "in_audit_scope": false,
        "invited": false,
        "invited_at": "2026-11-13T12:00:00Z",
        "last_name": "example",
        "manager_name": "example",
        "middle_name": "example",
        "name": "example",
        "onboarding_status": "example",
        "personnel_status": "example",
        "policies_acceptance_expires_at": "2026-11-13T12:00:00Z",
        "preferred_first_name": "example",
        "role": "example",
        "secureframe_agent_acknowledged_at": "2026-11-13T12:00:00Z",
        "start_date": "2026-11-13T12:00:00Z",
        "title": "example",
        "updated_at": "2026-11-13T12:00:00Z"
      },
      "id": "00000000-0000-4000-8000-000000000001",
      "links": {},
      "relationships": {},
      "type": "example"
    },
    "included": []
  },
  "has_more": false,
  "next_cursor": null
}

Get a User Account

Returns a single User Account by ID

Inputs

User accountuser_account_idtextRequired
Scope response to id
Includeincludelist
Comma delimited string of relationships to include. Note: company_vendor_connection is deprecated, please use integration_connection instead.One or more of: company_user, company_vendor_connection, integration_connection.
Relationshipsrelationshipstrue/false
Set to true to return the associated relationships data within the response. (default: false)

Outputs

Response.

dataobject
The response returned by the service.
has_moretrue/false
Whether another page is available.
next_cursortext
Pass to the continuation input to read the next page.
Example output
{
  "data": {
    "data": {
      "attributes": {
        "active": false,
        "created_at": "2026-11-13T12:00:00Z",
        "email": "example",
        "first_name": "example",
        "has_user": false,
        "id": "00000000-0000-4000-8000-000000000001",
        "last_name": "example",
        "third_party_id": "example",
        "updated_at": "2026-11-13T12:00:00Z",
        "username": "example",
        "vendor_name": "example"
      },
      "id": "00000000-0000-4000-8000-000000000001",
      "links": {},
      "relationships": {},
      "type": "example"
    },
    "included": []
  },
  "has_more": false,
  "next_cursor": null
}

Get a Vendor

Returns a single Vendor by ID DEPRECATED - Use the Third Party Risk Management Vendor [endpoint].If you have not done so already, please also migrate your Vendors frontend experience by going to the vendors page and clicking “Take me to new TPRM.”

Inputs

Vendorvendor_idtextRequired
Scope response to id

Outputs

Response.

dataobject
The response returned by the service.
has_moretrue/false
Whether another page is available.
next_cursortext
Pass to the continuation input to read the next page.
Example output
{
  "data": {
    "data": {
      "attributes": {
        "archived": false,
        "archived_at": "2026-11-13T12:00:00Z",
        "archived_by": "00000000-0000-4000-8000-000000000001",
        "audit_scopes": [],
        "authentication_type": "password",
        "data_collected": "example",
        "date_of_engagement": "2026-11-13T12:00:00Z",
        "domain": "example",
        "environment_types": [],
        "id": "00000000-0000-4000-8000-000000000001",
        "last_reviewed_at": "2026-11-13T12:00:00Z",
        "name": "example",
        "operational_reliance": "example",
        "other_information": "example",
        "owner_id": "00000000-0000-4000-8000-000000000001",
        "risk_level": "high",
        "security_url": "example",
        "services": "example",
        "terminated_at": "2026-11-13T12:00:00Z",
        "third_party_audit_report_concerns": "example",
        "two_factor_enabled": false,
        "updated_at": "2026-11-13T12:00:00Z"
      },
      "id": "00000000-0000-4000-8000-000000000001",
      "links": {},
      "relationships": {},
      "type": "example"
    },
    "included": []
  },
  "has_more": false,
  "next_cursor": null
}

List Cloud Resources

Returns a list of Cloud Resources.

Inputs

Includeincludelist
Comma delimited string of relationships to include. Note: company_vendor_connection is deprecated, please use integration_connection instead.One or more of: company_vendor_connection, integration_connection, owner.
Pagepagenumber
Used for pagination of response data (default: page 1). Specifies the offset of the next block of data to receive. Must be 1 or greater.At least 1.
Per pageper_pagenumber
Used for pagination of response data (default: 100 items per response). Specifies the number of results for a given page. Must be 1 or greater. 100 is also the maximum: a larger value is capped rather than rejected, so this parameter can only reduce the page size.From 1 to 100.
Qqtext
Search and filter the Cloud Resource data using Lucene syntax.
Relationshipsrelationshipstrue/false
Set to true to return the associated relationships data within the response. (default: false)
Sortsorttext
Comma delimited string of fields to sort the results by, applied in the order given. Prefix a field with `-` to sort it in descending order, for example `?sort=-cloud_resource_type,created_at`. Sortable fields: `cloud_resource_type`, `created_at`, `id`, `in_audit_scope`, `region`, `third_party_id`, `updated_at`, `vendor_name`.

Outputs

Response.

dataobject
The response returned by the service.
has_moretrue/false
Whether another page is available.
next_cursortext
Pass to the continuation input to read the next page.
Example output
{
  "data": {
    "data": [],
    "included": [],
    "meta": {
      "total": 0
    }
  },
  "has_more": false,
  "next_cursor": null
}

List Controls

Returns a list of Controls.

Inputs

Includeincludelist
Comma delimited string of relationships to include.One or more of: author, owner.
Pagepagenumber
Used for pagination of response data (default: page 1). Specifies the offset of the next block of data to receive. Must be 1 or greater.At least 1.
Per pageper_pagenumber
Used for pagination of response data (default: 100 items per response). Specifies the number of results for a given page. Must be 1 or greater. 100 is also the maximum: a larger value is capped rather than rejected, so this parameter can only reduce the page size.From 1 to 100.
Qqtext
Search and filter the Control data using Lucene syntax.
Relationshipsrelationshipstrue/false
Set to true to return the associated relationships data within the response. (default: false)
Sortsorttext
Comma delimited string of fields to sort the results by, applied in the order given. Prefix a field with `-` to sort it in descending order, for example `?sort=-author_name,description`. Sortable fields: `author_name`, `description`, `key`, `name`, `frameworks`, `created_at`, `custom`, `enabled`, `first_failed_at`, `health_status`, `id`, `implementation_date`, `owner_assigned_at`, `owner_name`, `updated_at`.

Outputs

Response.

dataobject
The response returned by the service.
has_moretrue/false
Whether another page is available.
next_cursortext
Pass to the continuation input to read the next page.
Example output
{
  "data": {
    "data": [],
    "included": [],
    "meta": {
      "total": 0
    }
  },
  "has_more": false,
  "next_cursor": null
}

List Devices

Returns a list of Devices.

Inputs

Includeincludelist
Comma delimited string of relationships to include.One or more of: device_user, owner.
Pagepagenumber
Used for pagination of response data (default: page 1). Specifies the offset of the next block of data to receive. Must be 1 or greater.At least 1.
Per pageper_pagenumber
Used for pagination of response data (default: 100 items per response). Specifies the number of results for a given page. Must be 1 or greater. 100 is also the maximum: a larger value is capped rather than rejected, so this parameter can only reduce the page size.From 1 to 100.
Qqtext
Search and filter the Device data using Lucene syntax.
Relationshipsrelationshipstrue/false
Set to true to return the associated relationships data within the response. (default: false)
Sortsorttext
Comma delimited string of fields to sort the results by, applied in the order given. Prefix a field with `-` to sort it in descending order, for example `?sort=-cpu,created_at`. Sortable fields: `cpu`, `created_at`, `device_name`, `device_user_name`, `hard_drive_encrypted`, `id`, `in_audit_scope`, `last_checkin_at`, `local_firewall_enabled`, `mac_address`, `make`, `memory`, `model`, `native_anti_virus_enabled`, `os`, `out_of_audit_scope_reason`, `owner_name`, `password_enforcement_enabled`, `remote_ip`, `serial_number`, `session_timeout_enabled`, `updated_at`.

Outputs

Response.

dataobject
The response returned by the service.
has_moretrue/false
Whether another page is available.
next_cursortext
Pass to the continuation input to read the next page.
Example output
{
  "data": {
    "data": [],
    "included": [],
    "meta": {
      "total": 0
    }
  },
  "has_more": false,
  "next_cursor": null
}

List Frameworks

Returns a list of Frameworks.

Inputs

Pagepagenumber
Used for pagination of response data (default: page 1). Specifies the offset of the next block of data to receive. Must be 1 or greater.At least 1.
Per pageper_pagenumber
Used for pagination of response data (default: 100 items per response). Specifies the number of results for a given page. Must be 1 or greater. 100 is also the maximum: a larger value is capped rather than rejected, so this parameter can only reduce the page size.From 1 to 100.
Qqtext
Search and filter the Framework data using Lucene syntax.
Sortsorttext
Comma delimited string of fields to sort the results by, applied in the order given. Prefix a field with `-` to sort it in descending order, for example `?sort=-created_at,id`. Sortable fields: `created_at`, `id`, `title`, `updated_at`.

Outputs

Response.

dataobject
The response returned by the service.
has_moretrue/false
Whether another page is available.
next_cursortext
Pass to the continuation input to read the next page.
Example output
{
  "data": {
    "data": [],
    "included": [],
    "meta": {
      "total": 0
    }
  },
  "has_more": false,
  "next_cursor": null
}

List Risks

Returns a list of Risks.

Inputs

Includeincludelist
Comma delimited string of relationships to include.One or more of: owner.
Pagepagenumber
Used for pagination of response data (default: page 1). Specifies the offset of the next block of data to receive. Must be 1 or greater.At least 1.
Per pageper_pagenumber
Used for pagination of response data (default: 100 items per response). Specifies the number of results for a given page. Must be 1 or greater. 100 is also the maximum: a larger value is capped rather than rejected, so this parameter can only reduce the page size.From 1 to 100.
Qqtext
Search and filter the Risk data using Lucene syntax.
Relationshipsrelationshipstrue/false
Set to true to return the associated relationships data within the response. (default: false)
Sortsorttext
Comma delimited string of fields to sort the results by, applied in the order given. Prefix a field with `-` to sort it in descending order, for example `?sort=-archived,id`. Sortable fields: `archived`, `id`, `custom_risk_id`, `owner_name`, `description`.

Outputs

Response.

dataobject
The response returned by the service.
has_moretrue/false
Whether another page is available.
next_cursortext
Pass to the continuation input to read the next page.
Example output
{
  "data": {
    "data": [],
    "included": [],
    "meta": {
      "total": 0
    }
  },
  "has_more": false,
  "next_cursor": null
}

List Tasks

Returns a list of Tasks.

Inputs

Includeincludelist
Comma delimited string of relationships to include.One or more of: creator, owner.
Pagepagenumber
Used for pagination of response data (default: page 1). Specifies the offset of the next block of data to receive. Must be 1 or greater.At least 1.
Per pageper_pagenumber
Used for pagination of response data (default: 100 items per response). Specifies the number of results for a given page. Must be 1 or greater. 100 is also the maximum: a larger value is capped rather than rejected, so this parameter can only reduce the page size.From 1 to 100.
Qqtext
Search and filter the Task data using Lucene syntax.
Relationshipsrelationshipstrue/false
Set to true to return the associated relationships data within the response. (default: false)
Sortsorttext
Comma delimited string of fields to sort the results by, applied in the order given. Prefix a field with `-` to sort it in descending order, for example `?sort=-category,completed`. Sortable fields: `category`, `completed`, `completed_at`, `created_at`, `creator_name`, `description`, `dismissed_at`, `due_at`, `id`, `overdue`, `owner_id`, `owner_name`, `task_subtype`, `task_type`, `taskable_id`, `taskable_type`, `title`.

Outputs

Response.

dataobject
The response returned by the service.
has_moretrue/false
Whether another page is available.
next_cursortext
Pass to the continuation input to read the next page.
Example output
{
  "data": {
    "data": [],
    "included": [],
    "meta": {
      "total": 0
    }
  },
  "has_more": false,
  "next_cursor": null
}

List Tests

Returns a list of Tests.

Inputs

Includeincludelist
Comma delimited string of relationships to include.One or more of: enabled_field_updated_by, owner, promoted_by.
Pagepagenumber
Used for pagination of response data (default: page 1). Specifies the offset of the next block of data to receive. Must be 1 or greater.At least 1.
Per pageper_pagenumber
Used for pagination of response data (default: 100 items per response). Specifies the number of results for a given page. Must be 1 or greater. 100 is also the maximum: a larger value is capped rather than rejected, so this parameter can only reduce the page size.From 1 to 100.
Qqtext
Search and filter the Test data using Lucene syntax.
Relationshipsrelationshipstrue/false
Set to true to return the associated relationships data within the response. (default: false)
Sortsorttext
Comma delimited string of fields to sort the results by, applied in the order given. Prefix a field with `-` to sort it in descending order, for example `?sort=-author_name,created_at`. Sortable fields: `author_name`, `created_at`, `custom`, `description`, `enabled`, `enabled_field_updated_by_user`, `frameworks`, `health_status`, `id`, `key`, `last_evaluated`, `next_due_date`, `owner_assigned_at`, `owner_name`, `pass`, `passed_with_upload`, `promote_at`, `recommended_action`, `required_implementation_date`, `resource_category`, `status`, `test_domain`, `test_function`, `test_interval_seconds`, `test_type`, `title`, `tolerance_window_seconds`, `updated_at`, `vendor_name`.

Outputs

Response.

dataobject
The response returned by the service.
has_moretrue/false
Whether another page is available.
next_cursortext
Pass to the continuation input to read the next page.
Example output
{
  "data": {
    "data": [],
    "included": [],
    "meta": {
      "total": 0
    }
  },
  "has_more": false,
  "next_cursor": null
}

List User Accounts

Returns a list of User Accounts.

Inputs

Includeincludelist
Comma delimited string of relationships to include. Note: company_vendor_connection is deprecated, please use integration_connection instead.One or more of: company_user, company_vendor_connection, integration_connection.
Pagepagenumber
Used for pagination of response data (default: page 1). Specifies the offset of the next block of data to receive. Must be 1 or greater.At least 1.
Per pageper_pagenumber
Used for pagination of response data (default: 100 items per response). Specifies the number of results for a given page. Must be 1 or greater. 100 is also the maximum: a larger value is capped rather than rejected, so this parameter can only reduce the page size.From 1 to 100.
Qqtext
Search and filter the User Account data using Lucene syntax.
Relationshipsrelationshipstrue/false
Set to true to return the associated relationships data within the response. (default: false)
Sortsorttext
Comma delimited string of fields to sort the results by, applied in the order given. Prefix a field with `-` to sort it in descending order, for example `?sort=-active,created_at`. Sortable fields: `active`, `created_at`, `email`, `first_name`, `has_user`, `id`, `last_name`, `third_party_id`, `updated_at`, `vendor_name`.

Outputs

Response.

dataobject
The response returned by the service.
has_moretrue/false
Whether another page is available.
next_cursortext
Pass to the continuation input to read the next page.
Example output
{
  "data": {
    "data": [],
    "included": [],
    "meta": {
      "total": 0
    }
  },
  "has_more": false,
  "next_cursor": null
}

List Users

Returns a list of Users.

Inputs

Includeincludelist
Comma delimited string of relationships to include.One or more of: manager.
Pagepagenumber
Used for pagination of response data (default: page 1). Specifies the offset of the next block of data to receive. Must be 1 or greater.At least 1.
Per pageper_pagenumber
Used for pagination of response data (default: 100 items per response). Specifies the number of results for a given page. Must be 1 or greater. 100 is also the maximum: a larger value is capped rather than rejected, so this parameter can only reduce the page size.From 1 to 100.
Qqtext
Search and filter the User data using Lucene syntax.
Relationshipsrelationshipstrue/false
Set to true to return the associated relationships data within the response. (default: false)
Sortsorttext
Comma delimited string of fields to sort the results by, applied in the order given. Prefix a field with `-` to sort it in descending order, for example `?sort=-active,department_id`. Sortable fields: `active`, `department_id`, `email`, `employee_type`, `end_date`, `first_name`, `id`, `in_audit_scope`, `invited`, `invited_at`, `last_name`, `name`, `onboarding_status`, `personnel_status`, `preferred_first_name`, `secureframe_agent_acknowledged_at`, `start_date`, `title`.

Outputs

Response.

dataobject
The response returned by the service.
has_moretrue/false
Whether another page is available.
next_cursortext
Pass to the continuation input to read the next page.
Example output
{
  "data": {
    "data": [],
    "included": [],
    "meta": {
      "total": 0
    }
  },
  "has_more": false,
  "next_cursor": null
}

List Vendors

Returns a list of Vendors. DEPRECATED - Use the Third Party Risk Management Vendor [endpoint].If you have not done so already, please also migrate your Vendors frontend experience by going to the vendors page and clicking “Take me to new TPRM.”

Inputs

Pagepagenumber
Used for pagination of response data (default: page 1). Specifies the offset of the next block of data to receive. Must be 1 or greater.At least 1.
Per pageper_pagenumber
Used for pagination of response data (default: 100 items per response). Specifies the number of results for a given page. Must be 1 or greater. 100 is also the maximum: a larger value is capped rather than rejected, so this parameter can only reduce the page size.From 1 to 100.
Qqtext
Search and filter the Vendor data using Lucene syntax.
Sortsorttext
Comma delimited string of fields to sort the results by, applied in the order given. Prefix a field with `-` to sort it in descending order, for example `?sort=-archived,id`. Sortable fields: `archived`, `id`, `name`, `owner_name`, `risk_level`, `updated_at`.

Outputs

Response.

dataobject
The response returned by the service.
has_moretrue/false
Whether another page is available.
next_cursortext
Pass to the continuation input to read the next page.
Example output
{
  "data": {
    "data": [],
    "included": [],
    "meta": {
      "total": 0
    }
  },
  "has_more": false,
  "next_cursor": null
}

On this page