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 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 assessmentid string required id of an assessment 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 output parameter type description status code number http status code of the response reason string response reason phrase approvers array output field approvers approvalstate string output field approvalstate approvedon object output field approvedon id string unique identifier 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 id string unique identifier 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 id string unique identifier name string name of the resource example \[ { "status code" 200, "response headers" { "content type" "application/json", "date" "thu, 01 jan 2024 00 00 00 gmt" }, "reason" "ok", "json body" { "approvers" \[], "assessmentid" "string", "assessmentnumber" 123, "completedon" "string", "createdby" {}, "createddt" "string", "description" "string", "highrisk" 123, "inherentriskscore" 123, "lastupdated" "string", "lowrisk" 123, "mediumrisk" 123, "name" "example name", "openriskcount" 123, "orggroup" {} } } ] 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 assessmentstatuses array optional status of an assessment assessmentarchivalstate string optional parameter to retrieve a list of active/archived or both active and archived assessments page number optional page number of the results list (0…n) size number optional number of records per page (0…n) output parameter type description status code number http status code of the response reason string response reason phrase content array response content assessmentid string unique identifier createdt string output field createdt inherentriskscore number score value lastupdated string output field lastupdated name string name of the resource number number output field number openriskcount number count value orggroupname string name of the resource primaryinventorydetails object output field primaryinventorydetails primaryinventoryid string unique identifier primaryinventoryname string name of the resource primaryinventorynumber number output field primaryinventorynumber residualriskscore number unique identifier result string result of the operation resultid string unique identifier resultname string name of the resource state string output field state status string status value tags array output field tags file name string name of the resource file string output field file targetriskscore object score value 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" {} } } ] 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 assessmentarchivalstate string optional assessment archival state assessmentstatuses array optional assessment statuses templatetypes array optional template types page number optional page number of the results list (0…n) size number optional number of records per page (0…n) 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 field string optional name of the property to be filtered on operation string optional parameter for get list of assessments by criteria tovalue array optional used for deleteddate, deadline filters 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" output parameter type description status code number http status code of the response reason string response reason phrase content array response content approvalstagename string name of the resource approvers array output field approvers assigneetype object type of the resource deleted boolean output field deleted email object output field email fullname string name of the resource id string unique identifier assessmentid string unique identifier assessmentrisklevelname string name of the resource attestationrequired boolean output field attestationrequired badgecolor string output field badgecolor canresendlink boolean output field canresendlink createdt string output field createdt createdby string output field createdby deadline string output field deadline editallresponseswheninprogress boolean output field editallresponseswheninprogress inherentrisklevelname string name of the resource name string name of the resource number number output field number openinforequestcount number count value openriskcount number count value orggroupid string unique identifier 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" {} } } ] 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 inventoryid string required id of the primary record of the assessment inventoryname string required name of the primary record of the assessment 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 required name of the assessment orggroupid string required id of the organization group that should be assigned to the assessment orggroupname string required 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 required list of respondents assigned to the assessment comment string optional comments that will be provided to the respondent(s) in an email notification respondentid string optional id of the user/user group to assign to the assessment as a respondent respondentname string required name of the user/user group to assign as a respondent 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 output parameter type description status code number http status code of the response reason string response reason phrase 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 assessmentid string required unique identifier 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 output parameter type description status code number http status code of the response reason string response reason phrase 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 assessmentid string required id of an assessment approvers array optional the details of the user who is assigned as an approver to the assessment approverid string optional id of the user to assign to the assessment as an approver approvername string optional name of the user to assign to the assessment as a respondent comment string optional comments that will be provided to the approver in an email notification 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 comment string optional comments that will be provided to the respondent(s) in an email notification respondentid string optional id of the user/user group to assign to the assessment as a respondent respondentname string required name of the user/user group to assign as a respondent sectionid string optional id of a section within the assessment output parameter type description status code number http status code of the response reason string response reason phrase 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 assessmentid string required id of an assessment primaryrecordids array required unique id of the primary record primaryrecordtype string required type of record designated as the main purpose of an assessment output parameter type description status code number http status code of the response reason string response reason phrase 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 notes api documentation https //developer onetrust com/onetrust/reference/onetrust api reference link for authentication https //developer onetrust com/onetrust/reference/oauth 20 scopes