This document describes the API for reading and archiving Vendors for companies using the Third Party Risk Management.
Returns a list of Third Party Risk Management Vendors.
Filter | Description |
---|---|
archived |
Flag to indicate if this Vendor is archived |
id |
The ID of the Vendor |
name |
The name of the Vendor |
owner_name |
The name of the User that is the owner for this Vendor |
risk_level |
The risk level for this Vendor |
updated_at |
The date this Vendor was last updated |
Bad Request
Unauthorized
Forbidden
[- {
- "data": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "type": "string",
- "attributes": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "archived": true,
- "archived_at": "2019-08-24T14:15:22Z",
- "authentication_type": "string",
- "data_collected": "string",
- "website": "string",
- "environment_types": [
- "string"
], - "last_reviewed_at": "2019-08-24T14:15:22Z",
- "name": "string",
- "other_information": "string",
- "owner_id": "8826ee2e-7933-4665-aef2-2393f84a0d05",
- "risk_level": "string",
- "security_url": "string",
- "services_provided": "string",
- "third_party_audit_report_concerns": "string",
- "two_factor_enabled": true,
- "updated_at": "2019-08-24T14:15:22Z",
- "vendor_risk_subassessment_responses": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "description": "string",
- "risk_level": "string",
- "tprm_vendor_id": "d6ebaa07-1824-4d95-8bfc-410738e0cc0a"
}
]
}, - "relationships": { },
- "links": { }
}, - "includes": { }
}
]
Returns a single Vendor by ID
Bad Request
Unauthorized
Forbidden
Resource not found
{- "data": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "type": "string",
- "attributes": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "archived": true,
- "archived_at": "2019-08-24T14:15:22Z",
- "authentication_type": "string",
- "data_collected": "string",
- "website": "string",
- "environment_types": [
- "string"
], - "last_reviewed_at": "2019-08-24T14:15:22Z",
- "name": "string",
- "other_information": "string",
- "owner_id": "8826ee2e-7933-4665-aef2-2393f84a0d05",
- "risk_level": "string",
- "security_url": "string",
- "services_provided": "string",
- "third_party_audit_report_concerns": "string",
- "two_factor_enabled": true,
- "updated_at": "2019-08-24T14:15:22Z",
- "vendor_risk_subassessment_responses": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "description": "string",
- "risk_level": "string",
- "tprm_vendor_id": "d6ebaa07-1824-4d95-8bfc-410738e0cc0a"
}
]
}, - "relationships": { },
- "links": { }
}, - "includes": { }
}
Archives a Vendor by ID.
Bad Request
Unauthorized
Forbidden
Resource not found
{- "data": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "type": "string",
- "attributes": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "archived": true,
- "archived_at": "2019-08-24T14:15:22Z",
- "authentication_type": "string",
- "data_collected": "string",
- "website": "string",
- "environment_types": [
- "string"
], - "last_reviewed_at": "2019-08-24T14:15:22Z",
- "name": "string",
- "other_information": "string",
- "owner_id": "8826ee2e-7933-4665-aef2-2393f84a0d05",
- "risk_level": "string",
- "security_url": "string",
- "services_provided": "string",
- "third_party_audit_report_concerns": "string",
- "two_factor_enabled": true,
- "updated_at": "2019-08-24T14:15:22Z",
- "vendor_risk_subassessment_responses": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "description": "string",
- "risk_level": "string",
- "tprm_vendor_id": "d6ebaa07-1824-4d95-8bfc-410738e0cc0a"
}
]
}, - "relationships": { },
- "links": { }
}, - "includes": { }
}