{"openapi":"3.0.0","info":{"version":"1.0","title":"Consent & Preferences - Cookie Consent (Swagger)"},"tags":[{"name":"Categorizations"},{"name":"Cookies"},{"name":"Scripts"},{"name":"Websites V2"}],"paths":{"/v1/script-integration/{domainId}/downloadscriptv2":{"get":{"tags":["Scripts"],"summary":"Download Script File","description":"Use this API to download the script files for the specified domain. The files will be downloaded within a folder in blob format.\n\n> 🗒 Things to Know\n> \n> - The domain must be in **Published** status.\n\n> 👍 \n> \n> For more information, see [Downloading and Deploying Scripts from Local Hosting](https://my-onetrust-com.uleth.idm.oclc.org/s/article/UUID-3e2923d6-8364-c2fa-0625-7897395f4cd2?topicId=0TO1Q000000ssJBWAY).","operationId":"downloadToLocalUsingGet","parameters":[{"in":"path","name":"domainId","description":"ID of the domain in OneTrust Admin Portal. This string is obtained from the URL on the specific pages in OneTrust Admin Portal relating to that domain. (Example- The script page or the scan results page for that domain.)","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too Many Requests\nFor more information, see [API Rate Limits](https://developer-onetrust-com.uleth.idm.oclc.org/onetrust/reference/rate-limits-overview).","headers":{"Retry-After":{"description":"The number of seconds after which requests will be allowed again.","schema":{"type":"integer","format":"int32"}},"ot-ratelimit-event-id":{"description":"The unique identifier for the rate-limiting event.","schema":{"type":"string","format":"uuid"}},"ot-requests-allowed":{"description":"The number of requests allowed within the specified period.","schema":{"type":"integer","format":"int32"}},"ot-period":{"description":"The unit of time for which the rate limit applies.","schema":{"type":"string","enum":["HOUR","MINUTE"]}},"ot-request-made":{"description":"The number of requests made within the specified period.","schema":{"type":"integer","format":"int32"}}}}},"security":[{"apikey":[]},{"oauth2":["COOKIE"]}]}},"/v2/websites":{"post":{"tags":["Websites V2"],"summary":"Add Websites to Scan","description":"Use this API to add a website or multiple websites to the scanner.","operationId":"requestBulkAddDomainUsingPOST","parameters":[{"name":"externalOrgId","in":"query","description":"The value defaults to the organization from which the client credentials were generated. Enter a specific sub-org ID if the filter results are desired.","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ScanWebsiteDto"}}}},"description":"List of Domains and their Details"},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ServiceResponseDto"}}}}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too Many Requests\nFor more information, see [API Rate Limits](https://developer-onetrust-com.uleth.idm.oclc.org/onetrust/reference/rate-limits-overview).","headers":{"Retry-After":{"description":"The number of seconds after which requests will be allowed again.","schema":{"type":"integer","format":"int32"}},"ot-ratelimit-event-id":{"description":"The unique identifier for the rate-limiting event.","schema":{"type":"string","format":"uuid"}},"ot-requests-allowed":{"description":"The number of requests allowed within the specified period.","schema":{"type":"integer","format":"int32"}},"ot-period":{"description":"The unit of time for which the rate limit applies.","schema":{"type":"string","enum":["HOUR","MINUTE"]}},"ot-request-made":{"description":"The number of requests made within the specified period.","schema":{"type":"integer","format":"int32"}}}}},"deprecated":false,"security":[{"apikey":[]},{"oauth2":["COOKIE"]}]},"get":{"tags":["Websites V2"],"summary":"Get List of Websites","operationId":"getDomainsScannedBySortUsingGET","parameters":[{"name":"externalOrgId","in":"query","description":"The value defaults to the organization from which the client credentials were generated. Enter a specific sub-org ID if the filter results are desired.","required":false,"schema":{"type":"string"}},{"name":"searchStr","in":"query","description":"Enter a URL to search for a specific domain.","required":false,"schema":{"type":"string"}},{"name":"page","in":"query","required":false,"description":"This value can be used for getting a particular page of the paginated response.","schema":{"type":"integer","format":"int32"}},{"name":"size","in":"query","required":false,"description":"Number of records per page (0....N).","schema":{"type":"integer","format":"int32"}},{"in":"query","name":"sort","description":"The sorting criteria of the result list.","schema":{"type":"string","enum":["ScanStatus,ASC","ScanStatus,DESC","Url,ASC","Url,DESC","PagesScanned,ASC","PagesScanned,DESC","TotalCookieCount,ASC","TotalCookieCount,DESC","ConsentPolicyName,ASC","ConsentPolicyName,DESC","ScheduledNextScanDate,ASC","ScheduledNextScanDate,DESC"],"default":"ScanStatus,ASC"}}],"responses":{"200":{"description":"OK\n\nList of websites retrieved successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedWebsiteResponseDTO"}}}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too Many Requests\nFor more information, see [API Rate Limits](https://developer-onetrust-com.uleth.idm.oclc.org/onetrust/reference/rate-limits-overview).","headers":{"Retry-After":{"description":"The number of seconds after which requests will be allowed again.","schema":{"type":"integer","format":"int32"}},"ot-ratelimit-event-id":{"description":"The unique identifier for the rate-limiting event.","schema":{"type":"string","format":"uuid"}},"ot-requests-allowed":{"description":"The number of requests allowed within the specified period.","schema":{"type":"integer","format":"int32"}},"ot-period":{"description":"The unit of time for which the rate limit applies.","schema":{"type":"string","enum":["HOUR","MINUTE"]}},"ot-request-made":{"description":"The number of requests made within the specified period.","schema":{"type":"integer","format":"int32"}}}}},"deprecated":false,"description":"Use this API to retrieve a list of all websites in the scanner. The response will return websites in **Pending** and **Completed** status along with the corresponding domain ID, external organization ID, and last scanned date.\n> 🗒 Things to Know\n> \n> - It is recommended to use the `page` and `size` parameters if the number of domains is greater than 1,000.","security":[{"apikey":[]},{"oauth2":["COOKIE_READ","COOKIE_FREE"]}]}},"/v2/websites/scripts":{"get":{"tags":["Scripts"],"summary":"Get Script for Website","description":"Use this API to retrieve the script for the specified website.","operationId":"getScriptForWebsiteUsingGET","parameters":[{"name":"website","in":"query","description":"ID of the webiste or URL of the website.","required":true,"schema":{"type":"string"}},{"name":"scriptType","in":"query","description":"Type of the script. It can be test or prod/production. test publishes test script and prod/production - publishes production script. If nothing is provided by the user, both production and test scripts will be published.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"type":"string"}}}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too Many Requests\nFor more information, see [API Rate Limits](https://developer-onetrust-com.uleth.idm.oclc.org/onetrust/reference/rate-limits-overview).","headers":{"Retry-After":{"description":"The number of seconds after which requests will be allowed again.","schema":{"type":"integer","format":"int32"}},"ot-ratelimit-event-id":{"description":"The unique identifier for the rate-limiting event.","schema":{"type":"string","format":"uuid"}},"ot-requests-allowed":{"description":"The number of requests allowed within the specified period.","schema":{"type":"integer","format":"int32"}},"ot-period":{"description":"The unit of time for which the rate limit applies.","schema":{"type":"string","enum":["HOUR","MINUTE"]}},"ot-request-made":{"description":"The number of requests made within the specified period.","schema":{"type":"integer","format":"int32"}}}}},"deprecated":false,"security":[{"apikey":[]},{"oauth2":["COOKIE_READ","COOKIE_FREE"]}]}},"/v2/websites/publish":{"put":{"tags":["Scripts"],"summary":"Publish Script to Website","operationId":"publishToSiteUsingPUT","parameters":[{"name":"website","in":"query","description":"ID of the webiste or URL of the website.","required":true,"schema":{"type":"string"}},{"name":"scriptType","in":"query","description":"Type of the script. It can be test or prod/production. test publishes test script and prod/production - publishes production script. If nothing is provided by the user, both production and test scripts will be published.","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScriptPublishRequestDto"}}},"description":"Publish Request Details","x-examples":{"application/json":{"autoblockEnabled":true,"enableCommonTrackers":false,"languageDetectionEnabled":true,"languageDetectionHtml":true,"languageDetectionVisitor":false,"languages":["English","Spanish"],"publishIndividualLanguages":false,"requireReconsent":false,"suppressBannerEnabled":false,"suppressPCEnabled":false}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublishScriptDto"},"examples":{"response":{"value":{"autoBlocking":false,"consentPolicyName":"EU Georule","publishVersion":"6.8.0","publishedDate":"2002-05-31T14:17:26.598Z","reconsentRequired":false,"responseMsg":"Publish initiated successfully","userName":"123e4567-e89b-12d3-a456-426614174000"}}}}}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too Many Requests\nFor more information, see [API Rate Limits](https://developer-onetrust-com.uleth.idm.oclc.org/onetrust/reference/rate-limits-overview).","headers":{"Retry-After":{"description":"The number of seconds after which requests will be allowed again.","schema":{"type":"integer","format":"int32"}},"ot-ratelimit-event-id":{"description":"The unique identifier for the rate-limiting event.","schema":{"type":"string","format":"uuid"}},"ot-requests-allowed":{"description":"The number of requests allowed within the specified period.","schema":{"type":"integer","format":"int32"}},"ot-period":{"description":"The unit of time for which the rate limit applies.","schema":{"type":"string","enum":["HOUR","MINUTE"]}},"ot-request-made":{"description":"The number of requests made within the specified period.","schema":{"type":"integer","format":"int32"}}}}},"deprecated":false,"security":[{"apikey":[]},{"oauth2":["COOKIE"]}],"description":"Use this API to publish the script configuration options for the specified website.\n\n> 👍 \n> \n> For more information, see [Publishing and Implementing Cookie Consent Scripts](https://my-onetrust-com.uleth.idm.oclc.org/s/article/UUID-7478d3b4-18eb-3ac0-a6fd-fb7ebff9f8dc)."}},"/v1/cookies":{"post":{"responses":{"201":{"description":"Created.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"ID of the cookie."},"name":{"type":"string","description":"Name of the cookie."},"description":{"type":"string","description":"Purpose of the cookie."},"host":{"type":"string","description":"Host of the cookie."},"path":{"type":"string","description":"Path of the cookie."},"source":{"type":"string","description":"The source from which the cookie is created.","example":"MANUAL"},"cookieLifeSpan":{"type":"string","description":"Lifespan of the cookie."},"httpOnly":{"type":"boolean","description":"Flag indicating the cookie is Http only or not."},"secure":{"type":"boolean","default":false,"description":"Flag indicating the cookie is secure or not."},"length":{"type":"integer","description":"Length of the cookie lifespan."},"durationType":{"type":"integer","description":"Unit of time for the cookie lifespan."}}}}}},"400":{"description":"Bad Request.\n\n**Possible reason**: Invalid or missing parameter passed."},"401":{"description":"Unauthorized."},"403":{"description":"Forbidden.\n\n**Possible reasons**:\nYou do not have enough permissions to invoke this endpoint."},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error. \n\n**Possible reason**: Cookie with the same name and host already exists."}},"summary":"Create Cookie","description":"Use this API to create a new cookie.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"cookieName":{"type":"string","description":"Name of the cookie."},"lifespan":{"type":"string","enum":["PERSISTENT","SESSION"],"description":"Lifespan of the cookie."},"host":{"type":"string","description":"Host of the cookie."},"description":{"type":"string","description":"Description of the cookie, It should be 1075 characters or less.","default":"\"\""},"customCategoryName":{"type":"string","description":"Unique identifier of a cookie category (Cookie Category ID).","example":"C0001"},"length":{"type":"integer","description":"Length of the cookie lifespan, enter a number greater than 0 if this is a persistent cookie, otherwise leave as 0.","default":0},"durationType":{"type":"integer","enum":[1,7,30,365],"description":"Unit of time for the cookie lifespan, enter 1 (for days), 7 (for weeks), 30 (for months), or 365 (for years) based on the time unit the cookie lifespan is measured in.","example":"1, 7, 30, 365"},"domainCookieCategoryList":{"type":"array","default":[],"description":"A list of domain level categorizations for the Cookie.","items":{"type":"object","properties":{"domainId":{"type":"string","description":"ID of the domain."},"customCategoryName":{"type":"string","description":"ID of a cookie category (cookie category id)."},"thirdParty":{"type":"boolean","description":"Flag indicating if the cookie is third-party or first-party, use False if the cookie is first-Party."}}}}},"required":["cookieName","lifespan","host","customCategoryName","durationType"]}}},"description":"Configuration for the new cookie","x-examples":{"application/json":{"cookieName":"AnotherTest Cookie","lifespan":"SESSION","host":"test.com","description":"","customCategoryName":"C0001","length":0,"durationType":1,"domainCookieCategoryList":[{"domainId":"1f7d9ea1-3f02-4b0a-b1ba-19b3c8e0b38b","customCategoryName":"C0002","thirdParty":true}]}}},"operationId":"createNewCookie","tags":["Cookies"]},"put":{"responses":{"200":{"description":"Update completed. Response may include error messages indicating what changes were not complete.","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","description":"Status of the API."},"errorMessages":{"type":"array","items":{"type":"string"}}}}}}},"400":{"description":"Bad Request.\n\n**Possible reason**: Invalid cookieid, please check if cookieId passed is correct."},"401":{"description":"Unauthorized."},"403":{"description":"Forbidden.\n\n**Possible reasons**:\nYou do not have enough permissions to invoke this endpoint. "},"404":{"description":"Not Found."},"409":{"description":""},"429":{"description":"Too Many Requests\nFor more information, see [API Rate Limits](https://developer-onetrust-com.uleth.idm.oclc.org/onetrust/reference/rate-limits-overview).","headers":{"Retry-After":{"description":"The number of seconds after which requests will be allowed again.","schema":{"type":"integer","format":"int32"}},"ot-ratelimit-event-id":{"description":"The unique identifier for the rate-limiting event.","schema":{"type":"string","format":"uuid"}},"ot-requests-allowed":{"description":"The number of requests allowed within the specified period.","schema":{"type":"integer","format":"int32"}},"ot-period":{"description":"The unit of time for which the rate limit applies.","schema":{"type":"string","enum":["HOUR","MINUTE"]}},"ot-request-made":{"description":"The number of requests made within the specified period.","schema":{"type":"integer","format":"int32"}}}}},"summary":"Update Cookie","operationId":"updateCookie","tags":["Cookies"],"security":[{"oauth2":["COOKIE"]}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"cookieId":{"type":"string","description":"ID of the cookie. This value is obtained from [Create Cookie](/onetrust/reference/createnewcookie) API."},"cookieName":{"type":"string","description":"Name of the cookie."},"lifespan":{"type":"string","enum":["PERSISTENT","SESSION"],"description":"Lifespan of the cookie."},"host":{"type":"string","description":"Host of the cookie."},"description":{"type":"string","description":"Description of the cookie. or less","default":"\"\""},"thirdPartyDescription":{"type":"string","description":"Short text describing the host’s purpose or description of the cookie. It should be 1075 characters or less.","default":"\"\""},"customCategoryName":{"type":"string","description":"Unique identifier of a cookie category (Cookie Category ID).","example":"C0001"},"length":{"type":"integer","description":"Length of the cookie lifespan, enter a number greater than 0 if this is a persistent cookie, otherwise leave as 0.","default":0},"durationType":{"type":"integer","enum":[1,7,30,365],"description":"Unit of time for the cookie lifespan, enter 1 (for days), 7 (for weeks), 30 (for months), or 365 (for years) based on the time unit the cookie lifespan is measured in.","example":"1, 7, 30, 365"},"domainCookieCategoryList":{"type":"array","default":[],"description":"A list of domain level categorizations for the cookie.","items":{"type":"object","properties":{"domainId":{"type":"string","description":"ID of a domain."},"customCategoryName":{"type":"string","description":"Unique identifier of a cookie category (cookie category ID)."},"thirdParty":{"type":"boolean","description":"Flag indicating if the cookie is third-party or first-party, use false if the cookie is first-party."}}}},"domainToDeleteIds":{"default":[],"description":"A list of domain IDs to be unassigned from cookie.","type":"array","items":{"type":"string"}},"domainCookieSource":{"type":"array","description":"Domain Cookie Source to be added.","items":{"type":"object","properties":{"domainId":{"type":"string","description":"Unique Identifier of a domain."},"domainCookieSourceRequestDtoList":{"type":"array","default":[],"items":{"type":"object","properties":{"ResourceUrl":{"type":"string","example":"testUrl"}}}}}}},"domainCookieSourceToDelete":{"type":"array","description":"Domain Cookie Source to be removed.","items":{"type":"object","properties":{"id":{"type":"string","description":"Unique Identifier of a domain cookie source."}}}},"descriptionTranslations":{"type":"array","description":"Description translations","items":{"type":"object","properties":{"langCode":{"type":"string","description":"Language code.","example":"EN"},"defaultDescription":{"type":"string","description":"Short text describing what is the purpose of the cookie."},"thirdPartyDescription":{"type":"string","description":"Short text describing the host’s purpose or description. of the cookie"}}}}},"required":["cookieId"]}}},"x-examples":{"application/json":{"cookieId":"5dd32a8b-de66-42d1-a4d8-0000b6a10b1a","cookieName":"testing","host":"test_host","description":"this is for testing","customCategoryName":"C0001","lifespan":"1","length":"12","domainToDeleteIds":["25699e98-dc06-4d1f-b7b7-8c528f768eb0"],"domainCookieCategoryList":[{"domainId":"c9e7cd88-1a25-4fff-b18b-000ec335782d","customCategoryName":"12312312312312321"},{"domainId":"3bac22c5-b790-4dc5-9acf-00d7ad485c93"}],"domainCookieSource":[{"domainId":"c9e7cd88-1a25-4fff-b18b-000ec335782d","domainCookieSourceRequestDtoList":[{"ResourceUrl":"testResourceUrl"}]}],"domainCookieSourceToDelete":[{"id":"c9e7cd88-1a25-4fff-b18b-000ec335782d"}],"descriptionTranslations":[{"langCode":"IT"},{"langCode":"ES","defaultDescription":"defaultDescription","thirdPartyDescription":"thirdPartyDescription"}]}}},"description":"Use this API to update an existing cookie.\n> 🗒 Things to Know\n> \n> - There are two types of IDs for cookies: Cookie ID and Domain Cookie ID. The **Cookies Results All Domains** export can be downloaded from the Categorizations screen in the OneTrust application to select the ID for the `cookieId` parameter.\n> - For manually created cookies, only `cookieName`, `lifespan`, an `host` will be updated.\n> - Values must be passed in all the parameters within `descriptionTranslations` for a cookie translation to be updated."}},"/v2/categorize":{"post":{"tags":["Categorizations"],"summary":"Categorize Cookies by Domain","description":"Use this API to categorize cookies by cookie name and host for the specified domain. The response will return details for each cookie such as pattern (First-Party or Third-Party) and category (Functional, Strictly Necessary, Targeting, Social Media, or Performance)","operationId":"getCategorizedCookiesUsingGET","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"domain":{"type":"string","description":"Name of the domain."},"cookies":{"type":"array","default":[],"description":"A list of Cookies with name and host.","items":{"type":"object","properties":{"name":{"type":"string"},"host":{"type":"string"}}}}}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/CookiepediaContribsDto"}}}}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too Many Requests\nFor more information, see [API Rate Limits](https://developer-onetrust-com.uleth.idm.oclc.org/onetrust/reference/rate-limits-overview).","headers":{"Retry-After":{"description":"The number of seconds after which requests will be allowed again.","schema":{"type":"integer","format":"int32"}},"ot-ratelimit-event-id":{"description":"The unique identifier for the rate-limiting event.","schema":{"type":"string","format":"uuid"}},"ot-requests-allowed":{"description":"The number of requests allowed within the specified period.","schema":{"type":"integer","format":"int32"}},"ot-period":{"description":"The unit of time for which the rate limit applies.","schema":{"type":"string","enum":["HOUR","MINUTE"]}},"ot-request-made":{"description":"The number of requests made within the specified period.","schema":{"type":"integer","format":"int32"}}}}}}},"/v2/categorizewithids":{"post":{"tags":["Categorizations"],"summary":"Categorize Cookies by Domain and Cookie ID","description":"Use this API to categorize cookies by domain and cookie ID. The response will return details for each cookie such as the pattern (First-Party or Third-Party) and the category (Functional, Strictly Necessary, Targeting, Social Media, or Performance). ","operationId":"getCategorizedCookiesWithCookieIdsUsingGET","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"domain":{"type":"string","description":"Name of the domain."},"cookiesIds":{"type":"array","default":[],"description":"A list of Cookies IDs.","items":{"type":"string","format":"uuid"}}}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/CookiepediaContribsDto"}}}}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too Many Requests\nFor more information, see [API Rate Limits](https://developer-onetrust-com.uleth.idm.oclc.org/onetrust/reference/rate-limits-overview).","headers":{"Retry-After":{"description":"The number of seconds after which requests will be allowed again.","schema":{"type":"integer","format":"int32"}},"ot-ratelimit-event-id":{"description":"The unique identifier for the rate-limiting event.","schema":{"type":"string","format":"uuid"}},"ot-requests-allowed":{"description":"The number of requests allowed within the specified period.","schema":{"type":"integer","format":"int32"}},"ot-period":{"description":"The unit of time for which the rate limit applies.","schema":{"type":"string","enum":["HOUR","MINUTE"]}},"ot-request-made":{"description":"The number of requests made within the specified period.","schema":{"type":"integer","format":"int32"}}}}}}},"/v1/domains/{domainId}/domaingroup":{"post":{"tags":["Domains"],"summary":"Create or Update Domain Group","description":"Use this API to create a new domain group or update an existing domain group.","operationId":"createDomainGroupUsingPOST","parameters":[{"in":"path","name":"domainId","description":"ID of the domain in OneTrust Admin Portal. This string is obtained from the URL on the specific pages in OneTrust Admin Portal relating to that domain. (Example- The script page or the scan results page for that domain.)","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"removeExisting":{"type":"boolean","description":"Flag to remove all domains from an existing group. Passing False instructs the API to append the incoming URL list to the existing one."},"urls":{"type":"array","default":[],"description":"A list of urls to be added to the group.","items":{"type":"string"}}}}}}},"responses":{"200":{"description":"OK"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too Many Requests\nFor more information, see [API Rate Limits](https://developer-onetrust-com.uleth.idm.oclc.org/onetrust/reference/rate-limits-overview).","headers":{"Retry-After":{"description":"The number of seconds after which requests will be allowed again.","schema":{"type":"integer","format":"int32"}},"ot-ratelimit-event-id":{"description":"The unique identifier for the rate-limiting event.","schema":{"type":"string","format":"uuid"}},"ot-requests-allowed":{"description":"The number of requests allowed within the specified period.","schema":{"type":"integer","format":"int32"}},"ot-period":{"description":"The unit of time for which the rate limit applies.","schema":{"type":"string","enum":["HOUR","MINUTE"]}},"ot-request-made":{"description":"The number of requests made within the specified period.","schema":{"type":"integer","format":"int32"}}}},"500":{"description":"Internal Server Error. \n\n**Possible reason**: Incorrect domain Id or if removeExisting flag is false and a url from the list is already there in the group"}},"security":[{"apikey":[]},{"oauth2":["COOKIE"]}]}},"/v2/cookie-reports/search":{"post":{"tags":["Cookies"],"summary":"Get List of Cookies by Criteria","description":"Use this API to retrieve a list of all cookies by filter criteria.\n> 🗒 Things to Know\n> \n> - If any of the available languages in the OneTrust application is entered as a value for the `language` parameter, cookie categories, descriptions, and third-party descriptions will be translated accordingly. \n> - It is recommended to use the `page` and `size` parameters if the number of cookies is greater than 500.","operationId":"getCookieReportsUsingPOST","parameters":[{"in":"query","name":"language","description":"Name of the language.","example":"en","schema":{"type":"string"}},{"in":"query","name":"countryCode","description":"Country specific code.","example":"gb","schema":{"type":"string"}},{"in":"query","name":"searchStr","description":"Search string includes either cookie name or host name.","schema":{"type":"string"}},{"name":"page","in":"query","required":false,"description":"Page number of the results list (0….N).","schema":{"type":"integer","format":"int32"}},{"name":"size","in":"query","required":false,"description":"Number of records per page (0…N).","schema":{"type":"integer","format":"int32"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"domains":{"type":"array","default":[],"items":{"type":"string"}}}}}},"description":"List of domains separated by commmas."},"responses":{"200":{"description":"OK\n\nCookie details retrieved successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedCookieResponseDTO"}}}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too Many Requests\nFor more information, see [API Rate Limits](https://developer-onetrust-com.uleth.idm.oclc.org/onetrust/reference/rate-limits-overview).","headers":{"Retry-After":{"description":"The number of seconds after which requests will be allowed again.","schema":{"type":"integer","format":"int32"}},"ot-ratelimit-event-id":{"description":"The unique identifier for the rate-limiting event.","schema":{"type":"string","format":"uuid"}},"ot-requests-allowed":{"description":"The number of requests allowed within the specified period.","schema":{"type":"integer","format":"int32"}},"ot-period":{"description":"The unit of time for which the rate limit applies.","schema":{"type":"string","enum":["HOUR","MINUTE"]}},"ot-request-made":{"description":"The number of requests made within the specified period.","schema":{"type":"integer","format":"int32"}}}}}}}},"security":[{"oauth2":[]}],"x-readme":{"explorer-enabled":false,"metrics-enabled":false,"proxy-enabled":true},"x-onetrust":{"spec-label":"Swagger 2","links":{"Cookie Consent Knowledge Base":"https://my-onetrust-com.uleth.idm.oclc.org/s/topic/0TO1Q000000ItRyWAK/cookie-compliance"}},"servers":[{"url":"https://customer-my-onetrust-com.uleth.idm.oclc.org/api/cookiemanager"}],"components":{"securitySchemes":{"oauth2":{"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://{$$.env.host}/api/access/v1/oauth/token","scopes":{"COOKIE":"Cookie Scope gives the user access to read/write operations inside the Cookie Consent module.","COOKIE_READ":"Cookie Read Scope gives the user read-only access to the Cookie Consent module.","COOKIE_FREE":"Cookie free Scope gives free users access to apis having free scope associated to them inside the Cookie Consent module."}}}}},"schemas":{"Cookie":{"type":"object","properties":{"after":{"type":"boolean"},"before":{"type":"boolean"},"change":{"type":"string"},"description":{"type":"string","description":"Description of the cookie."},"etag":{"type":"string"},"expiry":{"type":"integer","format":"int64"},"expiryDate":{"type":"string","description":"The date and time at which the cookie expires.","format":"date-time"},"firstParty":{"type":"boolean"},"host":{"type":"string"},"hostDescription":{"type":"string"},"isBehindLogin":{"type":"boolean"},"isHttpOnly":{"type":"boolean"},"isSecure":{"type":"boolean"},"isSession":{"type":"boolean"},"name":{"type":"string"},"partitionKey":{"type":"string"},"path":{"type":"string"},"purpose":{"type":"string"},"rowKey":{"type":"string"},"timestamp":{"type":"string","format":"date-time"},"urlDomain":{"type":"string"}},"title":"Cookie"},"ScanWebsiteDto":{"title":"ScanWebsiteDto","description":"Website details for scan","type":"object","required":["domain","numberOfPages","independentPaths"],"properties":{"domain":{"type":"string","description":"Domain name of the website to scan.","minLength":1},"numberOfPages":{"type":"integer","description":"Number of pages to scan. Number of pages depend on page limit set for each tenant. If a higher value is provided, then the page limit will have priority.","default":1000},"independentPaths":{"type":"boolean","description":"Whether to scan independent paths.","default":false},"includedQueryParams":{"type":"string","description":"Query parameters to include in the scan."},"siteMapsUris":{"type":"string","description":"URIs for the sitemaps.","maxLength":3000},"geoLocation":{"type":"string","description":"Geographical location for the scan."},"uniqueUserAgent":{"type":"boolean","description":"Indicates if a unique user agent should be used.","default":true},"limitScanToSitemap":{"type":"boolean","description":"Limits the scan to the sitemap.","default":false},"googleLoginState":{"type":"boolean","description":"Indicates if Google login is required.","default":false},"targetPageInputs":{"type":"array","items":{"$ref":"#/components/schemas/TargetPagesScanEntityDto"},"description":"List of target pages to scan."}}},"TargetPagesScanEntityDto":{"title":"TargetPagesScanEntityDto","description":"Target page for scan and details","type":"object","required":["pageListName","targetType","urlType","pageUrls"],"properties":{"pageListName":{"type":"string","description":"Name of the page list.","minLength":1},"targetType":{"type":"string","description":"Type of targeting for the URLs","minLength":1,"enum":["IncludeOnly","Exclude","Target"]},"urlType":{"type":"string","description":"Specify which level of inclusion or exclusion is desired","minLength":1,"enum":["Page","Path","Subdomain"]},"pageUrls":{"type":"string","description":"List of valid URLs, one per line. URLs should start with \"https://\" or \"http://\"","minLength":1}}},"ServiceResponseDto":{"type":"object","properties":{"consentPolicyId":{"type":"string","description":"Consent policy associated with the scan."},"domainId":{"type":"string","format":"uuid","description":"ID of the domain under scan."},"message":{"type":"string","description":"Scan response message."},"notificationTemplateId":{"type":"string","description":"Notification template associated with the scan."},"ok":{"type":"boolean"},"rescan":{"type":"boolean","description":"Flag to indicate if the rescan is required or not."}},"title":"ServiceResponseDto"},"templateLangs":{"type":"object","properties":{"locale":{"type":"string"},"templateId":{"type":"string","format":"UUID"}}},"PaginatedWebsiteResponseDTO":{"type":"object","properties":{"content":{"type":"array","description":"List of domains scanned or pending to be scanned","items":{"$ref":"#/components/schemas/ExposedWebsiteDetailsDto"}},"numberOfElements":{"type":"integer","format":"int32","description":"Total number of elements in the result list."},"pageNumber":{"type":"integer","format":"int32","description":"Page number of the results list (0….N)."},"pageSize":{"type":"integer","format":"int32","description":"Number of records per page (0…N)."},"sort":{"$ref":"#/components/schemas/Sort"},"totalElements":{"type":"integer","format":"int64","description":"Total number of websites found."},"totalPages":{"type":"integer","format":"int32","description":"Total number of pages in the result."}},"title":"PaginatedWebsiteResponseDTO","description":"Paginated websites scanned or pending to be scanned"},"ExposedWebsiteDetailsDto":{"type":"object","properties":{"consentPolicyName":{"type":"string","description":"Name of the assigned consent policy to the website."},"domainName":{"type":"string","description":"Name of the domain."},"domainId":{"type":"string","format":"UUID","description":"ID of the domain."},"externalOrgId":{"type":"string","description":"ID of the external organization for the website scan."},"lastScannedDate":{"type":"string","format":"date-time","description":"The date and time at which the domain was last scanned."},"lastScannedTotalCookies":{"type":"integer","format":"int32","description":"Total cookies found on the last scan."},"lastScannedTotalPages":{"type":"integer","format":"int32","description":"Total pages scanned in the last scan."},"orgName":{"type":"string","description":"Name of the organization."},"overPageLimit":{"type":"boolean","description":"The flag to indicate if it is over the tenant page limit."},"scanError":{"type":"string","description":"Error message if any in the scan."},"scheduledDateOfNextScan":{"type":"string","format":"date-time","description":"The date and time at which the next scan is scheduled."},"status":{"type":"string","description":"Status of the scan."}},"title":"ExposedWebsiteDetailsDto"},"Sort":{"type":"object","properties":{"empty":{"type":"boolean","description":"Flag to indicate if the results are empty or not."},"sorted":{"type":"boolean","description":"Flag to indicate if the results are sorted or not. If set to TRUE, the results are sorted."},"unsorted":{"type":"boolean","description":"Flag to indicate if the results are unsorted or not. If set to TRUE, the results are unsorted."}},"title":"Sort"},"PublishScriptDto":{"type":"object","properties":{"autoBlocking":{"type":"boolean","description":"Auto-blocking leverages an additional script that must be added to the website to block tracking technologies based on the source setting them.","example":false},"consentPolicyName":{"type":"string","description":"The consent policy that is assigned to the website being published.","example":"EU GeoRule"},"publishVersion":{"type":"string","description":"The last published version of the script.","example":"6.8.0"},"publishedDate":{"type":"string","format":"date-time","description":"The date-time when the script was last published.","example":"2002-05-31T14:17:26.598Z"},"reconsentRequired":{"type":"boolean","description":"Indicates whether website visitors will be reprompted with the Consent Management Platform.","example":false},"responseMsg":{"type":"string","description":"Response message indicating whether the publish was initiated successfully or it failed.","example":"Publish initiated successfully"},"userName":{"type":"string","description":"The tenant GUID of the user which initiated the scan.","example":"123e4567-e89b-12d3-a456-426614174000"}},"title":"PublishScriptDto","description":"Gets the details of the published production or test script for the website that is passed."},"ScriptPublishRequestDto":{"type":"object","properties":{"autoblockEnabled":{"type":"boolean","description":"Auto-blocking leverages an additional script that must be added to the website to block tracking technologies based on the source setting them. Setting this flag to ’True’ will indicate this script should be published as well. If not specified, this is assumed ‘False’.","example":false,"default":false},"enableCommonTrackers":{"type":"boolean","description":"By default, this flag is ‘False’. Setting to ’True’ indicates to the auto-blocking script to automatically block known trackers.","example":false,"default":false},"languageDetectionEnabled":{"type":"boolean","description":"Indicates whether to automatically detect the language of the website visitor. By default this is ’True’. If not specified, this will default to the last time it was published.","example":true,"default":true},"languageDetectionHtml":{"type":"boolean","description":"Indicates the script should detect the website visitors langauge based on the webpages language.","example":false,"default":false},"languageDetectionVisitor":{"type":"boolean","description":"Indicates the script should detect the website visitors langauge based on their browser language. By default this is ’True’.","example":true,"default":true},"languages":{"type":"array","items":{"type":"string"},"description":"Only required if ‘publishIndividualLanguages=’True’. Indicates which languages to publish.","example":"English,Spanish","default":null},"publishIndividualLanguages":{"type":"boolean","description":"By default, this flag is ‘False’. Setting to ’True’ indicates you only wish to publish a subset of langauges.","example":false,"default":false},"requireReconsent":{"type":"boolean","description":"Indicates that website visitors should be reprompted with the Consent Management Platform. By default, this is set to ‘False’.","example":false,"default":false},"suppressBannerEnabled":{"type":"boolean","description":"Indicates the banner is manually invoked on the page and should be suppressed upon on initial load. Usually used for SPAs. By default, this flag is ‘False’.","example":false,"default":false},"suppressPCEnabled":{"type":"boolean","description":"Indicates the pref. Center is fetched only upon website visitor interaction with the banner. By default, this flag is ‘False’.","example":false,"default":false}},"title":"ScriptPublishRequestDto","description":"Publishes the production or test script for the website that is passed. All available settings for publishing will by default use the saved values from the last publish if not specified."},"CookiepediaContribsDto":{"type":"object","properties":{"name":{"type":"string","description":"Name of the cookie."},"type":{"type":"string","description":"Type of the cookie."},"host":{"type":"string","description":"Host of the cookie."},"hostDescription":{"type":"string","description":"Description of the cookie host."},"description":{"type":"string","description":"Description of the cookie category."},"firstPartyDescription":{"type":"string","description":"Description of the first party cookie catogory."},"thirdPartyDescription":{"type":"string","description":"Description of the third party cookie catogory."},"patternKey":{"type":"string","description":"Cookie caterory pattern key."},"thirdPartyKey":{"type":"string","description":"Third party key of categorized cookie."},"firstPartyKey":{"type":"string","description":"First party key of categorized cookie."},"category":{"type":"string","description":"Category of the cookie."}},"title":"CookiepediaContribsDto","description":"Gets the cookie category of the cookies passed"},"CookiesDto":{"type":"object","properties":{"cookies":{"type":"array","items":{"$ref":"#/components/schemas/CookieRequestDto"}}},"description":"cookie list","title":"CookiesDto"},"CookieRequestDto":{"type":"object","properties":{"name":{"type":"string","description":"cookie name"},"host":{"type":"string","description":"cookie host"}},"description":"cookie pojo","title":"CookieRequestDto"},"PaginatedCookieResponseDTO":{"type":"object","properties":{"content":{"type":"array","description":"List of cookies with domain level information","items":{"$ref":"#/components/schemas/CookieDetailsDto"}},"numberOfElements":{"type":"integer","format":"int32","description":"Total number of elements in the result list."},"pageNumber":{"type":"integer","format":"int32","description":"Page number of the results list (0….N)."},"pageSize":{"type":"integer","format":"int32","description":"Number of records per page (0…N)."},"sort":{"$ref":"#/components/schemas/Sort"},"totalElements":{"type":"integer","format":"int64","description":"Total number of cookie results found."},"totalPages":{"type":"integer","format":"int32","description":"Total number of pages in the result."}},"title":"PaginatedCookieResponseDTO","description":"Paginated List of cookies with domain level info"},"CookieDetailsDto":{"type":"object","properties":{"cookieName":{"type":"string","description":"Name of a cookie."},"lifespan":{"type":"string","description":"Lifespan of a cookie."},"host":{"type":"string","description":"Host associated with a cookie."},"defaultCategory":{"type":"string","description":"Default category of a cookie."},"cookieSource":{"type":"string","description":"Source of a cookie (SCAN or MANUAL)."},"defaultDescription":{"type":"string","description":"Description of a cookie."},"defaultThirdPartyDescription":{"type":"string","description":"Third party description of a cookie."},"expiry":{"type":"string","description":"Expiry duration of a cookie(For example, 4 weeks or 2 days or 5 months or 3 years)."},"thirdParty":{"type":"boolean","description":"Indicates the type of a cookie. If set to true, then third party cookie else first party cookie."},"domainCookieInfo":{"type":"array","items":{"$ref":"#/components/schemas/DomainCookieInfo"}}},"title":"CookieDetailsDto","description":"Cookie details with domain level info"},"DomainCookieInfo":{"type":"object","properties":{"cookieId":{"type":"string","description":"Id of a cookie."},"domainCookieId":{"type":"string","description":"Id of domaincookie."},"domainName":{"type":"string","description":"Name of the domain."},"displayGroupName":{"type":"string","description":"Category name of cookie for that domain."},"cookieCategoryID":{"type":"string","description":"Category ID of the cookie."},"thirdParty":{"type":"boolean","description":"Indiactes the type of the cookie. If set to true, then third party cookie else first party cookie for that domain."},"description":{"type":"string","description":"Description of a cookie."}},"title":"DomainCookieInfo","description":"Domain level information for a cookie"}}}}