OneTrust

the onetrust connector enables automated interactions with onetrust's assessment and management features, facilitating streamlined compliance and risk management processes onetrust is a comprehensive platform for privacy, security, and third party risk management this connector enables seamless integration with onetrust, allowing users to automate the retrieval, modification, and management of assessments directly within swimlane turbine by leveraging this connector, organizations can enhance their compliance workflows, streamline risk assessments, and ensure timely responses to privacy and security issues prerequisites to effectively utilize the onetrust connector within swimlane turbine, ensure you have the following prerequisites oauth2 client credentials for secure authentication, which include url endpoint for onetrust api access client id unique identifier for oauth2 authentication client secret confidential key for oauth2 authentication alternatively, an api key authentication method is available, requiring url endpoint for onetrust api access api key secret token to authenticate api requests capabilities this connector provides the following capabilities get assessment get list of assessments get list of assessments by criteria launch assessment modify assessment reassign assessment set primary record oauth 2 0 scopes scope to api assignments the following table details the apis an external system will access when the corresponding scope is defined for the respective client credential oauth scope action assessment read get assessment assessment read get list of assessments assessment launch assessment notes https //developer onetrust com/onetrust/reference/onetrust api reference https //developer onetrust com/onetrust/reference/oauth 20 scopes configurations onetrust api key authentication authenticates using an api key configuration parameters parameter description type required url a url to the target host string required x apikey api key string required verify ssl verify ssl certificate boolean optional http proxy a proxy to route requests through string optional onetrust oauth 2 0 client credentials authenticates using oauth 2 0 client credentials configuration parameters parameter description type required url a url to the target host string required token url string optional client id the client id string required client secret the client secret string required scope permission scopes for this action array optional verify ssl verify ssl certificate boolean optional http proxy a proxy to route requests through string optional actions get assessment retrieve detailed information for a specific onetrust assessment, including respondents, questions, and risks endpoint url /api/assessment/v2/assessments/{{assessmentid}}/export method get input argument name type required description path parameters assessmentid string required id of an assessment parameters excludeskippedquestions boolean optional indicates whether skipped questions are included in the response payload when set to true, questions on the assessment that are hidden by skip or show logic will be excluded from the response payload when set to false, questions on the assessment that are hidden by skip or show logic will be included in the response payload with the "hidden" boolean set to true input example {"parameters" {"excludeskippedquestions"\ false},"path parameters" {"assessmentid" "f47ac10b 58cc 4372 a567 0e02b2c3d479"}} output parameter type description status code number http status code of the response reason string response reason phrase approvers array output field approvers approvers approvalstate string output field approvers approvalstate approvers approvedon object output field approvers approvedon approvers id string unique identifier approvers name string name of the resource assessmentid string unique identifier assessmentnumber number output field assessmentnumber completedon string output field completedon createdby object output field createdby createdby id string unique identifier createdby name string name of the resource createddt string output field createddt description string output field description highrisk number output field highrisk inherentriskscore number score value lastupdated string output field lastupdated lowrisk number output field lowrisk mediumrisk number output field mediumrisk name string name of the resource openriskcount number count value orggroup object output field orggroup orggroup id string unique identifier orggroup name string name of the resource output example {"approvers" \[{"approvalstate" "string","approvedon" {},"id" "12345678 1234 1234 1234 123456789abc","name" "example name"}],"assessmentid" "string","assessmentnumber" 123,"completedon" "string","createdby" {"id" "12345678 1234 1234 1234 123456789abc","name" "example name"},"createddt" "string","description" "string","highrisk" 123,"inherentriskscore" 123,"lastupdated" "string","lowrisk" 123,"mediumrisk" 123,"name" "example name","openriskcount" 123,"orggroup" {"id" "12345678 1234 1234 1234 12345 get list of assessments retrieve a comprehensive list of all assessments with basic details from onetrust endpoint url /api/assessment/v2/assessments method get input argument name type required description parameters assessmentstatuses array optional status of an assessment parameters assessmentarchivalstate string optional parameter to retrieve a list of active/archived or both active and archived assessments parameters page number optional page number of the results list (0…n) parameters size number optional number of records per page (0…n) input example {"parameters" {"assessmentstatuses" \["not started"],"assessmentarchivalstate" "all","page" 0,"size" 20}} output parameter type description status code number http status code of the response reason string response reason phrase content array response content content assessmentid string unique identifier content createdt string response content content inherentriskscore number response content content lastupdated string response content content name string name of the resource content number number response content content openriskcount number response content content orggroupname string name of the resource content primaryinventorydetails object response content content primaryinventorydetails primaryinventoryid string unique identifier content primaryinventorydetails primaryinventoryname string name of the resource content primaryinventorydetails primaryinventorynumber number response content content residualriskscore number unique identifier content result string response content content resultid string unique identifier content resultname string name of the resource content state string response content content status string status value content tags array response content content tags file name string name of the resource content tags file string response content content targetriskscore object response content output example {"status code" 200,"response headers" {"content length" "140","content type" "application/json","date" "mon, 17 jun 2024 20 37 23 gmt"},"reason" "ok","json body" {"content" \[{}],"page" {"number" 0,"size" 1,"totalelements" 50,"totalpages" 50}}} get list of assessments by criteria retrieve a comprehensive list of assessments from onetrust, with optional filtering based on specific criteria endpoint url /api/assessment/v3/assessments/list method post input argument name type required description parameters assessmentarchivalstate string optional assessment archival state parameters assessmentstatuses array optional assessment statuses parameters templatetypes array optional template types parameters page number optional page number of the results list (0…n) parameters size number optional number of records per page (0…n) parameters sort string optional returns the assessment list in sorted order by default returns in descending order of assessment number filtercriteria array optional parameter for get list of assessments by criteria filtercriteria field string optional name of the property to be filtered on filtercriteria operation string optional parameter for get list of assessments by criteria filtercriteria tovalue array optional used for deleteddate, deadline filters filtercriteria value array optional expected value of the provided field, can also be a list of values for deadline and deleteddate, we can use a string (option 1) and for rest of the parameters, use array of strings (option 2) as an example, the value for deadline or deleteddate could be "2023 08 27t18 30 00 000z" input example {"parameters" {"assessmentarchivalstate" "all","page" 0,"size" 10,"sort" "number,desc"},"json body" {"filtercriteria" \[{"field" "respondentid","operation" "=","tovalue" \["aabdaf95 7eb3 4583 986e d5d3868d4c14"],"value" \["aabdaf95 7eb3 4583 986e d5d3868d4c14"]}]}} output parameter type description status code number http status code of the response reason string response reason phrase content array response content content approvalstagename string name of the resource content approvers array response content content approvers assigneetype object type of the resource content approvers deleted boolean response content content approvers email object response content content approvers fullname string name of the resource content approvers id string unique identifier content assessmentid string unique identifier content assessmentrisklevelname string name of the resource content attestationrequired boolean response content content badgecolor string response content content canresendlink boolean response content content createdt string response content content createdby string response content content deadline string response content content editallresponseswheninprogress boolean response content content inherentrisklevelname string name of the resource content name string name of the resource content number number response content content openinforequestcount number response content content openriskcount number response content content orggroupid string unique identifier output example {"status code" 200,"response headers" {"content length" "140","content type" "application/json","date" "mon, 17 jun 2024 20 37 23 gmt"},"reason" "ok","json body" {"content" \[{},{}],"page" {"number" 0,"size" 10,"totalelements" 2,"totalpages" 1}}} launch assessment initiates a new assessment in onetrust with specified details and assigns it to selected respondents endpoint url /api/assessment/v2/assessments method post input argument name type required description approverid string optional id of the user/user group who should be assigned as the approver of the assessment approvername string optional name of the user/user group who should be assigned as the approver of the assessment deadline string optional date by which the assessment should be completed the format is yyyy mm ddthh\ mm \ ss fffz description string optional description of the assessment inventorydetails object optional parameter for launch assessment inventorydetails inventoryid string required id of the primary record of the assessment inventorydetails inventoryname string required name of the primary record of the assessment inventorydetails inventorytypeid number required id of the primary record type (assets, processing activities, vendors, etc ) values for inventorytypeid assets = ''20''; processing activities = ''30''; vendors = ''50''; entities = ''60'' name string optional name of the assessment orggroupid string optional id of the organization group that should be assigned to the assessment orggroupname string optional name of the organization group that should be assigned to the assessment reminder number optional number of days before the deadline to send an automatic reminder to the respondent respondentcreationtype string optional indicates whether new respondents are created as invited users or project respondents when launching an assessment respondents array optional list of respondents assigned to the assessment respondents comment string optional comments that will be provided to the respondent(s) in an email notification respondents respondentid string optional id of the user/user group to assign to the assessment as a respondent respondents respondentname string required name of the user/user group to assign as a respondent respondents sectionid string optional id of a section within the assessment ruleid string optional this parameter value can be null templateid string optional id used to launch an assessment using a specific version of a template templaterootversionid string optional id used to launch an assessment using the latest published version of a template (recommended to use in integrations) triggeredbyassessmentid string optional the unique identifier of the assessment that triggered this action triggeredbyassessmentname string optional the name of the assessment that triggered this action input example {"json body" {"approverid" "","approvername" "","deadline" "2024 09 30t17 00 00 000z","description" "","inventorydetails" {"inventoryid" "a3c5e4b1 39cd 4b2a a8e4 1c347890c482","inventoryname" "laptop dell xps 13","inventorytypeid" 20},"name" "","orggroupid" "","orggroupname" "","reminder" 9223372036854776000,"respondentcreationtype" "","respondents" \[{"comment" "","respondentid" "","respondentname" "david williams\@example com","sectionid" ""}],"ruleid" "","templateid" "","templaterootversionid" "","triggeredbyassessmentid" "","triggeredbyassessmentname" ""}} output parameter type description status code number http status code of the response reason string response reason phrase output example {"status code" 201,"response headers" {"content length" "140","content type" "application/json","date" "mon, 17 jun 2024 20 37 23 gmt"},"reason" "created","json body" {}} modify assessment update an assessment's name, description, deadline, and reminder in onetrust using the provided assessmentid endpoint url /api/assessment/v2/assessments/{{assessmentid}}/metadata method patch input argument name type required description path parameters assessmentid string required parameters for the modify assessment action deadline string optional date by which the assessment must be completed the date format is yyyy mm ddthh\ mm \ ss fffz description string optional description of the assessment name string optional name of the assessment reminder number optional number of days before the deadline to send an automatic reminder to the respondent input example {"json body" {"deadline" "2021 04 30t04 00 00 000z","reminder" 5},"path parameters" {"assessmentid" "550e8400 e29b 41d4 a716 446655440000"}} output parameter type description status code number http status code of the response reason string response reason phrase output example {"status code" 204,"response headers" {"content length" "140","content type" "application/json","date" "mon, 17 jun 2024 20 37 23 gmt"},"reason" "no content","json body" {}} reassign assessment reassign the organization, approvers, and respondents for a specific onetrust assessment using the provided assessmentid endpoint url /api/assessment/v2/assessments/{{assessmentid}}/reassign method put input argument name type required description path parameters assessmentid string required id of an assessment approvers array optional the details of the user who is assigned as an approver to the assessment approvers approverid string optional id of the user to assign to the assessment as an approver approvers approvername string optional name of the user to assign to the assessment as a respondent approvers comment string optional comments that will be provided to the approver in an email notification approvers workflowstageids array optional user will be added as an approver for the workflowstageids mentioned in the request if the workflowstageids is empty then the user will be added as an approver to all the stages orggroupid string optional id of the organization group that should be reassigned to the assessment respondentcreationtype string optional use this field to select whether new respondents are created as invited users or project respondents respondents array optional used to indicate whether the new respondents are created as invited users or project respondents respondents comment string optional comments that will be provided to the respondent(s) in an email notification respondents respondentid string optional id of the user/user group to assign to the assessment as a respondent respondents respondentname string required name of the user/user group to assign as a respondent respondents sectionid string optional id of a section within the assessment input example {"json body" {"approvers" \[{"approverid" "3b241101 e2bb 4255 8caf 4136c566a964"}],"respondentcreationtype" "invited","respondents" {"respondentname" "emily jones\@example com"}},"path parameters" {"assessmentid" "9d0e0c1e cb30 4a6b 95ad 0e02b2c3d479"}} output parameter type description status code number http status code of the response reason string response reason phrase output example {"status code" 204,"response headers" {"content length" "140","content type" "application/json","date" "mon, 17 jun 2024 20 37 23 gmt"},"reason" "no content","json body" {}} set primary record edit or assign a primary record to an assessment in onetrust using the provided assessmentid and primary record details endpoint url /api/assessment/v2/assessments/{{assessmentid}}/primary records method put input argument name type required description path parameters assessmentid string required id of an assessment primaryrecordids array optional unique id of the primary record primaryrecordtype string optional type of record designated as the main purpose of an assessment input example {"json body" {"primaryrecordids" \["acr 98765","acr 65432","acr 32109"],"primaryrecordtype" "assets"},"path parameters" {"assessmentid" "123e4567 e89b 12d3 a456 426614174000"}} output parameter type description status code number http status code of the response reason string response reason phrase output example {"status code" 204,"response headers" {"content length" "140","content type" "application/json","date" "mon, 17 jun 2024 20 37 23 gmt"},"reason" "no content","json body" {}} response headers header description example content length the length of the response body in bytes 140 content type the media type of the resource application/json date the date and time at which the message was originated mon, 17 jun 2024 20 37 23 gmt