{"openapi":"3.1.0","info":{"title":"Consent & Preferences - Cookie Consent","version":"1.0","contact":{"name":"OneTrust Support","url":"https://my.onetrust.com/s/contactsupport"},"license":{"name":"Apache 2.0","url":"https://www.apache.org/licenses/LICENSE-2.0"},"description":"The Cookie Consent APIs are used to integrate external systems and streamline the flow of data with Cookie Consent in the OneTrust Platform."},"servers":[{"url":"https://{hostname}","variables":{"hostname":{"default":"hostname","description":"The OneTrust hostname such as app.onetrust.com, app-eu.onetrust.com, app-de.onetrust.com, app-uk.onetrust.com, app-apac.onetrust.com, trial.onetrust.com, or uat.onetrust.com."}}}],"tags":[{"name":"Applications","description":"The Applications APIs are used to manage application configurations and their associated consent experiences.","externalDocs":{"description":"OpenAPI 3.1.0 - Download Definition","url":"https://developer.onetrust.com/onetrust/openapi/consent-preferences-cookie-consent.json"}},{"name":"Cookies","description":"The Cookies APIs are used to manage cookie definitions, categories, and their properties.","externalDocs":{"description":"OpenAPI 3.1.0 - Download Definition","url":"https://developer.onetrust.com/onetrust/openapi/consent-preferences-cookie-consent.json"}},{"name":"Domains","description":"The Domains APIs are used to manage domain configurations and cookie scanning settings.","externalDocs":{"description":"OpenAPI 3.1.0 - Download Definition","url":"https://developer.onetrust.com/onetrust/openapi/consent-preferences-cookie-consent.json"}},{"name":"Geolocation Rules","description":"The Geolocation Rules APIs are used to manage geographic rules that determine how consent experiences are applied based on user location.","externalDocs":{"description":"OpenAPI 3.1.0 - Download Definition","url":"https://developer.onetrust.com/onetrust/openapi/consent-preferences-cookie-consent.json"}},{"name":"Scans","description":"The Scans APIs are used to manage website cookie scanning operations and results.","externalDocs":{"description":"OpenAPI 3.1.0 - Download Definition","url":"https://developer.onetrust.com/onetrust/openapi/consent-preferences-cookie-consent.json"}},{"name":"Scripts","description":"The Scripts APIs are used to manage publishing of scripts to websites.","externalDocs":{"description":"OpenAPI 3.1.0 - Download Definition","url":"https://developer.onetrust.com/onetrust/openapi/consent-preferences-cookie-consent.json"}},{"name":"Templates","description":"The Templates APIs are used to manage reusable consent templates that define the structure and behavior of consent experiences.","externalDocs":{"description":"OpenAPI 3.1.0 - Download Definition","url":"https://developer.onetrust.com/onetrust/openapi/consent-preferences-cookie-consent.json"}}],"x-onetrust":{"spec-label":"OpenAPI 3.1.0"},"x-readme":{"explorer-enabled":false,"proxy-enabled":false,"metrics-enabled":false},"paths":{"/api/cmp/v1/application":{"post":{"operationId":"createApplication","summary":"Create Application","description":"Use this API to create a new application for scan and SDK publishing.","tags":["Applications"],"x-onetrust":{"spec-label":"https://developer.onetrust.com/onetrust/openapi/consent-preferences-cookie-consent.json"},"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicationRequestPublicDto"}}}},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicationEntityPublicDto"}}}},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"429":{"description":"Too Many Requests. \nFor more information, see [API Rate Limits](https://developer.onetrust.com/onetrust/reference/rate-limits-overview).","headers":{"Retry-After":{"schema":{"description":"The number of seconds after which requests will be allowed again.","format":"int32"}},"ot-period":{"schema":{"description":"The unit of time for which the rate limit applies","enum":["HOUR","MINUTE"]}},"ot-ratelimit-event-id":{"schema":{"description":"The unique identifier for the rate-limiting event.","format":"uuid"}},"ot-request-made":{"schema":{"description":"The number of requests made within the specified period.","format":"int32"}},"ot-requests-allowed":{"schema":{"description":"The number of requests allowed within the specified period.","format":"int32"}}}},"500":{"description":"Internal Server Error"}},"security":[{"OAUTH2":["COOKIE"]}]}},"/api/cmp/v1/application/{id}/scan":{"put":{"operationId":"scanApplication","summary":"Scan Application","description":"Use this API to initiate an application scan with a file upload.","tags":["Applications"],"x-onetrust":{"spec-label":"https://developer.onetrust.com/onetrust/openapi/consent-preferences-cookie-consent.json"},"parameters":[{"name":"id","in":"path","description":"Unique identifier of the application to create the scan for","required":true,"schema":{"type":"string","format":"uuid"},"example":"f2229953-b4b5-4042-8cb9-b78038cc4c46"}],"requestBody":{"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"file":{"description":"File to upload as part of the scan request. Maximum size: 500 MB.","type":"string","maxLength":524288000}},"required":["file"]}}}},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicationScanResponsePublicDto"}}}},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"429":{"description":"Too Many Requests. \nFor more information, see [API Rate Limits](https://developer.onetrust.com/onetrust/reference/rate-limits-overview).","headers":{"Retry-After":{"schema":{"description":"The number of seconds after which requests will be allowed again.","format":"int32"}},"ot-period":{"schema":{"description":"The unit of time for which the rate limit applies","enum":["HOUR","MINUTE"]}},"ot-ratelimit-event-id":{"schema":{"description":"The unique identifier for the rate-limiting event.","format":"uuid"}},"ot-request-made":{"schema":{"description":"The number of requests made within the specified period.","format":"int32"}},"ot-requests-allowed":{"schema":{"description":"The number of requests allowed within the specified period.","format":"int32"}}}},"500":{"description":"Internal Server Error"}},"security":[{"OAUTH2":["COOKIE"]}]}},"/api/cmp/v1/applications":{"get":{"operationId":"getApplications","summary":"Get List of Applications","description":"Use this API to retrieve a paginated list of applications. The search parameter can be used to optionally filter results by name.","tags":["Applications"],"parameters":[{"name":"searchStr","in":"query","description":"Search string to filter applications by name","required":false,"schema":{"type":"string","maxLength":255},"example":"My App"},{"name":"sortBy","in":"query","description":"Field to sort by.","required":false,"schema":{"type":"string","default":"name","enum":["name","os"]},"example":"name"},{"name":"direction","in":"query","description":"Sort direction.","required":false,"schema":{"type":"string","default":"asc","enum":["asc","desc"]},"example":"asc"},{"name":"page","in":"query","description":"Page number (0-based)","required":false,"schema":{"type":"integer","example":1,"default":0,"minimum":0}},{"name":"size","in":"query","description":"Page size","required":false,"schema":{"type":"integer","example":10,"default":10,"maximum":100,"minimum":1}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PageApplicationListPublicDto"}}}},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"429":{"description":"Too Many Requests. \nFor more information, see [API Rate Limits](https://developer.onetrust.com/onetrust/reference/rate-limits-overview).","headers":{"Retry-After":{"schema":{"description":"The number of seconds after which requests will be allowed again.","format":"int32"}},"ot-period":{"schema":{"description":"The unit of time for which the rate limit applies","enum":["HOUR","MINUTE"]}},"ot-ratelimit-event-id":{"schema":{"description":"The unique identifier for the rate-limiting event.","format":"uuid"}},"ot-request-made":{"schema":{"description":"The number of requests made within the specified period.","format":"int32"}},"ot-requests-allowed":{"schema":{"description":"The number of requests allowed within the specified period.","format":"int32"}}}},"500":{"description":"Internal Server Error"}},"security":[{"OAUTH2":["COOKIE_READ"]}]}},"/api/cmp/v1/applications/{id}/branding-attributes":{"get":{"operationId":"getApplicationBrandingAttributeList","summary":"Get Branding Attributes for Application","description":"Use this API to retrieve branding attributes for the specified application.","tags":["Applications"],"x-onetrust":{"spec-label":"https://developer.onetrust.com/onetrust/openapi/consent-preferences-cookie-consent.json"},"parameters":[{"name":"id","in":"path","description":"Resource ID (Application ID)","required":true,"schema":{"type":"string","format":"uuid"},"example":"f2229953-b4b5-4042-8cb9-b78038cc4c46"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicationBrandingAttributesResponseDTO"}}}},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"429":{"description":"Too Many Requests. \nFor more information, see [API Rate Limits](https://developer.onetrust.com/onetrust/reference/rate-limits-overview).","headers":{"Retry-After":{"schema":{"description":"The number of seconds after which requests will be allowed again.","format":"int32"}},"ot-period":{"schema":{"description":"The unit of time for which the rate limit applies","enum":["HOUR","MINUTE"]}},"ot-ratelimit-event-id":{"schema":{"description":"The unique identifier for the rate-limiting event.","format":"uuid"}},"ot-request-made":{"schema":{"description":"The number of requests made within the specified period.","format":"int32"}},"ot-requests-allowed":{"schema":{"description":"The number of requests allowed within the specified period.","format":"int32"}}}},"500":{"description":"Internal Server Error"}},"security":[{"OAUTH2":["COOKIE","COOKIE_READ"]}]},"put":{"operationId":"updateApplicationBrandingAttributesForPublicApi","summary":"Update Branding Attributes for Application","description":"Use this API to update branding attributes for the specified application.","tags":["Applications"],"x-onetrust":{"spec-label":"https://developer.onetrust.com/onetrust/openapi/consent-preferences-cookie-consent.json"},"parameters":[{"name":"id","in":"path","description":"Resource ID (Application ID)","required":true,"schema":{"type":"string","format":"uuid"},"example":"f2229953-b4b5-4042-8cb9-b78038cc4c46"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicationBrandingAttributesRequestDTO"}}}},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/BrandingAttributesUpdateResponseDTO"}}}},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"429":{"description":"Too Many Requests. \nFor more information, see [API Rate Limits](https://developer.onetrust.com/onetrust/reference/rate-limits-overview).","headers":{"Retry-After":{"schema":{"description":"The number of seconds after which requests will be allowed again.","format":"int32"}},"ot-period":{"schema":{"description":"The unit of time for which the rate limit applies","enum":["HOUR","MINUTE"]}},"ot-ratelimit-event-id":{"schema":{"description":"The unique identifier for the rate-limiting event.","format":"uuid"}},"ot-request-made":{"schema":{"description":"The number of requests made within the specified period.","format":"int32"}},"ot-requests-allowed":{"schema":{"description":"The number of requests allowed within the specified period.","format":"int32"}}}},"500":{"description":"Internal Server Error"}},"security":[{"OAUTH2":["COOKIE"]}]}},"/api/cmp/v1/applications/{id}/publish":{"put":{"operationId":"publishAppScript","summary":"Publish Application SDK","description":"Use this API to publish the script configuration options for the specified application.","tags":["Scripts"],"x-onetrust":{"spec-label":"https://developer.onetrust.com/onetrust/openapi/consent-preferences-cookie-consent.json"},"parameters":[{"name":"id","in":"path","description":"UUID of the application to publish for","required":true,"schema":{"type":"string","format":"uuid"},"example":"f2229953-b4b5-4042-8cb9-b78038cc4c46"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublishGeolocationRuleRequestApplicationPublicDto"}}}},"responses":{"200":{"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"429":{"description":"Too Many Requests. \nFor more information, see [API Rate Limits](https://developer.onetrust.com/onetrust/reference/rate-limits-overview).","headers":{"Retry-After":{"schema":{"description":"The number of seconds after which requests will be allowed again.","format":"int32"}},"ot-period":{"schema":{"description":"The unit of time for which the rate limit applies","enum":["HOUR","MINUTE"]}},"ot-ratelimit-event-id":{"schema":{"description":"The unique identifier for the rate-limiting event.","format":"uuid"}},"ot-request-made":{"schema":{"description":"The number of requests made within the specified period.","format":"int32"}},"ot-requests-allowed":{"schema":{"description":"The number of requests allowed within the specified period.","format":"int32"}}}},"500":{"description":"Internal Server Error"}},"security":[{"OAUTH2":["COOKIE","COOKIE_READ"]}]}},"/api/cmp/v1/applications/{id}/scans":{"get":{"operationId":"getScans","summary":"Get List of Application Scans","description":"Use this API to retrieve a paginated list of scans associated with a specific application. The response includes each scan's ID, status, and summary data for detected SDKs and permissions.","tags":["Applications"],"parameters":[{"name":"id","in":"path","description":"Unique identifier of the application to retrieve scans for","required":true,"schema":{"type":"string","format":"uuid"},"example":"f2229953-b4b5-4042-8cb9-b78038cc4c46"},{"name":"sortBy","in":"query","description":"Field to sort by","required":false,"schema":{"type":"string","default":"scanDate","enum":["status","scanDate","engineVersion"]},"example":"scanDate"},{"name":"direction","in":"query","description":"Sort direction","required":false,"schema":{"type":"string","default":"asc","enum":["asc","desc"]},"example":"desc"},{"name":"page","in":"query","description":"Page number","required":false,"schema":{"type":"integer","default":0,"minimum":0},"example":1},{"name":"pageSize","in":"query","description":"Page size","required":false,"schema":{"type":"integer","default":10,"maximum":100,"minimum":1},"example":10}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PageApplicationScanDetailDto"}}}},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"429":{"description":"Too Many Requests. \nFor more information, see [API Rate Limits](https://developer.onetrust.com/onetrust/reference/rate-limits-overview).","headers":{"Retry-After":{"schema":{"description":"The number of seconds after which requests will be allowed again.","format":"int32"}},"ot-period":{"schema":{"description":"The unit of time for which the rate limit applies","enum":["HOUR","MINUTE"]}},"ot-ratelimit-event-id":{"schema":{"description":"The unique identifier for the rate-limiting event.","format":"uuid"}},"ot-request-made":{"schema":{"description":"The number of requests made within the specified period.","format":"int32"}},"ot-requests-allowed":{"schema":{"description":"The number of requests allowed within the specified period.","format":"int32"}}}},"500":{"description":"Internal Server Error"}},"security":[{"OAUTH2":["COOKIE_READ"]}]}},"/api/cmp/v1/applications/{id}/scans/{scanId}":{"get":{"operationId":"getSingleScan","summary":"Get Application Scan","description":"Use this API to retrieve the details of a single scan for a specific application. The response includes the scan's ID, status, date, and summary data for detected SDKs and permissions.","tags":["Applications"],"parameters":[{"name":"id","in":"path","description":"Unique identifier of the application.","required":true,"schema":{"type":"string","format":"uuid"},"example":"f2229953-b4b5-4042-8cb9-b78038cc4c46"},{"name":"scanId","in":"path","description":"Unique identifier the scan.","required":true,"schema":{"type":"string","format":"uuid"},"example":"f2229953-b4b5-4042-8cb9-b78038cc4c46"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicationScanDetailDto"}}}},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"429":{"description":"Too Many Requests. \nFor more information, see [API Rate Limits](https://developer.onetrust.com/onetrust/reference/rate-limits-overview).","headers":{"Retry-After":{"schema":{"description":"The number of seconds after which requests will be allowed again.","format":"int32"}},"ot-period":{"schema":{"description":"The unit of time for which the rate limit applies","enum":["HOUR","MINUTE"]}},"ot-ratelimit-event-id":{"schema":{"description":"The unique identifier for the rate-limiting event.","format":"uuid"}},"ot-request-made":{"schema":{"description":"The number of requests made within the specified period.","format":"int32"}},"ot-requests-allowed":{"schema":{"description":"The number of requests allowed within the specified period.","format":"int32"}}}},"500":{"description":"Internal Server Error"}},"security":[{"OAUTH2":["COOKIE_READ"]}]}},"/api/cmp/v1/applications/{id}/scans/{scanId}/permissions":{"get":{"operationId":"getScanPermissions","summary":"Get List of Scan Permissions","description":"Use this API to retrieve the list of permissions detected during a specific application scan. The response includes each permission's name, category, status, description, and sensitivity.","tags":["Applications"],"parameters":[{"name":"id","in":"path","description":"Unique identifier of the application.","required":true,"schema":{"type":"string","format":"uuid"},"example":"f2229953-b4b5-4042-8cb9-b78038cc4c46"},{"name":"scanId","in":"path","description":"Unique identifier the scan.","required":true,"schema":{"type":"string","format":"uuid"},"example":"f2229953-b4b5-4042-8cb9-b78038cc4c46"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ApplicationScanPermissionPublicDto"}}}}},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"429":{"description":"Too Many Requests. \nFor more information, see [API Rate Limits](https://developer.onetrust.com/onetrust/reference/rate-limits-overview).","headers":{"Retry-After":{"schema":{"description":"The number of seconds after which requests will be allowed again.","format":"int32"}},"ot-period":{"schema":{"description":"The unit of time for which the rate limit applies","enum":["HOUR","MINUTE"]}},"ot-ratelimit-event-id":{"schema":{"description":"The unique identifier for the rate-limiting event.","format":"uuid"}},"ot-request-made":{"schema":{"description":"The number of requests made within the specified period.","format":"int32"}},"ot-requests-allowed":{"schema":{"description":"The number of requests allowed within the specified period.","format":"int32"}}}},"500":{"description":"Internal Server Error"}},"security":[{"OAUTH2":["COOKIE_READ"]}]}},"/api/cmp/v1/applications/{id}/scans/{scanId}/privacy-manifest":{"get":{"operationId":"getAppPrivacyManifest","summary":"Get Scan Privacy Manifest","description":"Use this API to retrieve a summary of the iOS privacy manifest analysis for a specific application scan. The response includes the manifest's edit version, supported versions, total data type count, and counts broken down by alignment status. Each data type entry includes the data type identifier, the number of SDKs associated with it, declared purposes, and any detected mismatches.\\\\n> \\ud83d\\uddd2 Things to Know\\\\n> \\\\n> - This endpoint is specific to iOS applications.","tags":["Applications"],"parameters":[{"name":"id","in":"path","description":"Unique identifier of the application.","required":true,"schema":{"type":"string","format":"uuid"},"example":"f2229953-b4b5-4042-8cb9-b78038cc4c46"},{"name":"scanId","in":"path","description":"Unique identifier of the scan.","required":true,"schema":{"type":"string","format":"uuid"},"example":"f2229953-b4b5-4042-8cb9-b78038cc4c46"},{"name":"version","in":"query","description":"Published version string of the privacy manifest to retrieve.If omitted, the latest version is used.","required":false,"schema":{"type":"string"},"example":1}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AppPrivacyManifestResponsePublicDto"}}}},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"429":{"description":"Too Many Requests. \nFor more information, see [API Rate Limits](https://developer.onetrust.com/onetrust/reference/rate-limits-overview).","headers":{"Retry-After":{"schema":{"description":"The number of seconds after which requests will be allowed again.","format":"int32"}},"ot-period":{"schema":{"description":"The unit of time for which the rate limit applies","enum":["HOUR","MINUTE"]}},"ot-ratelimit-event-id":{"schema":{"description":"The unique identifier for the rate-limiting event.","format":"uuid"}},"ot-request-made":{"schema":{"description":"The number of requests made within the specified period.","format":"int32"}},"ot-requests-allowed":{"schema":{"description":"The number of requests allowed within the specified period.","format":"int32"}}}},"500":{"description":"Internal Server Error"}},"security":[{"OAUTH2":["COOKIE_READ"]}]}},"/api/cmp/v1/applications/{id}/scans/{scanId}/privacy-manifest/{dataType}":{"get":{"operationId":"getAppPrivacyManifestDatatype","summary":"Get Privacy Manifest Data Type","description":"Use this API to retrieve detailed mismatch information for a specific data type within an iOS privacy manifest scan. The response includes a breakdown of mismatches by category, with each mismatch entry identifying the SDK package, SDK name, and the differing app and SDK values.\\\\n> \\ud83d\\uddd2 Things to Know\\\\n> \\\\n> - This endpoint is specific to iOS applications.\\\\n> - The `dataType` path parameter corresponds to a `dataType` returned in the [Get Scan Privacy Manifest API](https://developer.onetrust.com/onetrust/reference/getappprivacymanifest) response (e.g., `USER_ID`, `OTHER_DIAGNOSTIC_DATA`).\\\\n> - Mismatch categories with no detected issues return an empty array rather than being omitted from the response.","tags":["Applications"],"parameters":[{"name":"id","in":"path","description":"Unique identifier of the application.","required":true,"schema":{"type":"string","format":"uuid"},"example":"f2229953-b4b5-4042-8cb9-b78038cc4c46"},{"name":"scanId","in":"path","description":"Unique identifier of the scan.","required":true,"schema":{"type":"string","format":"uuid"},"example":"f2229953-b4b5-4042-8cb9-b78038cc4c46"},{"name":"dataType","in":"path","description":"App Privacy Manifest data type to retrieve. Must be a valid AppPrivacyManifestDataType enum name (case-insensitive).","required":true,"schema":{"type":"string","enum":["NAME","EMAIL","PHONE_NUMBER","PHYSICAL_ADDRESS","OTHER_USER_CONTACT_INFO","HEALTH","FITNESS","PAYMENT_INFO","CREDIT_INFO","OTHER_FINANCIAL_INFO","PRECISE_LOCATION","COARSE_LOCATION","SENSITIVE_INFO","CONTACTS","MESSAGES","PHOTOS_VIDEOS","AUDIO_DATA","GAMEPLAY_CONTENT","CUSTOMER_SUPPORT","OTHER_USER_CONTENT","BROWSING_HISTORY","SEARCH_HISTORY","USER_ID","DEVICE_ID","PURCHASE_HISTORY","PRODUCT_INTERACTION","ADVERTISING_DATA","OTHER_USAGE_DATA","CRASH_DATA","PERFORMANCE_DATA","OTHER_DIAGNOSTIC_DATA","ENVIRONMENT_SCANNING","HANDS","HEAD","OTHER_DATA_TYPES","UNKNOWN"]},"example":"DEVICE_ID"},{"name":"version","in":"query","description":"Published version string of the privacy manifest to retrieve. If omitted, the latest version is used.","required":false,"schema":{"type":"string"},"example":2}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AppPrivacyManifestResponseDatatypePublicDto"}}}},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"429":{"description":"Too Many Requests. \nFor more information, see [API Rate Limits](https://developer.onetrust.com/onetrust/reference/rate-limits-overview).","headers":{"Retry-After":{"schema":{"description":"The number of seconds after which requests will be allowed again.","format":"int32"}},"ot-period":{"schema":{"description":"The unit of time for which the rate limit applies","enum":["HOUR","MINUTE"]}},"ot-ratelimit-event-id":{"schema":{"description":"The unique identifier for the rate-limiting event.","format":"uuid"}},"ot-request-made":{"schema":{"description":"The number of requests made within the specified period.","format":"int32"}},"ot-requests-allowed":{"schema":{"description":"The number of requests allowed within the specified period.","format":"int32"}}}},"500":{"description":"Internal Server Error"}},"security":[{"OAUTH2":["COOKIE_READ"]}]}},"/api/cmp/v1/applications/{id}/scans/{scanId}/sdks":{"get":{"operationId":"getScanSdks","summary":"Get List of Scan SDKs","description":"Use this API to retrieve a paginated list of SDKs detected during a specific application scan. The response includes each SDK's ID, name, vendor, and default category. Results can be filtered and sorted using optional query parameters for name, vendor, default category, and the package ID.\\\\n> \\ud83d\\uddd2 Things to Know\\\\n> \\\\n> - SDKs returned by this endpoint are scan-detected SDKs and are different from Tracking Technology SDKs, which have custom descriptions and categories.","tags":["Applications"],"parameters":[{"name":"id","in":"path","description":"Unique identifier of the application.","required":true,"schema":{"type":"string","format":"uuid"},"example":"f2229953-b4b5-4042-8cb9-b78038cc4c46"},{"name":"scanId","in":"path","description":"Unique identifier the scan.","required":true,"schema":{"type":"string","format":"uuid"},"example":"f2229953-b4b5-4042-8cb9-b78038cc4c46"},{"name":"sortBy","in":"query","description":"Field to sort by","required":false,"schema":{"type":"string","default":"name","enum":["pkgId","name","category","vendor"]},"example":"name"},{"name":"direction","in":"query","description":"Sort direction","required":false,"schema":{"type":"string","default":"asc","enum":["asc","desc"]},"example":"desc"},{"name":"page","in":"query","description":"Page number","required":false,"schema":{"type":"integer","example":1,"default":0,"minimum":0}},{"name":"pageSize","in":"query","description":"Page size","required":false,"schema":{"type":"integer","example":10,"default":10,"maximum":100,"minimum":1}},{"name":"nameSearch","in":"query","description":"Filter SDKs whose name contains this value (case-insensitive)","required":false,"schema":{"type":"string"}},{"name":"vendorSearch","in":"query","description":"Filter SDKs whose vendor contains this value (case-insensitive)","required":false,"schema":{"type":"string"}},{"name":"defaultCategorySearch","in":"query","description":"Filter SDKs whose default category contains this value (case-insensitive)","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PageApplicationScanSdkPublicDto"}}}},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"429":{"description":"Too Many Requests. \nFor more information, see [API Rate Limits](https://developer.onetrust.com/onetrust/reference/rate-limits-overview).","headers":{"Retry-After":{"schema":{"description":"The number of seconds after which requests will be allowed again.","format":"int32"}},"ot-period":{"schema":{"description":"The unit of time for which the rate limit applies","enum":["HOUR","MINUTE"]}},"ot-ratelimit-event-id":{"schema":{"description":"The unique identifier for the rate-limiting event.","format":"uuid"}},"ot-request-made":{"schema":{"description":"The number of requests made within the specified period.","format":"int32"}},"ot-requests-allowed":{"schema":{"description":"The number of requests allowed within the specified period.","format":"int32"}}}},"500":{"description":"Internal Server Error"}},"security":[{"OAUTH2":["COOKIE_READ"]}]}},"/api/cmp/v1/applications/{id}/scans/{scanId}/sdks/{sdk}":{"get":{"operationId":"getScanSdkDetails","summary":"Get Scan SDK","description":"Use this API to retrieve detailed information about a single SDK detected during a specific application scan. The response includes the SDK's package ID, name, vendor, default category, and description.\\\\n> \\ud83d\\uddd2 Things to Know\\\\n> \\\\n> - SDKs returned by this endpoint are scan-detected SDKs and are different from Tracking Technology SDKs, which have custom descriptions and categories.","tags":["Applications"],"parameters":[{"name":"id","in":"path","description":"Unique identifier of the application.","required":true,"schema":{"type":"string","format":"uuid"},"example":"f2229953-b4b5-4042-8cb9-b78038cc4c46"},{"name":"scanId","in":"path","description":"Unique identifier a scan.","required":true,"schema":{"type":"string","format":"uuid"},"example":"f2229953-b4b5-4042-8cb9-b78038cc4c46"},{"name":"sdk","in":"path","description":"Name or Key of the SDK.","required":true,"schema":{"type":"string"},"example":"org.xmlpull.v1.XmlPullParser"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicationScanSdkPublicDto"}}}},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"429":{"description":"Too Many Requests. \nFor more information, see [API Rate Limits](https://developer.onetrust.com/onetrust/reference/rate-limits-overview).","headers":{"Retry-After":{"schema":{"description":"The number of seconds after which requests will be allowed again.","format":"int32"}},"ot-period":{"schema":{"description":"The unit of time for which the rate limit applies","enum":["HOUR","MINUTE"]}},"ot-ratelimit-event-id":{"schema":{"description":"The unique identifier for the rate-limiting event.","format":"uuid"}},"ot-request-made":{"schema":{"description":"The number of requests made within the specified period.","format":"int32"}},"ot-requests-allowed":{"schema":{"description":"The number of requests allowed within the specified period.","format":"int32"}}}},"500":{"description":"Internal Server Error"}},"security":[{"OAUTH2":["COOKIE_READ"]}]}},"/api/cmp/v1/applications/{id}/script-details":{"get":{"operationId":"getAppScriptDetails","summary":"Get Script for Application","description":"Use this API to retrieve script details for the specified application.","tags":["Scripts"],"x-onetrust":{"spec-label":"https://developer.onetrust.com/onetrust/openapi/consent-preferences-cookie-consent.json"},"parameters":[{"name":"id","in":"path","description":"ID of the Application to retrieve a script of","required":true,"schema":{"type":"string","format":"uuid"},"example":"f2229953-b4b5-4042-8cb9-b78038cc4c46"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicationScriptDetailsPublicDto"}}}},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"429":{"description":"Too Many Requests. \nFor more information, see [API Rate Limits](https://developer.onetrust.com/onetrust/reference/rate-limits-overview).","headers":{"Retry-After":{"schema":{"description":"The number of seconds after which requests will be allowed again.","format":"int32"}},"ot-period":{"schema":{"description":"The unit of time for which the rate limit applies","enum":["HOUR","MINUTE"]}},"ot-ratelimit-event-id":{"schema":{"description":"The unique identifier for the rate-limiting event.","format":"uuid"}},"ot-request-made":{"schema":{"description":"The number of requests made within the specified period.","format":"int32"}},"ot-requests-allowed":{"schema":{"description":"The number of requests allowed within the specified period.","format":"int32"}}}},"500":{"description":"Internal Server Error"}},"security":[{"OAUTH2":["COOKIE","COOKIE_READ"]}]}},"/api/cmp/v1/cookies/categorized":{"post":{"operationId":"getCategorizedCookies","summary":"Get Categorized Cookies","description":"Use this API to retrieve categorized cookies by domain.","tags":["Cookies"],"x-onetrust":{"spec-label":"https://developer.onetrust.com/onetrust/openapi/consent-preferences-cookie-consent.json"},"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CategorizedCookiesRequestDto"}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/CookiepediaContribsDto"}}}}},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"429":{"description":"Too Many Requests. \nFor more information, see [API Rate Limits](https://developer.onetrust.com/onetrust/reference/rate-limits-overview).","headers":{"Retry-After":{"schema":{"description":"The number of seconds after which requests will be allowed again.","format":"int32"}},"ot-period":{"schema":{"description":"The unit of time for which the rate limit applies","enum":["HOUR","MINUTE"]}},"ot-ratelimit-event-id":{"schema":{"description":"The unique identifier for the rate-limiting event.","format":"uuid"}},"ot-request-made":{"schema":{"description":"The number of requests made within the specified period.","format":"int32"}},"ot-requests-allowed":{"schema":{"description":"The number of requests allowed within the specified period.","format":"int32"}}}},"500":{"description":"Internal Server Error"}},"security":[{"OAUTH2":["COOKIE","COOKIE_READ"]}]}},"/api/cmp/v1/domains/publish":{"put":{"operationId":"publishScriptToSite","summary":"Publish Script to Website","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/s/article/UUID-7478d3b4-18eb-3ac0-a6fd-fb7ebff9f8dc).","tags":["Scripts"],"x-onetrust":{"spec-label":"https://developer.onetrust.com/onetrust/openapi/consent-preferences-cookie-consent.json"},"parameters":[{"name":"scriptType","in":"query","description":"The type of script either production or test.","required":false,"schema":{"type":"string","enum":["production","test"]},"example":"production"},{"name":"website","in":"query","description":"The website domain to target for the operation.","required":true,"schema":{"type":"string","maxLength":1024},"example":"f2229953-b4b5-4042-8cb9-b78038cc4c46"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScriptPublishRequestDto"}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublishScriptDto"}}}},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"429":{"description":"Too Many Requests. \nFor more information, see [API Rate Limits](https://developer.onetrust.com/onetrust/reference/rate-limits-overview).","headers":{"Retry-After":{"schema":{"description":"The number of seconds after which requests will be allowed again.","format":"int32"}},"ot-period":{"schema":{"description":"The unit of time for which the rate limit applies","enum":["HOUR","MINUTE"]}},"ot-ratelimit-event-id":{"schema":{"description":"The unique identifier for the rate-limiting event.","format":"uuid"}},"ot-request-made":{"schema":{"description":"The number of requests made within the specified period.","format":"int32"}},"ot-requests-allowed":{"schema":{"description":"The number of requests allowed within the specified period.","format":"int32"}}}},"500":{"description":"Internal Server Error"}},"security":[{"OAUTH2":["COOKIE","COOKIE_READ"]}]}},"/api/cmp/v1/domains/scripts":{"get":{"operationId":"getScriptForWebsite","summary":"Get Script for Website","description":"Use this API to retrieve the script for the specified website.","tags":["Scripts"],"x-onetrust":{"spec-label":"https://developer.onetrust.com/onetrust/openapi/consent-preferences-cookie-consent.json"},"parameters":[{"name":"scriptType","in":"query","description":"The type of script either production or test.","required":false,"schema":{"type":"string","enum":["production","test"]},"example":"production"},{"name":"website","in":"query","description":"The website domain to target for the operation.","required":true,"schema":{"type":"string","maxLength":1024},"example":"f2229953-b4b5-4042-8cb9-b78038cc4c46"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"string"}}}},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"429":{"description":"Too Many Requests. \nFor more information, see [API Rate Limits](https://developer.onetrust.com/onetrust/reference/rate-limits-overview).","headers":{"Retry-After":{"schema":{"description":"The number of seconds after which requests will be allowed again.","format":"int32"}},"ot-period":{"schema":{"description":"The unit of time for which the rate limit applies","enum":["HOUR","MINUTE"]}},"ot-ratelimit-event-id":{"schema":{"description":"The unique identifier for the rate-limiting event.","format":"uuid"}},"ot-request-made":{"schema":{"description":"The number of requests made within the specified period.","format":"int32"}},"ot-requests-allowed":{"schema":{"description":"The number of requests allowed within the specified period.","format":"int32"}}}},"500":{"description":"Internal Server Error"}},"security":[{"OAUTH2":["COOKIE","COOKIE_READ"]}]}},"/api/cmp/v1/domains/{domainId}":{"delete":{"operationId":"deleteDomain","summary":"Delete Domain","description":"Use this API to delete the specified domain.","tags":["Domains"],"x-onetrust":{"spec-label":"https://developer.onetrust.com/onetrust/openapi/consent-preferences-cookie-consent.json"},"parameters":[{"name":"domainId","in":"path","description":"The unique identifier of the domain.","required":true,"schema":{"type":"string","format":"uuid"},"example":"f2229953-b4b5-4042-8cb9-b78038cc4c46"}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"429":{"description":"Too Many Requests. \nFor more information, see [API Rate Limits](https://developer.onetrust.com/onetrust/reference/rate-limits-overview).","headers":{"Retry-After":{"schema":{"description":"The number of seconds after which requests will be allowed again.","format":"int32"}},"ot-period":{"schema":{"description":"The unit of time for which the rate limit applies","enum":["HOUR","MINUTE"]}},"ot-ratelimit-event-id":{"schema":{"description":"The unique identifier for the rate-limiting event.","format":"uuid"}},"ot-request-made":{"schema":{"description":"The number of requests made within the specified period.","format":"int32"}},"ot-requests-allowed":{"schema":{"description":"The number of requests allowed within the specified period.","format":"int32"}}}},"500":{"description":"Internal Server Error"}},"security":[{"OAUTH2":["COOKIE"]}]}},"/api/cmp/v1/domains/{domainId}/domaingroup":{"post":{"operationId":"createDomainGroup","summary":"Create or Update Domain Group","description":"Use this API to create a new domain group or update an existing domain group.","tags":["Domains"],"x-onetrust":{"spec-label":"https://developer.onetrust.com/onetrust/openapi/consent-preferences-cookie-consent.json"},"parameters":[{"name":"domainId","in":"path","description":"The unique identifier of the domain.","required":true,"schema":{"type":"string","format":"uuid"},"example":"f2229953-b4b5-4042-8cb9-b78038cc4c46"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DomainGroupRequestDto"}}}},"responses":{"201":{"description":"Created"},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"429":{"description":"Too Many Requests. \nFor more information, see [API Rate Limits](https://developer.onetrust.com/onetrust/reference/rate-limits-overview).","headers":{"Retry-After":{"schema":{"description":"The number of seconds after which requests will be allowed again.","format":"int32"}},"ot-period":{"schema":{"description":"The unit of time for which the rate limit applies","enum":["HOUR","MINUTE"]}},"ot-ratelimit-event-id":{"schema":{"description":"The unique identifier for the rate-limiting event.","format":"uuid"}},"ot-request-made":{"schema":{"description":"The number of requests made within the specified period.","format":"int32"}},"ot-requests-allowed":{"schema":{"description":"The number of requests allowed within the specified period.","format":"int32"}}}},"500":{"description":"Internal Server Error"}},"security":[{"OAUTH2":["COOKIE"]}]}},"/api/cmp/v1/domains/{domainId}/script-details":{"get":{"operationId":"getScriptDetails","summary":"Get Script for Domain","description":"Use this API to retrieve script details for the specified website.","tags":["Scripts"],"x-onetrust":{"spec-label":"https://developer.onetrust.com/onetrust/openapi/consent-preferences-cookie-consent.json"},"parameters":[{"name":"domainId","in":"path","description":"Identifier of the domain to retrieve the latest script for.","required":true,"schema":{"type":"string","format":"uuid"},"example":"f2229953-b4b5-4042-8cb9-b78038cc4c46"},{"name":"scriptType","in":"query","description":"The type of script either production or test.","required":false,"schema":{"type":"string","enum":["production","test"]},"example":"production"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DomainScriptDetailsPublicDto"}}}},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"429":{"description":"Too Many Requests. \nFor more information, see [API Rate Limits](https://developer.onetrust.com/onetrust/reference/rate-limits-overview).","headers":{"Retry-After":{"schema":{"description":"The number of seconds after which requests will be allowed again.","format":"int32"}},"ot-period":{"schema":{"description":"The unit of time for which the rate limit applies","enum":["HOUR","MINUTE"]}},"ot-ratelimit-event-id":{"schema":{"description":"The unique identifier for the rate-limiting event.","format":"uuid"}},"ot-request-made":{"schema":{"description":"The number of requests made within the specified period.","format":"int32"}},"ot-requests-allowed":{"schema":{"description":"The number of requests allowed within the specified period.","format":"int32"}}}},"500":{"description":"Internal Server Error"}},"security":[{"OAUTH2":["COOKIE","COOKIE_READ"]}]}},"/api/cmp/v1/domains/{domainId}/scripts":{"get":{"operationId":"downloadScriptFile","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/s/article/UUID-3e2923d6-8364-c2fa-0625-7897395f4cd2).","tags":["Scripts"],"x-onetrust":{"spec-label":"https://developer.onetrust.com/onetrust/openapi/consent-preferences-cookie-consent.json"},"parameters":[{"name":"domainId","in":"path","description":"The unique identifier of the domain.","required":true,"schema":{"type":"string","format":"uuid"},"example":"f2229953-b4b5-4042-8cb9-b78038cc4c46"}],"responses":{"200":{"description":"OK","content":{"application/zip":{"schema":{"type":"string","format":"binary"}}}},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"429":{"description":"Too Many Requests. \nFor more information, see [API Rate Limits](https://developer.onetrust.com/onetrust/reference/rate-limits-overview).","headers":{"Retry-After":{"schema":{"description":"The number of seconds after which requests will be allowed again.","format":"int32"}},"ot-period":{"schema":{"description":"The unit of time for which the rate limit applies","enum":["HOUR","MINUTE"]}},"ot-ratelimit-event-id":{"schema":{"description":"The unique identifier for the rate-limiting event.","format":"uuid"}},"ot-request-made":{"schema":{"description":"The number of requests made within the specified period.","format":"int32"}},"ot-requests-allowed":{"schema":{"description":"The number of requests allowed within the specified period.","format":"int32"}}}},"500":{"description":"Internal Server Error"}},"security":[{"OAUTH2":["COOKIE","COOKIE_READ"]}]}},"/api/cmp/v1/domains/{id}/branding-attributes":{"get":{"operationId":"getBrandingAttributeList","summary":"Get Branding Attributes for Domain","description":"Use this API to retrieve branding attributes for the specified domain.","tags":["Domains"],"x-onetrust":{"spec-label":"https://developer.onetrust.com/onetrust/openapi/consent-preferences-cookie-consent.json"},"parameters":[{"name":"id","in":"path","description":"Resource ID (Domain ID)","required":true,"schema":{"type":"string","format":"uuid"},"example":"f2229953-b4b5-4042-8cb9-b78038cc4c46"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DomainBrandingAttributesResponseDTO"}}}},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"429":{"description":"Too Many Requests. \nFor more information, see [API Rate Limits](https://developer.onetrust.com/onetrust/reference/rate-limits-overview).","headers":{"Retry-After":{"schema":{"description":"The number of seconds after which requests will be allowed again.","format":"int32"}},"ot-period":{"schema":{"description":"The unit of time for which the rate limit applies","enum":["HOUR","MINUTE"]}},"ot-ratelimit-event-id":{"schema":{"description":"The unique identifier for the rate-limiting event.","format":"uuid"}},"ot-request-made":{"schema":{"description":"The number of requests made within the specified period.","format":"int32"}},"ot-requests-allowed":{"schema":{"description":"The number of requests allowed within the specified period.","format":"int32"}}}},"500":{"description":"Internal Server Error"}},"security":[{"OAUTH2":["COOKIE","COOKIE_READ"]}]},"put":{"operationId":"updateBrandingAttributesForPublicApi","summary":"Update Branding Attributes for Domain","description":"Use this API to update branding attributes for the specified domain.","tags":["Domains"],"x-onetrust":{"spec-label":"https://developer.onetrust.com/onetrust/openapi/consent-preferences-cookie-consent.json"},"parameters":[{"name":"id","in":"path","description":"Resource ID (Domain ID)","required":true,"schema":{"type":"string","format":"uuid"},"example":"f2229953-b4b5-4042-8cb9-b78038cc4c46"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DomainBrandingAttributesRequestDTO"}}}},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/BrandingAttributesUpdateResponseDTO"}}}},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"429":{"description":"Too Many Requests. \nFor more information, see [API Rate Limits](https://developer.onetrust.com/onetrust/reference/rate-limits-overview).","headers":{"Retry-After":{"schema":{"description":"The number of seconds after which requests will be allowed again.","format":"int32"}},"ot-period":{"schema":{"description":"The unit of time for which the rate limit applies","enum":["HOUR","MINUTE"]}},"ot-ratelimit-event-id":{"schema":{"description":"The unique identifier for the rate-limiting event.","format":"uuid"}},"ot-request-made":{"schema":{"description":"The number of requests made within the specified period.","format":"int32"}},"ot-requests-allowed":{"schema":{"description":"The number of requests allowed within the specified period.","format":"int32"}}}},"500":{"description":"Internal Server Error"}},"security":[{"OAUTH2":["COOKIE"]}]}},"/api/cmp/v1/georulegroups":{"get":{"operationId":"getGeoRuleGroups","summary":"Get List of Geolocation Rule Groups","description":"Use this API to retrieve a paginated list of geolocation rule groups. The `search` parameter can be used to optionally filter results by name.","tags":["Geolocation Rules"],"x-onetrust":{"spec-label":"https://developer.onetrust.com/onetrust/openapi/consent-preferences-cookie-consent.json"},"parameters":[{"name":"searchStr","in":"query","description":"Search string to filter geo rule groups by name","required":false,"schema":{"type":"string","maxLength":255},"example":"Default Geo Rule Group"},{"name":"sortBy","in":"query","description":"Field to sort by.","required":false,"schema":{"type":"string","default":"geoRuleGroupName","enum":["geoRuleGroupName","status","version"]},"example":"geoRuleGroupName"},{"name":"direction","in":"query","description":"Sort direction.","required":false,"schema":{"type":"string","default":"asc","enum":["asc","desc"]},"example":"asc"},{"name":"page","in":"query","description":"The page number for pagination results, starting from 0.","required":false,"schema":{"type":"integer","example":1,"default":0,"minimum":0}},{"name":"size","in":"query","description":"The number of items to return per page.","required":false,"schema":{"type":"integer","example":10,"default":10,"maximum":100,"minimum":1}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PageGeoRuleGroupDto"}}}},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"429":{"description":"Too Many Requests. \nFor more information, see [API Rate Limits](https://developer.onetrust.com/onetrust/reference/rate-limits-overview).","headers":{"Retry-After":{"schema":{"description":"The number of seconds after which requests will be allowed again.","format":"int32"}},"ot-period":{"schema":{"description":"The unit of time for which the rate limit applies","enum":["HOUR","MINUTE"]}},"ot-ratelimit-event-id":{"schema":{"description":"The unique identifier for the rate-limiting event.","format":"uuid"}},"ot-request-made":{"schema":{"description":"The number of requests made within the specified period.","format":"int32"}},"ot-requests-allowed":{"schema":{"description":"The number of requests allowed within the specified period.","format":"int32"}}}},"500":{"description":"Internal Server Error"}},"security":[{"OAUTH2":["COOKIE_READ"]}]}},"/api/cmp/v1/georulegroups/{geoRuleGroupId}":{"get":{"operationId":"getGeoRuleGroupDetails","summary":"Get Geolocation Rule Group","description":"Use this API to retrieve detailed information for all geolocation rules within a specified geolocation rule group, including regions, consent model, cookie categories, and other attributes.","tags":["Geolocation Rules"],"x-onetrust":{"spec-label":"https://developer.onetrust.com/onetrust/openapi/consent-preferences-cookie-consent.json"},"parameters":[{"name":"geoRuleGroupId","in":"path","description":"Unique identifier of the geo rule group","required":true,"schema":{"type":"string","format":"uuid"},"example":"f2229953-b4b5-4042-8cb9-b78038cc4c46"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GeoRuleGroupDetailDto"}}}},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"429":{"description":"Too Many Requests. \nFor more information, see [API Rate Limits](https://developer.onetrust.com/onetrust/reference/rate-limits-overview).","headers":{"Retry-After":{"schema":{"description":"The number of seconds after which requests will be allowed again.","format":"int32"}},"ot-period":{"schema":{"description":"The unit of time for which the rate limit applies","enum":["HOUR","MINUTE"]}},"ot-ratelimit-event-id":{"schema":{"description":"The unique identifier for the rate-limiting event.","format":"uuid"}},"ot-request-made":{"schema":{"description":"The number of requests made within the specified period.","format":"int32"}},"ot-requests-allowed":{"schema":{"description":"The number of requests allowed within the specified period.","format":"int32"}}}},"500":{"description":"Internal Server Error"}},"security":[{"OAUTH2":["COOKIE_READ"]}]}},"/api/cmp/v1/georulegroups/{geoRuleGroupId}/assign":{"put":{"operationId":"assignEntitiesToGeoRuleGroup","summary":"Assign Geolocation Rule Group","description":"Use this API to assign or unassign multiple domains and/or applications to a specified geolocation rule group. For each domain or application, set the value to `true` to assign or `false` to unassign.","tags":["Geolocation Rules"],"x-onetrust":{"spec-label":"https://developer.onetrust.com/onetrust/openapi/consent-preferences-cookie-consent.json"},"parameters":[{"name":"geoRuleGroupId","in":"path","description":"Unique identifier of the geo rule group","required":true,"schema":{"type":"string","format":"uuid"},"example":"f2229953-b4b5-4042-8cb9-b78038cc4c46"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GeoRuleGroupAssignRequestDto"}}}},"responses":{"200":{"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"429":{"description":"Too Many Requests. \nFor more information, see [API Rate Limits](https://developer.onetrust.com/onetrust/reference/rate-limits-overview).","headers":{"Retry-After":{"schema":{"description":"The number of seconds after which requests will be allowed again.","format":"int32"}},"ot-period":{"schema":{"description":"The unit of time for which the rate limit applies","enum":["HOUR","MINUTE"]}},"ot-ratelimit-event-id":{"schema":{"description":"The unique identifier for the rate-limiting event.","format":"uuid"}},"ot-request-made":{"schema":{"description":"The number of requests made within the specified period.","format":"int32"}},"ot-requests-allowed":{"schema":{"description":"The number of requests allowed within the specified period.","format":"int32"}}}},"500":{"description":"Internal Server Error"}},"security":[{"OAUTH2":["COOKIE"]}]}},"/api/cmp/v1/templates":{"get":{"operationId":"getTemplates","summary":"Get List of Templates","description":"Use this API to retrieve a paginated list of templates with their details, including template name, type, current version, and status.","tags":["Templates"],"x-onetrust":{"spec-label":"https://developer.onetrust.com/onetrust/openapi/consent-preferences-cookie-consent.json"},"parameters":[{"name":"searchStr","in":"query","description":"Search string to filter templates by name","required":false,"schema":{"type":"string","maxLength":255},"example":"my-template"},{"name":"sortBy","in":"query","description":"Field to sort by.","required":false,"schema":{"type":"string","default":"templateName","enum":["templateName","templateType","status","currentVersion"]},"example":"templateName"},{"name":"direction","in":"query","description":"Sort direction.","required":false,"schema":{"type":"string","default":"asc","enum":["asc","desc"]},"example":"asc"},{"name":"page","in":"query","description":"The page number for pagination results, starting from 0.","required":false,"schema":{"type":"integer","example":1,"default":0,"minimum":0}},{"name":"size","in":"query","description":"The number of items to return per page.","required":false,"schema":{"type":"integer","example":10,"default":10,"maximum":100,"minimum":1}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PageTemplateDto"}}}},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"429":{"description":"Too Many Requests. \nFor more information, see [API Rate Limits](https://developer.onetrust.com/onetrust/reference/rate-limits-overview).","headers":{"Retry-After":{"schema":{"description":"The number of seconds after which requests will be allowed again.","format":"int32"}},"ot-period":{"schema":{"description":"The unit of time for which the rate limit applies","enum":["HOUR","MINUTE"]}},"ot-ratelimit-event-id":{"schema":{"description":"The unique identifier for the rate-limiting event.","format":"uuid"}},"ot-request-made":{"schema":{"description":"The number of requests made within the specified period.","format":"int32"}},"ot-requests-allowed":{"schema":{"description":"The number of requests allowed within the specified period.","format":"int32"}}}},"500":{"description":"Internal Server Error"}},"security":[{"OAUTH2":["COOKIE_READ"]}]}},"/api/cmp/v1/templates/{templateId}":{"get":{"operationId":"getTemplateDetails","summary":"Get Template Details","description":"Use this API to retrieve detailed information of a template, including banner setup, preference center setup and the cookie list.","tags":["Templates"],"x-onetrust":{"spec-label":"https://developer.onetrust.com/onetrust/openapi/consent-preferences-cookie-consent.json"},"parameters":[{"name":"templateId","in":"path","description":"Unique identifier of the template","required":true,"schema":{"type":"string","format":"uuid"},"example":"f2229953-b4b5-4042-8cb9-b78038cc4c46"},{"name":"language","in":"query","description":"Optional language-country code to retrieve localized template content","required":false,"schema":{"type":"string","maxLength":5,"minLength":2},"example":"en-US"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TemplateDetailDto"}}}},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"429":{"description":"Too Many Requests. \nFor more information, see [API Rate Limits](https://developer.onetrust.com/onetrust/reference/rate-limits-overview).","headers":{"Retry-After":{"schema":{"description":"The number of seconds after which requests will be allowed again.","format":"int32"}},"ot-period":{"schema":{"description":"The unit of time for which the rate limit applies","enum":["HOUR","MINUTE"]}},"ot-ratelimit-event-id":{"schema":{"description":"The unique identifier for the rate-limiting event.","format":"uuid"}},"ot-request-made":{"schema":{"description":"The number of requests made within the specified period.","format":"int32"}},"ot-requests-allowed":{"schema":{"description":"The number of requests allowed within the specified period.","format":"int32"}}}},"500":{"description":"Internal Server Error"}},"security":[{"OAUTH2":["COOKIE_READ"]}]}},"/api/cmp/v1/webscans":{"get":{"operationId":"getDomainsScannedBySort","summary":"Get List of Websites","description":"Use this API to retrieve a list of websites in the scanner. The response will return websites in Pending and Completed status for the organization and related child organizations.","tags":["Scans"],"x-onetrust":{"spec-label":"https://developer.onetrust.com/onetrust/openapi/consent-preferences-cookie-consent.json"},"parameters":[{"name":"searchStr","in":"query","description":"The search term used to filter results.","required":false,"schema":{"type":"string","maxLength":255},"example":"domain.com"},{"name":"externalOrgId","in":"query","description":"The external organization identifier.","required":false,"schema":{"type":"string","maxLength":100},"example":"orgnameid"},{"name":"page","in":"query","description":"The page number for pagination results, starting from 0.","required":false,"schema":{"type":"integer","example":1,"default":0,"minimum":0}},{"name":"size","in":"query","description":"The number of items to return per page.","required":false,"schema":{"type":"integer","example":10,"default":10,"maximum":100,"minimum":1}},{"name":"sortBy","in":"query","description":"The field by which to sort the results.","required":false,"schema":{"type":"string","enum":["Url","PagesScanned","TotalCookieCount","LastScannedDate","ConsentPolicyName","ScheduledNextScanDate","MaxPagesScanned"]},"example":"Url"},{"name":"direction","in":"query","description":"The sort order for results, either ascending or descending.","required":false,"schema":{"type":"string","enum":["ASC","DESC"]},"example":"DESC"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExposedScanWebsitePageResponseDto"}}}},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"429":{"description":"Too Many Requests. \nFor more information, see [API Rate Limits](https://developer.onetrust.com/onetrust/reference/rate-limits-overview).","headers":{"Retry-After":{"schema":{"description":"The number of seconds after which requests will be allowed again.","format":"int32"}},"ot-period":{"schema":{"description":"The unit of time for which the rate limit applies","enum":["HOUR","MINUTE"]}},"ot-ratelimit-event-id":{"schema":{"description":"The unique identifier for the rate-limiting event.","format":"uuid"}},"ot-request-made":{"schema":{"description":"The number of requests made within the specified period.","format":"int32"}},"ot-requests-allowed":{"schema":{"description":"The number of requests allowed within the specified period.","format":"int32"}}}},"500":{"description":"Internal Server Error"}},"security":[{"OAUTH2":["COOKIE","COOKIE_READ"]}]},"post":{"operationId":"addScans","summary":"Scan Websites","description":"Use this API to start scans for the specified domains.","tags":["Scans"],"x-onetrust":{"spec-label":"https://developer.onetrust.com/onetrust/openapi/consent-preferences-cookie-consent.json"},"parameters":[{"name":"externalOrgId","in":"query","description":"The external organization identifier.","required":false,"schema":{"type":"string","maxLength":100},"example":"orgnameid"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ScanWebsiteRequest"},"uniqueItems":true}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ServiceResponseDto"}}}}},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"429":{"description":"Too Many Requests. \nFor more information, see [API Rate Limits](https://developer.onetrust.com/onetrust/reference/rate-limits-overview).","headers":{"Retry-After":{"schema":{"description":"The number of seconds after which requests will be allowed again.","format":"int32"}},"ot-period":{"schema":{"description":"The unit of time for which the rate limit applies","enum":["HOUR","MINUTE"]}},"ot-ratelimit-event-id":{"schema":{"description":"The unique identifier for the rate-limiting event.","format":"uuid"}},"ot-request-made":{"schema":{"description":"The number of requests made within the specified period.","format":"int32"}},"ot-requests-allowed":{"schema":{"description":"The number of requests allowed within the specified period.","format":"int32"}}}},"500":{"description":"Internal Server Error"}},"security":[{"OAUTH2":["COOKIE"]}]}},"/api/cmp/v1/webscans/archive":{"post":{"operationId":"archiveScans","summary":"Archive Scans","description":"Use this API to archive the specified scans.","tags":["Scans"],"x-onetrust":{"spec-label":"https://developer.onetrust.com/onetrust/openapi/consent-preferences-cookie-consent.json"},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"string","format":"uuid"}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/EntityActionResponseDto"}}}}},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"429":{"description":"Too Many Requests. \nFor more information, see [API Rate Limits](https://developer.onetrust.com/onetrust/reference/rate-limits-overview).","headers":{"Retry-After":{"schema":{"description":"The number of seconds after which requests will be allowed again.","format":"int32"}},"ot-period":{"schema":{"description":"The unit of time for which the rate limit applies","enum":["HOUR","MINUTE"]}},"ot-ratelimit-event-id":{"schema":{"description":"The unique identifier for the rate-limiting event.","format":"uuid"}},"ot-request-made":{"schema":{"description":"The number of requests made within the specified period.","format":"int32"}},"ot-requests-allowed":{"schema":{"description":"The number of requests allowed within the specified period.","format":"int32"}}}},"500":{"description":"Internal Server Error"}},"security":[{"OAUTH2":["COOKIE"]}]}},"/api/cmp/v1/webscans/cookies":{"put":{"operationId":"bulkEditCookies","summary":"Edit Cookies","description":"Use this API to edit existing cookies.","tags":["Cookies"],"x-onetrust":{"spec-label":"https://developer.onetrust.com/onetrust/openapi/consent-preferences-cookie-consent.json"},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/CookieUpdateRequestDto"},"uniqueItems":true}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/EntityActionResponseDto"}}}}},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"429":{"description":"Too Many Requests. \nFor more information, see [API Rate Limits](https://developer.onetrust.com/onetrust/reference/rate-limits-overview).","headers":{"Retry-After":{"schema":{"description":"The number of seconds after which requests will be allowed again.","format":"int32"}},"ot-period":{"schema":{"description":"The unit of time for which the rate limit applies","enum":["HOUR","MINUTE"]}},"ot-ratelimit-event-id":{"schema":{"description":"The unique identifier for the rate-limiting event.","format":"uuid"}},"ot-request-made":{"schema":{"description":"The number of requests made within the specified period.","format":"int32"}},"ot-requests-allowed":{"schema":{"description":"The number of requests allowed within the specified period.","format":"int32"}}}},"500":{"description":"Internal Server Error"}},"security":[{"OAUTH2":["COOKIE"]}]},"post":{"operationId":"bulkAddCookies","summary":"Add Cookies","description":"Use this API to add cookies.","tags":["Cookies"],"x-onetrust":{"spec-label":"https://developer.onetrust.com/onetrust/openapi/consent-preferences-cookie-consent.json"},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/CookieCreationRequestDto"}}}}},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/EntityActionResponseDtoCookieEntityDto"}}}}},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"429":{"description":"Too Many Requests. \nFor more information, see [API Rate Limits](https://developer.onetrust.com/onetrust/reference/rate-limits-overview).","headers":{"Retry-After":{"schema":{"description":"The number of seconds after which requests will be allowed again.","format":"int32"}},"ot-period":{"schema":{"description":"The unit of time for which the rate limit applies","enum":["HOUR","MINUTE"]}},"ot-ratelimit-event-id":{"schema":{"description":"The unique identifier for the rate-limiting event.","format":"uuid"}},"ot-request-made":{"schema":{"description":"The number of requests made within the specified period.","format":"int32"}},"ot-requests-allowed":{"schema":{"description":"The number of requests allowed within the specified period.","format":"int32"}}}},"500":{"description":"Internal Server Error"}},"security":[{"OAUTH2":["COOKIE"]}]},"delete":{"operationId":"bulkDeleteCookies","summary":"Delete Cookies","description":"Use this API to delete cookies by the specified cookie ID or filter criteria.","tags":["Cookies"],"x-onetrust":{"spec-label":"https://developer.onetrust.com/onetrust/openapi/consent-preferences-cookie-consent.json"},"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BulkCookieDeletionRequest"}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/EntityActionResponseDto"}}}}},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"429":{"description":"Too Many Requests. \nFor more information, see [API Rate Limits](https://developer.onetrust.com/onetrust/reference/rate-limits-overview).","headers":{"Retry-After":{"schema":{"description":"The number of seconds after which requests will be allowed again.","format":"int32"}},"ot-period":{"schema":{"description":"The unit of time for which the rate limit applies","enum":["HOUR","MINUTE"]}},"ot-ratelimit-event-id":{"schema":{"description":"The unique identifier for the rate-limiting event.","format":"uuid"}},"ot-request-made":{"schema":{"description":"The number of requests made within the specified period.","format":"int32"}},"ot-requests-allowed":{"schema":{"description":"The number of requests allowed within the specified period.","format":"int32"}}}},"500":{"description":"Internal Server Error"}},"security":[{"OAUTH2":["COOKIE"]}]}},"/api/cmp/v1/webscans/domains/schedule":{"post":{"operationId":"scheduleScans","summary":"Schedule Website Scans","description":"Use this API to schedule scans for the specified domains.","tags":["Domains"],"x-onetrust":{"spec-label":"https://developer.onetrust.com/onetrust/openapi/consent-preferences-cookie-consent.json"},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/DomainScheduleRequest"},"uniqueItems":true}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/EntityActionResponseDto"}}}}},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"429":{"description":"Too Many Requests. \nFor more information, see [API Rate Limits](https://developer.onetrust.com/onetrust/reference/rate-limits-overview).","headers":{"Retry-After":{"schema":{"description":"The number of seconds after which requests will be allowed again.","format":"int32"}},"ot-period":{"schema":{"description":"The unit of time for which the rate limit applies","enum":["HOUR","MINUTE"]}},"ot-ratelimit-event-id":{"schema":{"description":"The unique identifier for the rate-limiting event.","format":"uuid"}},"ot-request-made":{"schema":{"description":"The number of requests made within the specified period.","format":"int32"}},"ot-requests-allowed":{"schema":{"description":"The number of requests allowed within the specified period.","format":"int32"}}}},"500":{"description":"Internal Server Error"}},"security":[{"OAUTH2":["COOKIE"]}]}},"/api/cmp/v1/webscans/domains/schedule/cancel":{"post":{"operationId":"bulkCancelDomainSchedule","summary":"Cancel Scheduled Website Scans","description":"Use this API to cancel scheduled scans.","tags":["Domains"],"x-onetrust":{"spec-label":"https://developer.onetrust.com/onetrust/openapi/consent-preferences-cookie-consent.json"},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"string","format":"uuid"}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/EntityActionResponseDto"}}}}},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"429":{"description":"Too Many Requests. \nFor more information, see [API Rate Limits](https://developer.onetrust.com/onetrust/reference/rate-limits-overview).","headers":{"Retry-After":{"schema":{"description":"The number of seconds after which requests will be allowed again.","format":"int32"}},"ot-period":{"schema":{"description":"The unit of time for which the rate limit applies","enum":["HOUR","MINUTE"]}},"ot-ratelimit-event-id":{"schema":{"description":"The unique identifier for the rate-limiting event.","format":"uuid"}},"ot-request-made":{"schema":{"description":"The number of requests made within the specified period.","format":"int32"}},"ot-requests-allowed":{"schema":{"description":"The number of requests allowed within the specified period.","format":"int32"}}}},"500":{"description":"Internal Server Error"}},"security":[{"OAUTH2":["COOKIE"]}]}},"/api/cmp/v1/webscans/domains/{domainId}/scans":{"get":{"operationId":"getDomainScans","summary":"Get List of Scans by Domain","description":"Use this API to retrieve a list of scans for a specific domain and the specified filter criteria.","tags":["Scans"],"x-onetrust":{"spec-label":"https://developer.onetrust.com/onetrust/openapi/consent-preferences-cookie-consent.json"},"parameters":[{"name":"domainId","in":"path","description":"The unique identifier of the domain.","required":true,"schema":{"type":"string","format":"uuid"},"example":"f2229953-b4b5-4042-8cb9-b78038cc4c46"},{"name":"status","in":"query","description":"The current state or condition of the item.","required":false,"schema":{"type":"string","enum":["QUEUED","PENDING","INPROGRESS","MIGRATION_STARTED","MIGRATION_COMPLETED","CATEGORIZATION_STARTED","CATEGORIZATION_FAILED","COMPLETED","ERROR","CANCELLED","SCANNING","DATA_MOVE","RETRY_BY_AUTO_CORRECT","MS_IOS_SCAN_SUCCESS","MS_IOS_SCAN_FAILED","MS_EXPORT_XLS_STARTED","MS_EXPORT_PDF_STARTED","SCHEDULED"]}},{"name":"archiveStatus","in":"query","description":"The archival state of the scan.","required":false,"schema":{"type":"string","enum":["NONE","PENDING_UI","PENDING_SCHEDULED","ARCHIVE_STARTED","ARCHIVE_COMPLETED","ARCHIVE_QUEUED","ERROR","NO_DATA_TO_EXPORT"]}},{"name":"startDate","in":"query","description":"The beginning date for filtering or date range operations.","required":false,"schema":{"type":"string","format":"date"},"example":"2025-04-25"},{"name":"endDate","in":"query","description":"The ending date for filtering or date range operations.","required":false,"schema":{"type":"string","format":"date"},"example":"2025-04-25"},{"name":"page","in":"query","description":"The page number for pagination results, starting from 0.","required":false,"schema":{"type":"integer","example":1,"default":0,"minimum":0}},{"name":"size","in":"query","description":"The number of items to return per page.","required":false,"schema":{"type":"integer","example":10,"default":10,"maximum":100,"minimum":1}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PageScanInformationResponse"}}}},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"429":{"description":"Too Many Requests. \nFor more information, see [API Rate Limits](https://developer.onetrust.com/onetrust/reference/rate-limits-overview).","headers":{"Retry-After":{"schema":{"description":"The number of seconds after which requests will be allowed again.","format":"int32"}},"ot-period":{"schema":{"description":"The unit of time for which the rate limit applies","enum":["HOUR","MINUTE"]}},"ot-ratelimit-event-id":{"schema":{"description":"The unique identifier for the rate-limiting event.","format":"uuid"}},"ot-request-made":{"schema":{"description":"The number of requests made within the specified period.","format":"int32"}},"ot-requests-allowed":{"schema":{"description":"The number of requests allowed within the specified period.","format":"int32"}}}},"500":{"description":"Internal Server Error"}},"security":[{"OAUTH2":["COOKIE","COOKIE_READ"]}]}},"/api/cmp/v1/webscans/domains/{domainId}/scans/{scanId}/scandelta":{"get":{"operationId":"getScanDeltaDetails","summary":"Get List of Added or Removed Cookies","description":"Use this API to retrieve a list of added or removed cookies between the current and previous scan for the specified domain.","tags":["Scans"],"x-onetrust":{"spec-label":"https://developer.onetrust.com/onetrust/openapi/consent-preferences-cookie-consent.json"},"parameters":[{"name":"domainId","in":"path","description":"The unique identifier of the domain.","required":true,"schema":{"type":"string","format":"uuid"},"example":"f2229953-b4b5-4042-8cb9-b78038cc4c46"},{"name":"scanId","in":"path","description":"The unique identifier of the scan.","required":true,"schema":{"type":"string","format":"uuid"},"example":"f2229953-b4b5-4042-8cb9-b78038cc4c46"},{"name":"language","in":"query","description":"The language code for localized content.","required":false,"schema":{"type":"string","maxLength":5,"minLength":2},"example":"en"},{"name":"countryCode","in":"query","description":"The country code for regional settings.","required":false,"schema":{"type":"string","maxLength":2,"minLength":2},"example":"us"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScanDeltaDetails"}}}},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"429":{"description":"Too Many Requests. \nFor more information, see [API Rate Limits](https://developer.onetrust.com/onetrust/reference/rate-limits-overview).","headers":{"Retry-After":{"schema":{"description":"The number of seconds after which requests will be allowed again.","format":"int32"}},"ot-period":{"schema":{"description":"The unit of time for which the rate limit applies","enum":["HOUR","MINUTE"]}},"ot-ratelimit-event-id":{"schema":{"description":"The unique identifier for the rate-limiting event.","format":"uuid"}},"ot-request-made":{"schema":{"description":"The number of requests made within the specified period.","format":"int32"}},"ot-requests-allowed":{"schema":{"description":"The number of requests allowed within the specified period.","format":"int32"}}}},"500":{"description":"Internal Server Error"}},"security":[{"OAUTH2":["COOKIE","COOKIE_READ"]}]}},"/api/cmp/v1/webscans/domains/{domainId}/scans/{scanId}/scanresults":{"get":{"operationId":"getDetailedScanResultInformation","summary":"Get Scan Results","description":"Use this API to retrieve results for a specific scan, including details such as cookies, tags, forms, etc.","tags":["Scans"],"x-onetrust":{"spec-label":"https://developer.onetrust.com/onetrust/openapi/consent-preferences-cookie-consent.json"},"parameters":[{"name":"domainId","in":"path","description":"The unique identifier of the domain.","required":true,"schema":{"type":"string","format":"uuid"},"example":"f2229953-b4b5-4042-8cb9-b78038cc4c46"},{"name":"scanId","in":"path","description":"The unique identifier of the scan.","required":true,"schema":{"type":"string","format":"uuid"},"example":"f2229953-b4b5-4042-8cb9-b78038cc4c46"},{"name":"language","in":"query","description":"The language code for localized content.","required":false,"schema":{"type":"string","maxLength":5,"minLength":2},"example":"en"},{"name":"countryCode","in":"query","description":"The country code for regional settings.","required":false,"schema":{"type":"string","maxLength":2,"minLength":2},"example":"us"},{"name":"entityType","in":"query","description":"The type of entity such as cookie, tag, page, form, service, or storage.","required":true,"schema":{"type":"string","enum":["COOKIE","TAG","PAGE","FORM","SERVICE","STORAGE"]},"example":"COOKIE"},{"name":"page","in":"query","description":"The page number for pagination results, starting from 0.","required":false,"schema":{"type":"integer","example":1,"default":0,"minimum":0}},{"name":"size","in":"query","description":"The number of items to return per page.","required":false,"schema":{"type":"integer","example":10,"default":10,"maximum":100,"minimum":1}}],"responses":{"200":{"description":"Returns detailed scan results.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScanResultEntityPageResponse"}}}},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"429":{"description":"Too Many Requests. \nFor more information, see [API Rate Limits](https://developer.onetrust.com/onetrust/reference/rate-limits-overview).","headers":{"Retry-After":{"schema":{"description":"The number of seconds after which requests will be allowed again.","format":"int32"}},"ot-period":{"schema":{"description":"The unit of time for which the rate limit applies","enum":["HOUR","MINUTE"]}},"ot-ratelimit-event-id":{"schema":{"description":"The unique identifier for the rate-limiting event.","format":"uuid"}},"ot-request-made":{"schema":{"description":"The number of requests made within the specified period.","format":"int32"}},"ot-requests-allowed":{"schema":{"description":"The number of requests allowed within the specified period.","format":"int32"}}}},"500":{"description":"Internal Server Error"}},"security":[{"OAUTH2":["COOKIE","COOKIE_READ"]}]}},"/api/cmp/v1/webscans/domains/{domainId}/scans/{scanId}/summary":{"get":{"operationId":"getScanResultSummary","summary":"Get Scan Result Summary","description":"Use this API to retrieve summary information for a scan, including counts of cookies, tags, forms, and other entities found.","tags":["Scans"],"x-onetrust":{"spec-label":"https://developer.onetrust.com/onetrust/openapi/consent-preferences-cookie-consent.json"},"parameters":[{"name":"domainId","in":"path","description":"The unique identifier of the domain.","required":true,"schema":{"type":"string","format":"uuid"},"example":"f2229953-b4b5-4042-8cb9-b78038cc4c46"},{"name":"scanId","in":"path","description":"The unique identifier of the scan.","required":true,"schema":{"type":"string","format":"uuid"},"example":"f2229953-b4b5-4042-8cb9-b78038cc4c46"},{"name":"language","in":"query","description":"The language code for localized content.","required":false,"schema":{"type":"string","maxLength":5,"minLength":2},"example":"en"},{"name":"countryCode","in":"query","description":"The country code for regional settings.","required":false,"schema":{"type":"string","maxLength":2,"minLength":2},"example":"us"}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ScanResultSummaryDto"}}}},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"429":{"description":"Too Many Requests. \nFor more information, see [API Rate Limits](https://developer.onetrust.com/onetrust/reference/rate-limits-overview).","headers":{"Retry-After":{"schema":{"description":"The number of seconds after which requests will be allowed again.","format":"int32"}},"ot-period":{"schema":{"description":"The unit of time for which the rate limit applies","enum":["HOUR","MINUTE"]}},"ot-ratelimit-event-id":{"schema":{"description":"The unique identifier for the rate-limiting event.","format":"uuid"}},"ot-request-made":{"schema":{"description":"The number of requests made within the specified period.","format":"int32"}},"ot-requests-allowed":{"schema":{"description":"The number of requests allowed within the specified period.","format":"int32"}}}},"500":{"description":"Internal Server Error"}},"security":[{"OAUTH2":["COOKIE","COOKIE_READ"]}]}},"/api/cmp/v1/webscans/languages/{language}/cookies/filter":{"post":{"operationId":"getCookiesByFilter","summary":"Get List of Cookies by Criteria","description":"Use this API to retrieve a list of cookies by the specified filter criteria.","tags":["Cookies"],"x-onetrust":{"spec-label":"https://developer.onetrust.com/onetrust/openapi/consent-preferences-cookie-consent.json"},"parameters":[{"name":"language","in":"path","description":"The language code for localized content.","required":true,"schema":{"type":"string","maxLength":5,"minLength":2},"example":"en"},{"name":"countryCode","in":"query","description":"The country code for regional settings.","required":false,"schema":{"type":"string","maxLength":2,"minLength":2},"example":"us"},{"name":"cookieName","in":"query","description":"The name of the cookie.","required":false,"schema":{"type":"string","maxLength":255},"example":"cookie123"},{"name":"sortBy","in":"query","description":"Field to sort by","required":false,"schema":{"type":"string","enum":["cookieName","host","category"]},"example":"cookieName"},{"name":"direction","in":"query","description":"Sort direction","required":false,"schema":{"type":"string","enum":["asc","desc"]},"example":"desc"},{"name":"page","in":"query","description":"The page number for pagination results, starting from 0.","required":false,"schema":{"type":"integer","example":1,"default":0,"minimum":0}},{"name":"size","in":"query","description":"The number of items to return per page.","required":false,"schema":{"type":"integer","example":10,"default":10,"maximum":100,"minimum":1}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CookieFilters"}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PageCookieResponseDto"}}}},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"429":{"description":"Too Many Requests. \nFor more information, see [API Rate Limits](https://developer.onetrust.com/onetrust/reference/rate-limits-overview).","headers":{"Retry-After":{"schema":{"description":"The number of seconds after which requests will be allowed again.","format":"int32"}},"ot-period":{"schema":{"description":"The unit of time for which the rate limit applies","enum":["HOUR","MINUTE"]}},"ot-ratelimit-event-id":{"schema":{"description":"The unique identifier for the rate-limiting event.","format":"uuid"}},"ot-request-made":{"schema":{"description":"The number of requests made within the specified period.","format":"int32"}},"ot-requests-allowed":{"schema":{"description":"The number of requests allowed within the specified period.","format":"int32"}}}},"500":{"description":"Internal Server Error"}},"security":[{"OAUTH2":["COOKIE","COOKIE_READ"]}]}},"/api/cmp/v1/webscans/status":{"post":{"operationId":"checkScansStatus","summary":"Get Scan Statuses","description":"Use this API to retrieve the status of the specified scans.","tags":["Scans"],"x-onetrust":{"spec-label":"https://developer.onetrust.com/onetrust/openapi/consent-preferences-cookie-consent.json"},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"string","format":"uuid"}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ScanStatusResponse"}}}}},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"429":{"description":"Too Many Requests. \nFor more information, see [API Rate Limits](https://developer.onetrust.com/onetrust/reference/rate-limits-overview).","headers":{"Retry-After":{"schema":{"description":"The number of seconds after which requests will be allowed again.","format":"int32"}},"ot-period":{"schema":{"description":"The unit of time for which the rate limit applies","enum":["HOUR","MINUTE"]}},"ot-ratelimit-event-id":{"schema":{"description":"The unique identifier for the rate-limiting event.","format":"uuid"}},"ot-request-made":{"schema":{"description":"The number of requests made within the specified period.","format":"int32"}},"ot-requests-allowed":{"schema":{"description":"The number of requests allowed within the specified period.","format":"int32"}}}},"500":{"description":"Internal Server Error"}},"security":[{"OAUTH2":["COOKIE","COOKIE_READ"]}]}},"/api/cmp/v1/webscans/{scanId}/cancel":{"put":{"operationId":"cancelScan","summary":"Cancel Scan","description":"Use this API to cancel a specific scan.","tags":["Scans"],"x-onetrust":{"spec-label":"https://developer.onetrust.com/onetrust/openapi/consent-preferences-cookie-consent.json"},"parameters":[{"name":"scanId","in":"path","description":"The unique identifier of the scan.","required":true,"schema":{"type":"string","format":"uuid"},"example":"f2229953-b4b5-4042-8cb9-b78038cc4c46"}],"responses":{"200":{"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"429":{"description":"Too Many Requests. \nFor more information, see [API Rate Limits](https://developer.onetrust.com/onetrust/reference/rate-limits-overview).","headers":{"Retry-After":{"schema":{"description":"The number of seconds after which requests will be allowed again.","format":"int32"}},"ot-period":{"schema":{"description":"The unit of time for which the rate limit applies","enum":["HOUR","MINUTE"]}},"ot-ratelimit-event-id":{"schema":{"description":"The unique identifier for the rate-limiting event.","format":"uuid"}},"ot-request-made":{"schema":{"description":"The number of requests made within the specified period.","format":"int32"}},"ot-requests-allowed":{"schema":{"description":"The number of requests allowed within the specified period.","format":"int32"}}}},"500":{"description":"Internal Server Error"}},"security":[{"OAUTH2":["COOKIE"]}]}},"/api/cmp/v1/webscans/{scanId}/recategorize":{"put":{"operationId":"recategorizeCookiesByScan","summary":"Recategorize Cookies","description":"Use this API to initiate cookie recategorization for a scan.","tags":["Cookies"],"x-onetrust":{"spec-label":"https://developer.onetrust.com/onetrust/openapi/consent-preferences-cookie-consent.json"},"parameters":[{"name":"scanId","in":"path","description":"The unique identifier of the scan.","required":true,"schema":{"type":"string","format":"uuid"},"example":"f2229953-b4b5-4042-8cb9-b78038cc4c46"}],"responses":{"200":{"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"429":{"description":"Too Many Requests. \nFor more information, see [API Rate Limits](https://developer.onetrust.com/onetrust/reference/rate-limits-overview).","headers":{"Retry-After":{"schema":{"description":"The number of seconds after which requests will be allowed again.","format":"int32"}},"ot-period":{"schema":{"description":"The unit of time for which the rate limit applies","enum":["HOUR","MINUTE"]}},"ot-ratelimit-event-id":{"schema":{"description":"The unique identifier for the rate-limiting event.","format":"uuid"}},"ot-request-made":{"schema":{"description":"The number of requests made within the specified period.","format":"int32"}},"ot-requests-allowed":{"schema":{"description":"The number of requests allowed within the specified period.","format":"int32"}}}},"500":{"description":"Internal Server Error"}},"security":[{"OAUTH2":["COOKIE"]}]}}},"components":{"schemas":{"CookieSourceRequestDto":{"type":"object","properties":{"domainId":{"description":"The unique identifier of the domain.","type":"string","format":"uuid","example":"f2229953-b4b5-4042-8cb9-b78038cc4c46"},"domainCookieSourceRequestDtoList":{"description":"The list of cookie source configuration requests for the domain.","type":"array","items":{"$ref":"#/components/schemas/DomainCookieSourceRequestDto"},"example":[{"Id":"f2229953-b4b5-4042-8cb9-b78038cc4c46","ResourceUrl":"amazon.com","resourceType":"MANUAL","resourceOrigin":"MANUAL","resourceMatchType":"URL","trackerType":"cookie"}],"maxItems":1000,"minItems":0}}},"CookieUpdateRequestDto":{"type":"object","properties":{"cookieId":{"description":"The unique identifier of the cookie.","type":"string","format":"uuid","example":"f2229953-b4b5-4042-8cb9-b78038cc4c46"},"cookieName":{"description":"The name of the cookie.","type":"string","example":"newCookieName123","maxLength":512,"minLength":0},"lifespan":{"description":"The duration for which the cookie remains active before expiring.","type":"string","example":"SESSION","enum":["SESSION","PERSISTENT"]},"host":{"description":"The domain or website that created the cookie.","type":"string","example":"host.com","maxLength":512,"minLength":0},"description":{"description":"The description of the cookie and its intended purpose.","type":"string","example":"this cookies is used for functional purposes only","maxLength":1000,"minLength":1},"thirdPartyDescription":{"description":"The description of third-party cookies and their usage.","type":"string","example":"this cookies is used for targeting purposes only","maxLength":1000,"minLength":1},"length":{"description":"Length of the Cookie lifespan, enter a number greater than 0 if this is a Persistent cookie, otherwise leave as 0","type":"integer","format":"int32","example":5,"minimum":0},"durationType":{"description":"The type of duration indicating whether the cookie is session-based or persistent.","type":"integer","format":"int32","example":7,"enum":["1","7","30","365"]},"customCategoryName":{"description":"The custom name assigned to the cookie category.","type":"string","example":"C0001","maxLength":100,"minLength":1},"domainToDeleteIds":{"description":"The list of domain identifiers to be removed from the system.","type":"array","items":{"type":"string","format":"uuid"},"example":["f2229953-b4b5-4042-8cb9-b78038cc4c46","a1234567-b4b5-4042-8cb9-b78038cc4c47"],"maxItems":1000,"minItems":0},"domainCookieCategoryList":{"description":"The list of categories assigned to cookies for the specific domain.","type":"array","items":{"$ref":"#/components/schemas/DomainCookieCategoryRequestDto"},"example":[{"domainId":"f2229953-b4b5-4042-8cb9-b78038cc4c46","customCategoryName":"C0001"}],"maxItems":1000,"minItems":0},"domainCookieSource":{"description":"The source from which domain cookies originate.","type":"array","items":{"$ref":"#/components/schemas/CookieSourceRequestDto"},"example":[{"domainId":"f2229953-b4b5-4042-8cb9-b78038cc4c46","domainCookieSourceRequestDtoList":[]}],"maxItems":1000,"minItems":0},"domainCookieSourceToDelete":{"description":"The cookie sources that are marked for deletion.","type":"array","items":{"$ref":"#/components/schemas/DomainCookieSourceRequestDto"},"example":[{"domainId":"f2229953-b4b5-4042-8cb9-b78038cc4c46","sourceId":"a1b2c3d4-e5f6-7890-abcd-ef1234567890"}],"maxItems":1000,"minItems":0},"descriptionTranslations":{"description":"The translations of descriptions provided in different languages.","type":"array","items":{"$ref":"#/components/schemas/DescriptionTranslationDto"},"example":[{"language":"fr","description":"Ce cookie est utilisé à des fins fonctionnelles uniquement"}],"maxItems":1000,"minItems":0}},"required":["cookieId"]},"DescriptionTranslationDto":{"type":"object","properties":{"langCode":{"description":"The language code used for localization purposes.","type":"string","example":"EN","maxLength":10,"minLength":2},"defaultDescription":{"description":"The standard description that is used when no translation is provided for a specific language.","type":"string","example":"This is an example","maxLength":1000,"minLength":1},"thirdPartyDescription":{"description":"The description of third-party cookies and their usage.","type":"string","example":"This is an example","maxLength":1000,"minLength":1}}},"DomainCookieCategoryRequestDto":{"type":"object","properties":{"domainId":{"description":"The unique identifier of the domain.","type":"string","format":"uuid","example":"f2229953-b4b5-4042-8cb9-b78038cc4c46"},"customCategoryName":{"description":"The custom name assigned to the cookie category.","type":"string","example":"C0000","maxLength":100,"minLength":1},"thirdParty":{"description":"This flag indicates whether the cookie originates from a third-party source.","type":"boolean","example":true},"description":{"description":"The description of the cookie and its intended purpose.","type":"string","example":"this cookies is used for targeting purposes only","maxLength":1000,"minLength":1}}},"DomainCookieSourceRequestDto":{"type":"object","properties":{"resourceType":{"description":"The type of web resource such as script, image, or stylesheet.","type":"string","example":"MANUAL","enum":["MANUAL","PATTERN","SCRIPT","MAIN_FRAME"],"maxLength":255,"minLength":1},"resourceOrigin":{"description":"resource origin type","type":"string","example":"MANUAL","enum":["SCANNER","MANUAL","TELEMETRYSCANNER"]},"resourceMatchType":{"description":"resource match type","type":"string","example":"URL","enum":["URL","SYSTEM_PATTERN","CUSTOM_PATTERN"]},"trackerType":{"description":"The category of tracking technology being used.","type":"string","example":"cookie","maxLength":100,"minLength":1},"id":{"description":"The unique identifier of the item.","type":"string","format":"uuid"},"ResourceUrl":{"description":"The web address where the resource is located.","type":"string","example":"amazon.com","maxLength":255,"minLength":1}}},"EntityActionResponseDto":{"type":"object","properties":{"entityId":{"description":"The unique identifier of the entity.","type":"string","format":"uuid","example":"f2229953-b4b5-4042-8cb9-b78038cc4c46"},"entityType":{"description":"The type of entity such as cookie, tag, page, form, service, or storage.","type":"string","example":"SCAN","enum":["SCAN","DOMAIN","COOKIE"]},"action":{"description":"The action that was performed or is to be performed.","type":"string","example":"ARCHIVE","enum":["ARCHIVE","SCHEDULE","SCHEDULE_CANCEL","EDIT","CREATE","DELETE"]},"message":{"description":"The message or notification text.","type":"string","example":"Scan queued for archival","maxLength":500,"minLength":1},"content":{"description":"The main content or data payload of the response.","type":"object"},"success":{"description":"This flag indicates whether the operation completed successfully.","type":"boolean"}}},"GeoRuleGroupAssignRequestDto":{"type":"object","properties":{"domainIds":{"description":"List of domain IDs to assign to the geo rule group.","type":"array","items":{"type":"string","format":"uuid"},"example":["f2229953-b4b5-4042-8cb9-b78038cc4c46","a1234567-b4b5-4042-8cb9-b78038cc4c47"],"maxItems":1000,"minItems":0},"applicationIds":{"description":"List of application IDs to assign to the geo rule group.","type":"array","items":{"type":"string","format":"uuid"},"example":["c3456789-b4b5-4042-8cb9-b78038cc4c48","d4567890-b4b5-4042-8cb9-b78038cc4c49"],"maxItems":1000,"minItems":0}}},"DomainBrandingAttributesRequestDTO":{"type":"object","properties":{"attributes":{"description":"List of branding attributes. Allowed attributes (key: description)","type":"array","items":{"$ref":"#/components/schemas/PublicDomainBrandingAttributeDTO"},"example":[{"id":"f2229953-b4b5-4042-8cb9-b78038cc4c46","name":"dPCenterCookiePolicyLinkScreenReader","value":"Cookie Policy","type":"STRING"},{"id":"a1b2c3d4-e5f6-7890-abcd-ef1234567890","name":"dPCenterButtonColor","value":"#FFFFFF","type":"STRING"}]}}},"PublicDomainBrandingAttributeDTO":{"type":"object","properties":{"id":{"description":"Attribute ID","type":"string","format":"uuid","example":"f2229953-b4b5-4042-8cb9-b78038cc4c46"},"name":{"description":"Domain branding attribute name. Allowed attributes (key: description)","type":"string","enum":["dPCenterCookiePolicyLinkScreenReader","dPCenterButtonColor","dPCenterLegIntButtonColor","dPCenterBackgroundColor","dPCenterImprintLink","dPCenterShowImprintLink","dBannerCategoryStyle","dBannerImprintLink","dPCenterMenuColor","dBannerBackgroundColor","dBannerContinueWithoutAcceptLinkColor","dBannerCompanyLogoScreenReader","dBannerLogoFilePath","dPCenterFooterLogoFilePath","dBannerCategoryContainerColor","dBannerButtonTextColor","dBannerCookiePolicyURL","dBannerCookiePolicyLink","dBannerCompanyLogoFilePath","dBannerShowImprintLink","dCListBackgroundColor","dPCenterCookiePolicyLink","dBannerTextColor","dBannerSaveChoicesButtonColor","dBannerRequireExternalLinks","dBannerShowCookiePolicyLink","dBannerImprintLinkURL","dPCenterImprintLinkURL","dPCenterCookiePolicyURL","dCListGroupColor","dCListButtonColor","dCListTableHeaderColor","dCListTextColor","dPCenterContinueWithoutAcceptLinkColor","dBannerMPButtonTextColor","dCListTitleColor","dPCenterLogoScreenReader","dPCenterShowCookiePolicyLink","dBannerLineBreakColor","dPCenterLegIntButtonTextColor","dBannerExternalLinksLogoFilePath","dBannerCustomCSS","dBannerMPButtonColor","dBannerCategoryStyleColor","dPCenterLinksTextColor","dPCenterLogoFilePath","dCListCustomCSS","dCListButtonTextColor","dPCenterOverrideBranding","dBannerLinksTextColor","dOverrideTemplateStyling","dCListTableHeaderBackgroundColor","dPCenterMenuHighlightColor","dPCenterButtonTextColor","dPCenterCustomCSS","dBannerButtonColor","dPCenterTextColor","dBannerAnimation"],"x-enumDescriptions":{"dCListGroupColor":"Cookie list group color","dPCenterCookiePolicyLinkScreenReader":"Preference center cookie policy link screen reader text","dCListButtonColor":"Cookie list button color","dPCenterButtonColor":"Preference center primary button color","dCListTableHeaderColor":"Cookie list table header text color","dCListTextColor":"Cookie list text color","dPCenterContinueWithoutAcceptLinkColor":"Preference center 'continue without accepting' link color","dPCenterLegIntButtonColor":"Preference center legitimate interest button color","dBannerMPButtonTextColor":"Banner multi-purpose button text color","dPCenterBackgroundColor":"Preference center background color","dCListTitleColor":"Cookie list title color","dPCenterLogoScreenReader":"Preference center logo screen reader text","dPCenterImprintLink":"Preference center imprint link text","dPCenterShowImprintLink":"Show/hide imprint link in preference center","dBannerCategoryStyle":"Banner category style option","dPCenterShowCookiePolicyLink":"Show/hide cookie policy link in preference center","dBannerImprintLink":"Banner imprint link text","dBannerLineBreakColor":"Banner line break color","dPCenterMenuColor":"Preference center menu color","dPCenterLegIntButtonTextColor":"Preference center legitimate interest button text color","dBannerBackgroundColor":"Banner background color","dBannerExternalLinksLogoFilePath":"Banner external links logo file path","dBannerContinueWithoutAcceptLinkColor":"Banner 'continue without accepting' link color","dBannerCustomCSS":"Banner custom CSS","dBannerMPButtonColor":"Banner multi-purpose button color","dBannerCompanyLogoScreenReader":"Banner company logo screen reader text","dBannerLogoFilePath":"Banner logo file path","dBannerCategoryStyleColor":"Banner category style color","dPCenterFooterLogoFilePath":"Preference center footer logo file path","dPCenterLinksTextColor":"Preference center links text color","dPCenterLogoFilePath":"Preference center logo file path","dCListCustomCSS":"Cookie list custom CSS","dBannerCategoryContainerColor":"Banner category container color","dCListButtonTextColor":"Cookie list button text color","dBannerButtonTextColor":"Banner button text color","dPCenterOverrideBranding":"Override preference center branding","dBannerCookiePolicyURL":"Banner cookie policy URL","dBannerCookiePolicyLink":"Banner cookie policy link text","dBannerCompanyLogoFilePath":"Banner company logo file path","dBannerShowImprintLink":"Show/hide imprint link in banner","dBannerLinksTextColor":"Banner links text color","dCListBackgroundColor":"Cookie list background color","dPCenterCookiePolicyLink":"Preference center cookie policy link text","dBannerTextColor":"Banner text color","dBannerSaveChoicesButtonColor":"Banner save choices button color","dOverrideTemplateStyling":"Override template styling","dCListTableHeaderBackgroundColor":"Cookie list table header background color","dBannerRequireExternalLinks":"Require external links handling on banner","dPCenterMenuHighlightColor":"Preference center menu highlight color","dBannerShowCookiePolicyLink":"Show/hide cookie policy link in banner","dPCenterButtonTextColor":"Preference center button text color","dPCenterCustomCSS":"Preference center custom CSS","dBannerButtonColor":"Banner primary button color","dPCenterTextColor":"Preference center text color","dBannerAnimation":"Banner animation option","dBannerImprintLinkURL":"Banner imprint URL","dPCenterImprintLinkURL":"Preference center imprint URL","dPCenterCookiePolicyURL":"Preference center cookie policy URL"}},"value":{"description":"Attribute value","type":"object","example":"#000000"},"type":{"description":"Attribute type","type":"string","example":"STRING","enum":["STRING","LONG","BOOLEAN","UUID"]}}},"BrandingAttributesUpdateResponseDTO":{"type":"object","properties":{"id":{"description":"Resource ID (Domain ID or Application ID)","type":"string","format":"uuid","example":"f2229953-b4b5-4042-8cb9-b78038cc4c46"}}},"PublishRegionRuleDto":{"type":"object","properties":{"ruleId":{"description":"Unique identifier of the geo rule.","type":"string","format":"uuid","example":"f2229953-b4b5-4042-8cb9-b78038cc4c46"},"ruleName":{"description":"Name of a Geolocation rule","type":"string","example":"Global","maxLength":255,"minLength":1}}},"ScriptPublishRequestDto":{"type":"object","properties":{"scriptVersion":{"description":"(Optional) The SDK version to publish to. If not provided, the previously configured SDK version will be used. ","type":"string","example":"202607.1.0"},"languages":{"description":"The list of language codes for localized content.","type":"array","items":{"type":"string"},"example":["Irish","English - United States of America","Greek"],"maxItems":100,"minItems":0},"publishIndividualLanguages":{"description":"This flag indicates whether to publish scripts for individual languages separately.","type":"boolean","example":true,"default":"false"},"requireReconsent":{"description":"This flag indicates whether user reconsent is required.","type":"boolean","example":true,"default":"false"},"regionRules":{"description":"(Optional) Individual geolocation rules to apply require reconsent to.","type":"array","items":{"$ref":"#/components/schemas/PublishRegionRuleDto"},"example":[{"ruleId":"f2229953-b4b5-4042-8cb9-b78038cc4c46","ruleName":"Global"},{"ruleId":"a1b2c3d4-e5f6-7890-abcd-ef1234567890","ruleName":"Europe"}],"maxItems":1000,"minItems":0},"suppressBannerEnabled":{"description":"This flag indicates whether the consent banner display is suppressed.","type":"boolean","example":false},"suppressPCEnabled":{"description":"This flag indicates whether the preference center display is suppressed.","type":"boolean","example":false},"gaTrackingEnabled":{"description":"When toggle is ON, Google Analytics events will be created and passed based on user interaction. You can also choose for gaEvent tracking on the banner to be associated with the acceptance of a category. The data-ignore-ga='true' attribute will override this configuration. Google Analytics integration also required.","type":"boolean"},"gaAssignCategory":{"description":"Name of the category to assign to Google Analytics events. Use 'AS' for always send. Unnecessary unless gaTrackingEnabled is true.","type":"string","example":"C0001"},"autoblockEnabled":{"description":"This flag indicates whether automatic blocking of cookies is enabled.","type":"boolean","example":false},"enableCommonTrackers":{"description":"This flag indicates whether common tracking technologies are enabled.","type":"boolean","example":false},"commonTrackers":{"description":"Select the hosts that you want to autoblock. Only applicable when autoblockEnabled and enableCommonTrackers are true.","type":"array","items":{"type":"string"},"enum":["addthis.com","addtoany.com","adsrvr.org","amazon-adsystem.com","bing.com","bounceexchange.com","bouncex.net","criteo.com","criteo.net","dailymotion.com","doubleclick.net","everesttech.net","facebook.com","facebook.net","googleadservices.com","googlesyndication.com","krxd.net","liadm.com","linkedin.com","outbrain.com","rubiconproject.com","sharethis.com","taboola.com","twitter.com","vimeo.com","yahoo.com","youtube.com"],"maxItems":100,"minItems":0},"sameSiteNone":{"description":"Sets the cookies used SameSite attribute to 'None'","type":"boolean","example":false},"separateCookieByDomain":{"description":"Only applicable when sameSiteNone is true.When cookies are created with partitioned state from an iframe, they are created specific to their top level site domain and are not shared with other top-level domains using the same iframe. This setting is ignored if sameSiteNone is false.","type":"boolean","example":false},"supportSPA":{"description":"Enabling this allows you to force the banner to reload, the same as it would on an actual page change.","type":"boolean","example":false},"supportCSP":{"description":"If enabled, the polyfill allows us to add inline styles, style tags with a nonce are allowed by the CSP","type":"boolean"},"languageDetectionEnabled":{"description":"This flag indicates whether automatic language detection is enabled.","type":"boolean","example":false},"languageDetectionVisitor":{"description":"This flag indicates whether visitor-based language detection is enabled.","type":"boolean","example":false},"languageDetectionHtml":{"description":"This flag indicates whether HTML-based language detection is enabled.","type":"boolean","example":false},"autoRefreshEnabled":{"description":"When a user makes any consent choice, the web page and consent banner will refresh automatically. This setting can further prevent unauthorized cookies from dropping without consent.","type":"boolean","default":"false"}}},"PublishScriptDto":{"type":"object","properties":{"responseMsg":{"description":"The response message returned from the operation.","type":"string","example":"Publish initiated successfully!","maxLength":500,"minLength":1},"publishVersion":{"description":"The version number of the published script.","type":"string","example":"202503.2.0","maxLength":50,"minLength":1},"consentPolicyName":{"description":"The name of the consent policy that is applied.","type":"string","example":"Default Consent Policy","maxLength":255,"minLength":1},"autoBlocking":{"description":"This flag indicates whether automatic cookie blocking is enabled.","type":"boolean","example":true},"reconsentRequired":{"description":"This flag indicates whether user reconsent is required.","type":"boolean","example":true},"publishedDate":{"description":"The date and time when the script was published.","type":"string","format":"date-time","example":"2025-05-29T14:53:00Z"},"userName":{"description":"The name of the user who performed the operation.","type":"string","example":"User user","maxLength":255,"minLength":1}}},"PublishGeolocationRuleRequestApplicationPublicDto":{"type":"object","properties":{"publishVersion":{"description":"Version to publish, by default the lastest version will be used.","type":"string","example":"202603.1.0","maxLength":255,"minLength":1},"production":{"description":"Publish a test (false) or production (true)","type":"boolean","example":true,"default":"false"},"publishType":{"description":"The type of SDK being published","type":"string","example":"PUBLISHERS","default":"HEADLESS","enum":["PUBLISHERS","HEADLESS","UNITY","ROKU","XAMARIN","SAMSUNGTV","LGTV","VIZIOTV","HBBTV","PANASONICTV","PS5","YOUVIEW"]},"requireReconsent":{"description":"If users will be required to reconsent once this update is published","type":"boolean","example":false,"default":"false"},"langCodes":{"description":"Languages to publish in, by default all languages will be published.","type":"array","items":{"type":"string"},"example":["fr","de","en"],"maxItems":100,"minItems":0},"regionRules":{"description":"Individual geolocation rules","type":"array","items":{"$ref":"#/components/schemas/PublishRegionRuleDto"},"example":[{"ruleId":"f2229953-b4b5-4042-8cb9-b78038cc4c46","ruleName":"Global"},{"ruleId":"a1b2c3d4-e5f6-7890-abcd-ef1234567890","ruleName":"Europe"}],"maxItems":1000,"minItems":0}}},"ApplicationBrandingAttributesRequestDTO":{"type":"object","properties":{"attributes":{"description":"List of application branding attributes to update.","type":"array","items":{"$ref":"#/components/schemas/PublicApplicationBrandingAttributeDTO"},"example":[{"id":"f2229953-b4b5-4042-8cb9-b78038cc4c46","name":"mob_aBannerTextColor","value":"#000000","type":"STRING"},{"id":"a1b2c3d4-e5f6-7890-abcd-ef1234567890","name":"mob_aBannerCloseButtonTextColorDark","value":"#FFFFFF","type":"STRING"}]}}},"PublicApplicationBrandingAttributeDTO":{"type":"object","properties":{"id":{"description":"Attribute ID","type":"string","format":"uuid","example":"f2229953-b4b5-4042-8cb9-b78038cc4c46"},"name":{"description":"Application branding attributes to update. Allowed attributes (key: description)","type":"string","enum":["mob_aBannerTextColor","mob_aBannerCloseButtonTextColorDark","mob_testShowCFDLWarningMsg","mob_aBannerTextColorDark","mob_aPCSearchBarTextColorDark","mob_aBannerAcceptRejectTextColorDark","mob_aBannerMPButtonTextColor","mob_aBannerVendorListTextColor","mob_aBannerManagePrefTextColorDark","mob_aBannerShowImprintLink","mob_showCFDLWarningMsg","mob_aBannerPolicyLinkShow","mob_aPCToggleInactiveColor","mob_aPCSearchBarBGColorDark","mob_aPCLineBreakColorDark","mob_aPCButtonColor","mob_aPCLogoUrl","mob_aBannerLinkColorDark","mob_aBannerMPButtonColor","mob_aPCPolicyLinkQRCodeUrl","mob_aBannerBackgroundColor","mob_aBannerLinksTextColor","mob_aPCCloseButtonTextColorDark","mob_aPCShowLogo","mob_aPCBGColorDark","mob_aPCAcceptRejectTextColorDark","mob_aPCAlwaysActiveTextColorDark","mob_aPCSavePrefTextColorDark","mob_aPCPolicyLinkTextColor","mob_aBannerCloseButtonColorDark","mob_aPCPurposeListItemAlwaysActiveLabelColor","mob_aBannerContinueWithoutAcceptLinkColor","mob_aPCButtonTextColor","mob_aPCBackgroundColor","mob_aPCLinkColorDark","mob_aBannerVendorListLinkTextColorDark","mob_aBannerPolicyLinkUrl","mob_aBannerImprintLink","mob_aPCLinksTextColor","mob_aPCSavePrefColorDark","mob_aPCenterVendorListLinkTextColor","mob_aBannerAcceptRejectColorDark","mob_aPCPolicyLinkShow","mob_aPCTextColor","mob_aPCPurposeListItemTitleTextColorDark","mob_aBannerLogoShow","mob_aBannerBGColorDark","mob_aBannerButtonTextColor","mob_aBannerLogoUrl","mob_aBannerManagePrefColorDark","mob_aOverrideTemplateStyling","mob_aPCToggleTrackInActiveColorDark","mob_aBannerPolicyLinkQRCodeUrl","mob_aPCToggleActiveColor","mob_aPCenterVendorListLinkText","mob_aPCPolicyLinkText","mob_aBannerVendorListText","mob_aPCAcceptRejectColorDark","mob_aPCPolicyLinkUrl","mob_aBannerButtonColor","mob_aBannerImprintLinkURL","mob_aPCTextColorDark","mob_aBannerPolicyLinkTextColor","mob_aPCContinueWithoutAcceptLinkColor","ott_aPCMPButtonTextColor","ott_aBannerPolicyLinkQRCodeUrl","ott_aBannerMPButtonColor","ott_aPCMenuColor","ott_aBannerContinueWithoutAcceptLinkColor","ott_aPCPolicyLinkTextColor","ott_aPCButtonFocusColor","ott_aPCContinueWithoutAcceptLinkColor","ott_aBannerPolicyLinkShow","ott_aPCMenuTextColor","ott_aPCTextColor","ott_aBannerMPButtonTextColor","ott_aBannerPolicyLinkText","ott_aPCLinksTextColor","ott_aBannerButtonFocusTextColor","ott_aPCMenuActiveTextColor","ott_aPCButtonTextColor","ott_aPCPolicyLinkUrl","ott_aPCMPButtonColor","ott_aPCButtonBorderShow","ott_aPCPolicyLinkShow","ott_aPCButtonColor","ott_aPCMenuFocusColor","ott_aBannerButtonTextColor","ott_aPCBackgroundColor","ott_aBannerButtonColor","ott_aOverrideTemplateStyling","ott_aPCButtonFocusTextColor","ott_aBannerButtonFocusColor","ott_aPCPolicyLinkText","ott_aOverrideTemplateStylings","ott_aBannerPolicyLinkTextColor","ott_aBannerLinksTextColor","ott_aPCMenuFocusTextColor","ott_BannerButtonBorderShow","ott_aBannerTextColor","ott_aBannerPolicyLinkUrl","ott_aPCPolicyLinkQRCodeUrl","ott_aPCMenuActiveColor","ott_aBannerBackgroundColor","ott_aPCLogoUrl","ott_aBannerLogoUrl"],"x-enumDescriptions":{"mob_aBannerTextColor":"Mobile banner text color","ott_aPCMPButtonTextColor":"OTT preference center multi-purpose button text color","ott_aBannerPolicyLinkQRCodeUrl":"OTT banner policy link QR code URL","ott_aBannerMPButtonColor":"OTT banner multi-purpose button color","mob_aBannerCloseButtonTextColorDark":"Mobile banner close button text color (dark theme)","mob_testShowCFDLWarningMsg":"Mobile CFDL warning message toggle (test)","mob_aBannerTextColorDark":"Mobile banner text color (dark theme)","mob_aPCSearchBarTextColorDark":"Mobile preference center search bar text color (dark theme)","mob_aBannerAcceptRejectTextColorDark":"Mobile banner accept/reject text color (dark theme)","ott_aPCMenuColor":"OTT preference center menu color","mob_aBannerMPButtonTextColor":"Mobile banner multi-purpose button text color","mob_aBannerVendorListTextColor":"Mobile banner vendor list text color","mob_aBannerManagePrefTextColorDark":"Mobile banner manage preferences text color (dark theme)","mob_aBannerShowImprintLink":"Mobile banner show/hide imprint link","mob_showCFDLWarningMsg":"Mobile CFDL warning message toggle","mob_aBannerPolicyLinkShow":"Mobile banner show/hide policy link","mob_aPCToggleInactiveColor":"Mobile preference center toggle inactive color","ott_aBannerContinueWithoutAcceptLinkColor":"OTT banner 'continue without accepting' link color","ott_aPCPolicyLinkTextColor":"OTT preference center policy link text color","mob_aPCSearchBarBGColorDark":"Mobile preference center search bar background color (dark theme)","mob_aPCLineBreakColorDark":"Mobile preference center line break color (dark theme)","ott_aPCButtonFocusColor":"OTT preference center button focus color","ott_aPCContinueWithoutAcceptLinkColor":"OTT preference center 'continue without accepting' link color","ott_aBannerPolicyLinkShow":"OTT banner show/hide policy link","ott_aPCMenuTextColor":"OTT preference center menu text color","mob_aPCButtonColor":"Mobile preference center button color","ott_aPCTextColor":"OTT preference center text color","ott_aBannerMPButtonTextColor":"OTT banner multi-purpose button text color","ott_aBannerPolicyLinkText":"OTT banner policy link text","mob_aPCLogoUrl":"Mobile preference center logo URL","ott_aPCLinksTextColor":"OTT preference center links text color","mob_aBannerLinkColorDark":"Mobile banner link color (dark theme)","ott_aBannerButtonFocusTextColor":"OTT banner button focus text color","mob_aBannerMPButtonColor":"Mobile banner multi-purpose button color","mob_aPCPolicyLinkQRCodeUrl":"Mobile preference center policy link QR code URL","mob_aBannerBackgroundColor":"Mobile banner background color","mob_aBannerLinksTextColor":"Mobile banner links text color","ott_aPCMenuActiveTextColor":"OTT preference center active menu text color","mob_aPCCloseButtonTextColorDark":"Mobile preference center close button text color (dark theme)","mob_aPCShowLogo":"Mobile preference center show/hide logo","mob_aPCBGColorDark":"Mobile preference center background color (dark theme)","mob_aPCAcceptRejectTextColorDark":"Mobile preference center accept/reject text color (dark theme)","mob_aPCAlwaysActiveTextColorDark":"Mobile preference center always-active text color (dark theme)","mob_aPCSavePrefTextColorDark":"Mobile preference center save preferences text color (dark theme)","mob_aPCPolicyLinkTextColor":"Mobile preference center policy link text color","ott_aPCButtonTextColor":"OTT preference center button text color","mob_aBannerCloseButtonColorDark":"Mobile banner close button color (dark theme)","ott_aPCPolicyLinkUrl":"OTT preference center policy link URL","mob_aPCPurposeListItemAlwaysActiveLabelColor":"Mobile preference center purpose list always-active label color","ott_aPCMPButtonColor":"OTT preference center multi-purpose button color","mob_aBannerContinueWithoutAcceptLinkColor":"Mobile banner 'continue without accepting' link color","mob_aPCButtonTextColor":"Mobile preference center button text color","mob_aPCBackgroundColor":"Mobile preference center background color","mob_aPCLinkColorDark":"Mobile preference center link color (dark theme)","ott_aPCButtonBorderShow":"OTT preference center show/hide button border","mob_aBannerVendorListLinkTextColorDark":"Mobile banner vendor list link text color (dark theme)","ott_aPCPolicyLinkShow":"OTT preference center show/hide policy link","ott_aPCLogoUrl":"OTT preference center logo URL","mob_aBannerPolicyLinkUrl":"Mobile banner policy link URL","mob_aBannerImprintLink":"Mobile banner imprint link text","ott_aPCButtonColor":"OTT preference center button color","ott_aPCMenuFocusColor":"OTT preference center menu focus color","ott_aBannerButtonTextColor":"OTT banner button text color","ott_aPCBackgroundColor":"OTT preference center background color","ott_aBannerButtonColor":"OTT banner button color","mob_aPCLinksTextColor":"Mobile preference center links text color","mob_aPCSavePrefColorDark":"Mobile preference center save preferences button color (dark theme)","ott_aOverrideTemplateStyling":"OTT override template styling","mob_aPCenterVendorListLinkTextColor":"Mobile preference center vendor list link text color","ott_aPCButtonFocusTextColor":"OTT preference center button focus text color","mob_aBannerAcceptRejectColorDark":"Mobile banner accept/reject button color (dark theme)","mob_aPCPolicyLinkShow":"Mobile preference center show/hide policy link","mob_aPCTextColor":"Mobile preference center text color","mob_aPCPurposeListItemTitleTextColorDark":"Mobile preference center purpose list item title text color (dark theme)","mob_aBannerLogoShow":"Mobile banner show/hide logo","ott_aBannerButtonFocusColor":"OTT banner button focus color","ott_aBannerLogoUrl":"OTT banner logo URL","mob_aBannerBGColorDark":"Mobile banner background color (dark theme)","ott_aPCPolicyLinkText":"OTT preference center policy link text","mob_aBannerButtonTextColor":"Mobile banner button text color","ott_aOverrideTemplateStylings":"OTT override template stylings","ott_aBannerPolicyLinkTextColor":"OTT banner policy link text color","ott_aBannerLinksTextColor":"OTT banner links text color","mob_aBannerLogoUrl":"Mobile banner logo URL","mob_aBannerManagePrefColorDark":"Mobile banner manage preferences button color (dark theme)","ott_aPCMenuFocusTextColor":"OTT preference center menu focus text color","mob_aOverrideTemplateStyling":"Mobile override template styling","mob_aPCToggleTrackInActiveColorDark":"Mobile preference center tracking toggle inactive color (dark theme)","ott_BannerButtonBorderShow":"OTT banner show/hide button border","mob_aBannerPolicyLinkQRCodeUrl":"Mobile banner policy link QR code URL","mob_aPCToggleActiveColor":"Mobile preference center toggle active color","mob_aPCenterVendorListLinkText":"Mobile preference center vendor list link text","ott_aBannerTextColor":"OTT banner text color","ott_aBannerPolicyLinkUrl":"OTT banner policy link URL","mob_aPCPolicyLinkText":"Mobile preference center policy link text","mob_aBannerVendorListText":"Mobile banner vendor list text","mob_aPCAcceptRejectColorDark":"Mobile preference center accept/reject button color (dark theme)","mob_aPCPolicyLinkUrl":"Mobile preference center policy link URL","ott_aPCPolicyLinkQRCodeUrl":"OTT preference center policy link QR code URL","ott_aPCMenuActiveColor":"OTT preference center active menu color","ott_aBannerBackgroundColor":"OTT banner background color","mob_aBannerButtonColor":"Mobile banner button color","mob_aBannerImprintLinkURL":"Mobile banner imprint link URL","mob_aPCTextColorDark":"Mobile preference center text color (dark theme)","mob_aBannerPolicyLinkTextColor":"Mobile banner policy link text color","mob_aPCContinueWithoutAcceptLinkColor":"Mobile preference center 'continue without accepting' link color"}},"value":{"description":"Attribute value","type":"object","example":"#000000"},"type":{"description":"Attribute type","type":"string","example":"STRING","enum":["STRING","LONG","BOOLEAN","UUID"]}}},"ApplicationScanResponsePublicDto":{"type":"object","properties":{"scanId":{"description":"Identifier of the created Application Scan","type":"string","format":"uuid","example":"123e4567-e89b-12d3-a456-426614174000"}}},"ScanWebsiteRequest":{"type":"object","properties":{"domain":{"description":"The website domain being managed.","type":"string","example":"amazon.com","maxLength":255,"minLength":1},"numberOfPages":{"description":"The total number of web pages found during scanning.","type":"integer","format":"int32","example":100,"default":"1000"},"independentPaths":{"description":"The unique URL paths discovered during the scanning process.","type":"boolean","example":false,"default":"false"},"includedQueryParams":{"description":"The query parameters that are included in the scan.","type":"string","example":"_vercel_share=Hcj4MQ8SLN8pxXPrw7wbrCfxXBuZnPa6","maxLength":1000,"minLength":1},"siteMapsUris":{"description":"The URLs of sitemaps used for the scanning process.","type":"string","example":"https://preprod.johnniewalker.com/sitemap.xml ","maxLength":3000,"minLength":0},"geoLocation":{"description":"The geographic location settings for the scan.","type":"string","example":"northeurope","maxLength":100,"minLength":1},"limitScanToSitemap":{"description":"This flag indicates whether to restrict scanning to sitemap URLs only.","type":"boolean","example":false,"default":"false"},"googleLoginState":{"description":"The login state for Google-authenticated scanning.","type":"boolean","example":false,"default":"false"},"captureDelayedCookies":{"description":"This flag indicates whether to capture cookies that load after the initial page load.","type":"boolean","example":true,"default":"false"},"delayTimeInSeconds":{"description":"The time duration in seconds to wait before capturing delayed cookies.","type":"integer","format":"int32","example":3,"default":"1"},"targetPageInputs":{"description":"The input parameters for specific pages to be scanned.","type":"array","items":{"$ref":"#/components/schemas/TargetPagesScanEntityDto"},"example":[{"pageListName":"page list 1","targetType":"Target","urlType":"Page","pageUrls":"https://service.braun.com/hr/en/products/6032"}],"maxItems":1000,"minItems":0}},"required":["numberOfPages"]},"TargetPagesScanEntityDto":{"type":"object","properties":{"pageListName":{"description":"The name of the page list configuration.","type":"string","example":"page list 1","maxLength":255,"minLength":1},"targetType":{"description":"The type of target being scanned.","type":"string","example":"Target","enum":["IncludeOnly","Exclude","Target"],"maxLength":50,"minLength":1},"urlType":{"description":"The category or type of URL.","type":"string","example":"Page","enum":["Page","Path","Subdomain"],"maxLength":50,"minLength":1},"pageUrls":{"description":"The list of specific page URLs to be scanned.","type":"string","example":"https://service.braun.com/hr/en/products/6032","maxLength":5000,"minLength":1}}},"ServiceResponseDto":{"type":"object","properties":{"message":{"description":"The message or notification text.","type":"string","example":"Scan initiated successfully.","maxLength":500,"minLength":1},"consentPolicyId":{"description":"The unique identifier of the consent policy.","type":"string","example":"f2229953-b4b5-4042-8cb9-b78038cc4c46","maxLength":100,"minLength":1},"domainId":{"description":"The unique identifier of the domain.","type":"string","format":"uuid","example":"f2229953-b4b5-4042-8cb9-b78038cc4c46"},"scanId":{"description":"The unique identifier of the scan.","type":"string","format":"uuid","example":"f2229953-b4b5-4042-8cb9-b78038cc4c46"},"scanType":{"description":"The type or method of scanning being performed.","type":"integer","format":"int32","example":1},"ok":{"description":"This flag indicates whether the operation was successful.","type":"boolean"},"rescan":{"description":"This flag indicates whether to perform the scan operation again.","type":"boolean"}}},"ScanStatusResponse":{"type":"object","properties":{"scanId":{"description":"The unique identifier of the scan.","type":"string","format":"uuid","example":"f2229953-b4b5-4042-8cb9-b78038cc4c46"},"status":{"description":"The current state or condition of the item.","type":"string","example":"INPROGRESS","enum":["QUEUED","PENDING","INPROGRESS","MIGRATION_STARTED","MIGRATION_COMPLETED","CATEGORIZATION_STARTED","CATEGORIZATION_FAILED","COMPLETED","ERROR","CANCELLED","SCANNING","DATA_MOVE","RETRY_BY_AUTO_CORRECT","MS_IOS_SCAN_SUCCESS","MS_IOS_SCAN_FAILED","MS_EXPORT_XLS_STARTED","MS_EXPORT_PDF_STARTED","SCHEDULED"]},"message":{"description":"The message or notification text.","type":"string","example":"Scan status found","maxLength":500,"minLength":1}}},"CookieFilters":{"type":"object","properties":{"status":{"description":"The current state or condition of the item.","type":"array","items":{"type":"string","enum":["NEW","REVIEWED","NOT_FOUND","DELETED","REVIEWED_NOT_FOUND","ARCHIVED"]}},"source":{"description":"The source from which the data or cookie originated.","type":"array","items":{"type":"string","enum":["SCAN","MANUAL","EXTERNALSCANNER","MANUALBULK","TELEMETRYSCANNER"]}},"lifespan":{"description":"The duration for which the cookie remains active before expiring.","type":"array","items":{"type":"string","enum":["SESSION","PERSISTENT"]}},"categories":{"description":"The cookie categories assigned to the item.","type":"array","items":{"type":"string","format":"uuid"}},"domainCategoryOverrides":{"description":"The custom category assignments that override the default settings.","type":"array","items":{"type":"string","format":"uuid"}},"domains":{"description":"The list of website domains.","type":"array","items":{"type":"string","format":"uuid"}}}},"CookieResponseDto":{"type":"object","properties":{"cookieId":{"description":"The unique identifier of the cookie.","type":"string","format":"uuid","example":"f2229953-b4b5-4042-8cb9-b78038cc4c46"},"cookieName":{"description":"The name of the cookie.","type":"string","example":"cookie123","maxLength":255,"minLength":1},"description":{"description":"The description of the cookie and its intended purpose.","type":"string","example":"This cookies is used for functional purposes","maxLength":1000,"minLength":1},"lifespan":{"description":"The duration for which the cookie remains active before expiring.","type":"string","example":"PERSISTENT","enum":["SESSION","PERSISTENT"]},"host":{"description":"The domain or website that created the cookie.","type":"string","example":"amazon.com","maxLength":255,"minLength":1},"displayGroupId":{"description":"The unique identifier of the display group.","type":"string","format":"uuid","example":"f2229953-b4b5-4042-8cb9-b78038cc4c46"},"displayGroupName":{"description":"The name of the display group.","type":"string","example":"displayGroup1","maxLength":255,"minLength":1},"cookieSource":{"description":"The source from which the cookie originated.","type":"string","example":"MANUAL","enum":["SCAN","MANUAL","EXTERNALSCANNER","MANUALBULK","TELEMETRYSCANNER"]},"domains":{"description":"The list of website domains.","type":"array","items":{"type":"string"}},"domainCookieCategoryList":{"description":"The list of categories assigned to cookies for the specific domain.","type":"array","items":{"$ref":"#/components/schemas/DomainCookieCategoryEntityDto"}},"length":{"description":"Cookie length. In combination with durationType it can be 5 weeks (length = 5 and durationType = WEEK)","type":"integer","format":"int32","example":5},"durationType":{"description":"The type of duration indicating whether the cookie is session-based or persistent.","type":"string","example":"MONTH","enum":["DAY","WEEK","MONTH","YEAR"]},"categoryOverrides":{"description":"The custom category assignments.","type":"array","items":{"type":"string"}},"licenseType":{"description":"The type of software license.","type":"integer","format":"int64","example":50},"isCustomDesc":{"description":"This flag indicates whether a custom description is being used.","type":"boolean","example":true},"thirdParty":{"description":"This flag indicates whether the cookie originates from a third-party source.","type":"boolean","example":true},"thirdPartyDescription":{"description":"The description of third-party cookies and their usage.","type":"string","example":"This cookie is used for third-party advertising","maxLength":1000,"minLength":1},"isThirdPartyCustomDesc":{"description":"This flag indicates whether a custom third-party description is being used.","type":"boolean","example":true}}},"DomainCookieCategoryEntityDto":{"type":"object","properties":{"domainId":{"description":"The unique identifier of the domain.","type":"string","format":"uuid","example":"f2229953-b4b5-4042-8cb9-b78038cc4c46"},"displayGroupId":{"description":"The unique identifier of the display group.","type":"string","format":"uuid","example":"f2229953-b4b5-4042-8cb9-b78038cc4c46"},"thirdParty":{"description":"This flag indicates whether the cookie originates from a third-party source.","type":"boolean","example":false},"description":{"description":"The description of the cookie and its intended purpose.","type":"string","example":"used for advertising"},"vendorServiceId":{"description":"Vendor service GUID to link this cookie instance","type":"string","format":"uuid","example":"f2229953-b4b5-4042-8cb9-b78038cc4c46"}}},"PageCookieResponseDto":{"type":"object","properties":{"totalPages":{"description":"The total number of pages in the paginated results.","type":"integer","format":"int32"},"totalElements":{"description":"The total number of items in the complete result set.","type":"integer","format":"int64"},"size":{"description":"The number of items to return per page.","type":"integer","format":"int32"},"content":{"description":"The main content or data payload of the response.","items":{"$ref":"#/components/schemas/CookieResponseDto"},"type":"array"},"number":{"description":"The numeric value or identifier.","type":"integer","format":"int32"},"sort":{"description":"The sorting configuration applied to the results.","$ref":"#/components/schemas/SortObject"},"pageable":{"description":"The pagination configuration settings.","$ref":"#/components/schemas/PageableObject"},"first":{"description":"This flag indicates whether this is the first item in a sequence.","type":"boolean"},"last":{"description":"This flag indicates whether this is the last item in a sequence.","type":"boolean"},"numberOfElements":{"description":"The number of items in the current page.","type":"integer","format":"int32"},"empty":{"description":"This flag indicates whether the result set is empty.","type":"boolean"}}},"PageableObject":{"type":"object","properties":{"offset":{"description":"The starting position for paginated results.","type":"integer","format":"int64"},"sort":{"description":"The sorting configuration applied to the results.","$ref":"#/components/schemas/SortObject"},"paged":{"description":"This flag indicates whether pagination is enabled.","type":"boolean"},"pageSize":{"description":"The number of items displayed per page.","type":"integer","format":"int32"},"pageNumber":{"description":"The current page number in the pagination sequence.","type":"integer","format":"int32"},"unpaged":{"description":"This flag indicates whether pagination is disabled.","type":"boolean"}}},"SortObject":{"type":"object","properties":{"empty":{"description":"This flag indicates whether the result set is empty.","type":"boolean"},"sorted":{"description":"This flag indicates whether the results are sorted.","type":"boolean"},"unsorted":{"description":"This flag indicates whether the results are in unsorted order.","type":"boolean"}}},"DomainScheduleRequest":{"type":"object","properties":{"domainId":{"description":"The unique identifier of the domain.","type":"string","format":"uuid","example":"f2229953-b4b5-4042-8cb9-b78038cc4c46"},"emailRecipient":{"description":"The email address that will receive notifications.","type":"string","example":"user1@gmail.com,user2@gmail.com","maxLength":300,"minLength":0},"nextScanDate":{"description":"The date and time when the next scan is scheduled.","type":"string","format":"date-time","example":"2025-04-25T10:15:30"},"intervalType":{"description":"The frequency unit for recurring scans.","type":"string","example":"MONTH","enum":["MONTH"]},"timeInterval":{"description":"The frequency at which recurring scans are performed.","type":"integer","format":"int32","example":2,"maximum":12,"minimum":1},"geoLocation":{"description":"The geographic location settings for the scan.","type":"string","example":"eastus","enum":["northeurope","eastus"]}},"required":["domainId","geoLocation","intervalType","timeInterval"]},"CookieCreationRequestDto":{"type":"object","properties":{"cookieName":{"description":"The name of the cookie.","type":"string","example":"cookieName123","maxLength":255,"minLength":1},"lifespan":{"description":"The duration for which the cookie remains active before expiring.","type":"string","example":"SESSION","enum":["SESSION","PERSISTENT"]},"host":{"description":"The domain or website that created the cookie.","type":"string","example":"amazon.com","maxLength":255,"minLength":1},"description":{"description":"The description of the cookie and its intended purpose.","type":"string","example":"This cookie is used for advertising purposes.","maxLength":1000,"minLength":1},"thirdPartyDescription":{"description":"The description of third-party cookies and their usage.","type":"string","example":"This cookie is used for advertising purposes.","maxLength":1000,"minLength":1},"length":{"description":"Length of the Cookie lifespan, enter a number greater than 0 if this is a PERSISTENT cookie, otherwise leave as 0","type":"integer","format":"int32","example":5,"default":"0"},"durationType":{"description":"The type of duration indicating whether the cookie is session-based or persistent.","type":"integer","format":"int32","example":"1, 7 ,30, 365","default":"1"},"cookieId":{"description":"The unique identifier of the cookie.","type":"string","format":"uuid","example":"f2229953-b4b5-4042-8cb9-b78038cc4c46"},"customCategoryName":{"description":"The custom name assigned to the cookie category.","type":"string","example":"C0001","maxLength":100,"minLength":1},"domainCookieCategoryList":{"description":"The list of categories assigned to cookies for the specific domain.","type":"array","items":{"$ref":"#/components/schemas/DomainCookieCategoryRequestDto"},"example":[{"domainId":"f2229953-b4b5-4042-8cb9-b78038cc4c46","customCategoryName":"C0000","thirdParty":true,"description":"this cookies is used for targeting purposes only"}],"maxItems":1000,"minItems":0}},"required":["customCategoryName","durationType","lifespan"]},"CookieEntityDto":{"type":"object","properties":{"id":{"description":"The unique identifier of the item.","type":"string","format":"uuid","example":"123e4567-e89b-12d3-a456-426614174000"},"name":{"description":"The name or title of the item.","type":"string","example":"CookieName123__"},"description":{"description":"The description of the cookie and its intended purpose.","type":"string","example":"This cookie is used for advertising purposes."},"thirdPartyDescription":{"description":"The description of third-party cookies and their usage.","type":"string","example":"This cookie is used for advertising purposes."},"host":{"description":"The domain or website that created the cookie.","type":"string","example":"amazon.com"},"path":{"description":"The URL path where the cookie is active.","type":"string","example":"/"},"source":{"description":"The source from which the data or cookie originated.","type":"string","example":"MANUAL/SCAN","enum":["SCAN","MANUAL","EXTERNALSCANNER","MANUALBULK","TELEMETRYSCANNER"]},"cookieLifeSpan":{"description":"The duration for which the cookie remains valid.","type":"string","example":"SESSION","enum":["SESSION","PERSISTENT"]},"httpOnly":{"description":"This flag indicates whether the cookie can only be accessed via HTTP requests.","type":"boolean","example":true},"secure":{"description":"This flag indicates whether the cookie requires a secure HTTPS connection.","type":"boolean","example":true},"length":{"description":"Length of the Cookie lifespan. This is used in combination with 'durationType'. If 'length' = 5 and 'durationType' = 7, that means 5 weeks.","type":"integer","format":"int32","example":5},"durationType":{"description":"The type of duration indicating whether the cookie is session-based or persistent.","type":"integer","format":"int32","example":7}}},"EntityActionResponseDtoCookieEntityDto":{"type":"object","properties":{"entityId":{"description":"The unique identifier of the entity.","type":"string","format":"uuid","example":"f2229953-b4b5-4042-8cb9-b78038cc4c46"},"entityType":{"description":"The type of entity such as cookie, tag, page, form, service, or storage.","type":"string","example":"SCAN","enum":["SCAN","DOMAIN","COOKIE"]},"action":{"description":"The action that was performed or is to be performed.","type":"string","example":"ARCHIVE","enum":["ARCHIVE","SCHEDULE","SCHEDULE_CANCEL","EDIT","CREATE","DELETE"]},"message":{"description":"The message or notification text.","type":"string","example":"Scan queued for archival","maxLength":500,"minLength":1},"content":{"$ref":"#/components/schemas/CookieEntityDto","description":"The main content or data payload of the response."},"success":{"description":"This flag indicates whether the operation completed successfully.","type":"boolean"}}},"DomainGroupRequestDto":{"type":"object","properties":{"removeExisting":{"description":"This flag indicates whether to remove existing configurations before applying new ones.","type":"boolean","example":false},"urls":{"description":"The list of URLs to be processed or managed.","type":"array","items":{"type":"string"},"example":["example.com","test.com","onetrust.com"],"maxItems":1000,"minItems":0}},"title":"DomainGroupRequestDto"},"CategorizedCookiesRequestDto":{"type":"object","properties":{"domain":{"description":"The website domain being managed.","type":"string","example":"amazon.com","maxLength":255,"minLength":1},"cookieIds":{"description":"The list of cookie identifiers.","type":"array","items":{"type":"string","format":"uuid"},"example":["f2229953-b4b5-4042-8cb9-b78038cc4c46","a1b2c3d4-e5f6-7890-abcd-ef1234567890"],"maxItems":1000,"minItems":0},"cookies":{"description":"The list of cookie objects containing detailed information about each cookie.","type":"array","items":{"$ref":"#/components/schemas/CookieRequestDto"},"example":[{"cookieName":"session_id","host":"example.com"},{"cookieName":"user_token","host":"test.com"}],"maxItems":1000,"minItems":0}}},"CookieRequestDto":{"type":"object","properties":{"name":{"description":"The name of the cookie.","type":"string","example":"cookie123","minLength":1},"host":{"description":"The domain or website that created the cookie.","type":"string","example":"amazon.com","minLength":1}}},"CookiepediaContribsDto":{"type":"object","properties":{"name":{"description":"The name of the item.","type":"string","example":"cookie123","maxLength":255,"minLength":1},"type":{"description":"The type or category classification of the item.","type":"string","example":"First Party","maxLength":50,"minLength":1},"host":{"description":"The domain or website that created the cookie.","type":"string","example":"amazon.com","maxLength":255,"minLength":1},"hostDescription":{"description":"The description of the host domain.","type":"string","example":"amazon.com is a website","maxLength":1000,"minLength":1},"description":{"description":"The description of the item and its intended purpose.","type":"string","example":"This cookie is used for advertising purposes.","maxLength":1000,"minLength":1},"firstPartyDescription":{"description":"The description of first-party cookies and their usage.","type":"string","example":"This cookie is used for advertising purposes.","maxLength":1000,"minLength":1},"thirdPartyDescription":{"description":"The description of third-party cookies and their usage.","type":"string","example":"This cookie is used for advertising purposes.","maxLength":1000,"minLength":1},"patternKey":{"description":"The pattern key used for cookie identification and matching.","type":"string","example":"C1_","maxLength":255,"minLength":1},"thirdPartyKey":{"description":"The key identifier used for third-party cookie classification.","type":"string","example":"Cookie|cookie123","maxLength":500,"minLength":1},"firstPartyKey":{"description":"The key identifier used for first-party cookie classification.","type":"string","example":"Cookie|cookie123|amazon.com","maxLength":500,"minLength":1},"category":{"description":"The category assigned to the cookie for classification purposes.","type":"string","example":"Functionality","maxLength":255,"minLength":1},"domainCount":{"description":"No of domains where this cookie is active.","type":"integer","format":"int32","example":"0, 1, 2, ..."}}},"ApplicationRequestPublicDto":{"type":"object","properties":{"name":{"description":"Application Name","type":"string","example":"My Application","maxLength":255,"minLength":1},"solutionType":{"description":"The type of solution implemented by this Application","type":"string","example":"ONETRUST_SDK","enum":["API","ONETRUST_SDK"]},"platform":{"description":"Platform of this Application","type":"string","enum":["IOS","ANDROID","APPLETV","ANDROIDTV","FIRETV","ROKU","SAMSUNGTV","LGTV","VIZIOTV","HBBTV","PANASONICTV","PS5","YOUVIEW"]},"orgId":{"description":"Organization ID","type":"string","example":"org-123","maxLength":255,"minLength":1}}},"ApplicationEntityPublicDto":{"type":"object","properties":{"applicationId":{"description":"Application ID","type":"string","format":"uuid","example":"123e4567-e89b-12d3-a456-426614174000"},"name":{"description":"Application Name","type":"string","example":"My Application","maxLength":255,"minLength":1},"platform":{"description":"Application Platform","type":"string","example":"ANDROID","enum":["ANDROID","IOS"],"maxLength":50,"minLength":1},"fileType":{"description":"File Type","type":"string","example":"apk","enum":["apk","ipa","aab"],"maxLength":10,"minLength":3},"scanId":{"description":"The unique identifier of the scan.","type":"string","format":"uuid","example":"123e4567-e89b-12d3-a456-426614174000"}}},"ExposedScanWebsitePageResponseDto":{"type":"object","properties":{"content":{"description":"The main content or data payload of the response.","example":[{"domainName":"amazon.com","domainId":"f2229953-b4b5-4042-8cb9-b78038cc4c46","status":"SCANNING","lastScannedDate":"2025-04-01T12:34:32Z","lastScannedTotalCookies":15,"uniqueCookiesFound":10,"lastScannedTotalPages":400,"maxPagesScanned":123,"scheduledDateOfNextScan":"2025-04-01T12:34:32Z","consentPolicyName":"as_georules","scanError":"ABRUPT_SCAN_TERMINATION","orgName":"org name","externalOrgId":"orgnameid","overPageLimit":true}],"items":{"$ref":"#/components/schemas/ExposedWebsiteDetailsDto"},"maxItems":2000,"minItems":0,"type":"array"},"totalElements":{"description":"The total number of items in the complete result set.","type":"integer","format":"int64","example":344},"totalPages":{"description":"The total number of pages in the paginated results.","type":"integer","format":"int32","example":35},"pageSize":{"description":"The number of items displayed per page.","type":"integer","format":"int32","example":10},"pageNumber":{"description":"The current page number in the pagination sequence.","type":"integer","format":"int32","example":3},"sort":{"description":"The sorting configuration applied to the results.","$ref":"#/components/schemas/SortObject"},"numberOfElements":{"description":"The number of items in the current page.","type":"integer","format":"int32","example":115}}},"ExposedWebsiteDetailsDto":{"type":"object","properties":{"domainName":{"description":"The name of the website domain.","type":"string","example":"amazon.com","maxLength":255,"minLength":1},"domainId":{"description":"The unique identifier of the domain.","type":"string","format":"uuid","example":"f2229953-b4b5-4042-8cb9-b78038cc4c46"},"status":{"description":"The current state or condition of the item.","type":"string","example":"SCANNING","maxLength":50,"minLength":1},"lastScannedDate":{"description":"The date and time when the domain was last scanned for cookies.","type":"string","format":"date-time","example":"2025-04-01T12:34:32Z"},"lastScannedTotalCookies":{"description":"The total number of cookies found during the last scan.","type":"integer","format":"int32","example":15},"uniqueCookiesFound":{"description":"The number of unique cookies discovered during scanning.","type":"integer","format":"int32","example":10},"lastScannedTotalPages":{"description":"The total number of pages scanned during the last scan.","type":"integer","format":"int32","example":400},"maxPagesScanned":{"description":"The maximum number of pages that can be scanned.","type":"integer","format":"int32","example":123},"scheduledDateOfNextScan":{"description":"The date and time when the next scan is scheduled to run.","type":"string","format":"date-time","example":"2025-04-01T12:34:32Z"},"consentPolicyName":{"description":"The name of the consent policy that is applied.","type":"string","example":"as_georules","maxLength":255,"minLength":1},"scanError":{"description":"The error message if the scan operation failed.","type":"string","example":"ABRUPT_SCAN_TERMINATION","maxLength":500,"minLength":1},"orgName":{"description":"The name of the organization.","type":"string","example":"org name","maxLength":255,"minLength":1},"externalOrgId":{"description":"The external organization identifier.","type":"string","example":"orgnameid","maxLength":255,"minLength":1},"overPageLimit":{"description":"This flag indicates whether the scan exceeded the maximum page limit.","type":"boolean","example":true}}},"PageScanInformationResponse":{"type":"object","properties":{"totalPages":{"description":"The total number of pages in the paginated results.","type":"integer","format":"int32"},"totalElements":{"description":"The total number of items in the complete result set.","type":"integer","format":"int64"},"size":{"description":"The number of items to return per page.","type":"integer","format":"int32"},"content":{"description":"The main content or data payload of the response.","items":{"$ref":"#/components/schemas/ScanInformationResponse"},"type":"array"},"number":{"description":"The numeric value or identifier.","type":"integer","format":"int32"},"sort":{"description":"The sorting configuration applied to the results.","$ref":"#/components/schemas/SortObject"},"pageable":{"description":"The pagination configuration settings.","$ref":"#/components/schemas/PageableObject"},"first":{"description":"This flag indicates whether this is the first item in a sequence.","type":"boolean"},"last":{"description":"This flag indicates whether this is the last item in a sequence.","type":"boolean"},"numberOfElements":{"description":"The number of items in the current page.","type":"integer","format":"int32"},"empty":{"description":"This flag indicates whether the result set is empty.","type":"boolean"}}},"ScanInformationResponse":{"type":"object","properties":{"scanId":{"description":"The unique identifier of the scan.","type":"string","format":"uuid","example":"f2229953-b4b5-4042-8cb9-b78038cc4c46"},"domainId":{"description":"The unique identifier of the domain.","type":"string","format":"uuid","example":"f2229953-b4b5-4042-8cb9-b78038cc4c46"},"startingUrl":{"description":"The initial URL where the scanning process begins.","type":"string","example":"amazon.com","maxLength":500,"minLength":1},"sequence":{"description":"The order or position in a sequential series.","type":"integer","format":"int32","example":3},"crawlStartDt":{"description":"The date and time when the crawling process started.","type":"string","format":"date-time","example":"2025-04-01T12:34:32Z"},"crawlEndDt":{"description":"The date and time when the crawling process ended.","type":"string","format":"date-time","example":"2025-04-01T12:34:32Z"},"usedQueryParameters":{"description":"The query parameters that were used during the scanning process.","type":"string","example":"language=en,region=on","maxLength":1000,"minLength":1},"scanPageLimit":{"description":"The maximum number of pages allowed per scan operation.","type":"integer","format":"int32","example":1000},"pagesScanned":{"description":"The number of pages that were actually scanned.","type":"integer","format":"int32","example":155},"errorDescription":{"description":"The description of any error that occurred.","type":"string","example":"ABRUPT_SCAN_TERMINATION","maxLength":500,"minLength":1},"cookieNotice":{"description":"The notice or information about cookie usage.","type":"boolean","example":true},"retryCount":{"description":"The number of times the operation was retried.","type":"integer","format":"int32","example":0},"totalPagesFound":{"description":"The total number of pages discovered during scanning.","type":"integer","format":"int32","example":255},"cookiesFound":{"description":"The number of cookies discovered during scanning.","type":"integer","format":"int32","example":132},"geoLocation":{"description":"The geographic location settings for the scan.","type":"string","example":"northeurope","maxLength":100,"minLength":1},"limitScanToSitemap":{"description":"This flag indicates whether to restrict scanning to sitemap URLs only.","type":"boolean","example":false},"status":{"description":"The current state or condition of the item.","type":"string","example":"INPROGRESS","enum":["QUEUED","PENDING","INPROGRESS","MIGRATION_STARTED","MIGRATION_COMPLETED","CATEGORIZATION_STARTED","CATEGORIZATION_FAILED","COMPLETED","ERROR","CANCELLED","SCANNING","DATA_MOVE","RETRY_BY_AUTO_CORRECT","MS_IOS_SCAN_SUCCESS","MS_IOS_SCAN_FAILED","MS_EXPORT_XLS_STARTED","MS_EXPORT_PDF_STARTED","SCHEDULED"]},"scanType":{"description":"The type or method of scanning being performed.","type":"string","example":"UI_SCAN","enum":["UI_SCAN","SCHEDULE_SCAN"]},"archiveStatus":{"description":"The archival state of the scan.","type":"string","example":"ARCHIVE_COMPLETED","enum":["NONE","PENDING_UI","PENDING_SCHEDULED","ARCHIVE_STARTED","ARCHIVE_COMPLETED","ARCHIVE_QUEUED","ERROR","NO_DATA_TO_EXPORT"]}}},"ScanResultSummaryDto":{"type":"object","properties":{"scannedPageUrls":{"description":"URL of all the pages scanned","type":"array","items":{"type":"string"},"example":["onetrust.com","onetrust.com/robots.txt"],"maxItems":1000,"minItems":0},"numTags":{"description":"Number of tags associated with this scan.","type":"integer","format":"int32","example":25},"numCookies":{"description":"Number of cookies associated with this scan.","type":"integer","format":"int32","example":150},"numCookiesByCategory":{"description":"Number of cookies associated with this scan, grouped by cookiepedia category.","type":"object","example":"{'Strictly Necessary': 3, 'Functional': 5, ...}","additionalProperties":{"type":"integer","format":"int64"}}}},"CookieInformationDetailed":{"type":"object","properties":{"id":{"description":"Cookie identifier","type":"string","format":"uuid","example":"f2229953-b4b5-4042-8cb9-b78038cc4c46"},"name":{"description":"Cookie name","type":"string","example":"snn_id"},"host":{"description":"Host associated with the cookie","type":"string","example":"amazon.com"},"expiryDate":{"description":"Expiry date of the cookie","type":"integer","format":"int32"},"expiryUnit":{"description":"Expiry unit of the cookie.","type":"string","example":"WEEK","enum":["DAY","WEEK","MONTH","YEAR"]},"urlDomain":{"description":"Domain url","type":"string","example":"amazon.com"},"path":{"description":"Cookie path","type":"string","example":"/"},"isSecure":{"description":"Whether cookie is secure","type":"boolean","example":true},"isHttpOnly":{"description":"Whether cookie is http only","type":"boolean","example":true},"isSession":{"description":"Whether cookie is a session cookie","type":"boolean","example":true},"isBehindLogin":{"description":"Whether cookie is behind login","type":"boolean","example":true},"hostDescription":{"description":"Host description","type":"string","example":"Amazon is a website"},"thirdPartyDescription":{"description":"Third party description","type":"string","example":"This cookie is used for advertising"},"description":{"description":"Cookie description","type":"string","example":"This cookie is used for advertising"},"purpose":{"description":"Cookie purpose","type":"string","example":"This cookie is used for advertising"},"cookiepediaCategory":{"description":"Cookie category name","type":"string","example":"Targeting"},"firstParty":{"description":"Whether cookies is first party","type":"boolean","example":true},"status":{"description":"Cookie status.","type":"string","example":"NOT_FOUND","enum":["NEW","REVIEWED","NOT_FOUND","DELETED","REVIEWED_NOT_FOUND","ARCHIVED"]},"color":{"description":"Cookie color related to the category.","type":"string","example":"red"},"isNewFound":{"description":"Whether cookie is new found from this scan.","type":"boolean","example":true},"isNewlyAdded":{"description":"Whether cookie is newly added from this scan.","type":"boolean","example":true},"categoryId":{"description":"Cookie category identifier.","type":"string","example":"C0001"}}},"PageDto":{"type":"object","properties":{"id":{"description":"Page identifier","type":"string","format":"uuid","example":"f2229953-b4b5-4042-8cb9-b78038cc4c46"},"auditUrl":{"description":"Page url","type":"string","example":"https://abcnews.go.com/"},"cookieCount":{"description":"Number of cookies found on page","type":"integer","format":"int64","example":33},"errorMessage":{"description":"Error message if something went wrong when scanning page.","type":"string","example":33},"sourceUrl":{"description":"Source url.","type":"string","example":"https://abcnews.go.com/"},"scanOrder":{"description":"Source url.","type":"integer","format":"int32","example":"https://abcnews.go.com/"},"isCookiePolicy":{"type":"number","format":"double"},"isPrivacyPolicy":{"type":"number","format":"double"},"isLoginForm":{"description":"Whether page has login form.","type":"boolean","example":false},"isBehindLogin":{"description":"Whether page is behind login.","type":"boolean","example":false},"hasVideo":{"description":"Whether the page has video content ","type":"boolean","example":false}}},"TagDto":{"type":"object","properties":{"id":{"description":"Tag identifier","type":"string","format":"uuid","example":"f2229953-b4b5-4042-8cb9-b78038cc4c46"},"host":{"description":"Tag host","type":"string","example":"abcnews.com"},"tagType":{"description":"Tag type","type":"string","example":"Script"},"src":{"description":"Tag source url","type":"string","example":"Script"},"params":{"description":"Tag parameters.","type":"string","example":"(720px 893px)"},"createdDate":{"description":"Date when the tag was created.","type":"string","format":"date-time","example":"2025-04-25T12:34:32Z"},"status":{"description":"Tag status. Can be 1 or 2 (new or not found)","type":"integer","format":"int32","example":"Script"},"age":{"description":"How many days the tag is old.","type":"integer","format":"int32","example":133},"parent":{"description":"Tag parent url.","type":"string","example":"amazon.com"},"children":{"description":"Tag child url.","type":"string","example":"amazon.com"},"firstParty":{"description":"Whether tag is first party","type":"boolean","example":true},"added":{"description":"Whether the tag was added since previous scan","type":"boolean","example":true},"removed":{"description":"Whether the tag was removed since previous scan","type":"boolean","example":false},"changeSincePreviousScan":{"description":"Changes in comparison to previous successful scan.","type":"string","example":"Added since previous scan (Feb 24, 2025 08:11 AM)"}}},"FormDataDto":{"type":"object","properties":{"fieldName":{"description":"Field name","type":"string","example":"username"},"formName":{"description":"Name of the form to which this field belongs","type":"string","example":"loginForm"},"type":{"description":"Type of data field. For example email/text/hidden.","type":"string","example":"text"},"title":{"description":"Field title","type":"string","example":"Username"},"label":{"description":"Field lable","type":"string","example":"E-mail"},"value":{"description":"Value of the field. Mostly this value is empty since the fields expect some input.","type":"string","example":"value123"},"personalData":{"type":"boolean"}}},"FormDataGroupDto":{"type":"object","properties":{"id":{"description":"Form identifier","type":"string","format":"uuid","example":"f2229953-b4b5-4042-8cb9-b78038cc4c46"},"name":{"description":"Form name","type":"string","example":"formdatagroupname"},"numberOfPagesFound":{"description":"Number of pages where this form was found","type":"integer","format":"int64","example":3},"formDataFields":{"description":"List of data field information contained in the form","type":"array","items":{"$ref":"#/components/schemas/FormDataDto"}}}},"StorageEntriesDto":{"type":"object","properties":{"host":{"description":"Storage entry host","type":"string","example":"https://abcnews.go.com"},"key":{"description":"Storage entry key","type":"string","example":"abcnews314-volume"},"value":{"description":"Storage entry value","type":"string"},"type":{"description":"Storage entry type. Can be 1 or 2 (local or session)","type":"integer","format":"int32","example":"abcnews314-volume"}}},"ServiceProviderBasicDetails":{"type":"object","properties":{"serviceName":{"description":"Service name","type":"string","example":"Adobe Marketing Cloud"},"vendor":{"description":"Vendor name","type":"string","example":"Adobe"},"category":{"description":"Category","type":"string","example":"Performance Cookies"},"description":{"description":"Service description","type":"string","example":"Adobe Marketing Cloud gives customers the most complete set of integrated digital marketing solutions available."},"location":{"description":"Address","type":"string","example":345},"privacyPolicy":{"description":"Privacy policy url","type":"string","example":"https://www.adobe.com/privacy/policy.html"},"added":{"description":"Whether the service was added since previous scan","type":"boolean","example":true},"removed":{"description":"Whether the service was removed since previous scan","type":"boolean","example":false},"changeSincePreviousScan":{"description":"Changes in comparison to previous successful scan.","type":"string","example":"Added since previous scan (Feb 24, 2025 08:11 AM)"}}},"ScanResultEntityPageResponse":{"type":"object","properties":{"content":{"description":"The main content or data payload of the response.","example":[{"cookieId":"f2229953-b4b5-4042-8cb9-b78038cc4c46","cookieName":"session_id","host":"example.com"}],"items":{"oneOf":[{"$ref":"#/components/schemas/CookieInformationDetailed"},{"$ref":"#/components/schemas/PageDto"},{"$ref":"#/components/schemas/TagDto"},{"$ref":"#/components/schemas/FormDataGroupDto"},{"$ref":"#/components/schemas/StorageEntriesDto"},{"$ref":"#/components/schemas/ServiceProviderBasicDetails"}]},"maxItems":2000,"minItems":0,"type":"array"},"scanId":{"description":"Scan ID","type":"string","format":"uuid","example":"123e4567-e89b-12d3-a456-426614174000"},"domainId":{"description":"The unique identifier of the domain.","type":"string","format":"uuid","example":"123e4567-e89b-12d3-a456-426614174000"},"totalElements":{"description":"The total number of items in the complete result set.","type":"integer","format":"int64","example":100},"totalPages":{"description":"The total number of pages in the paginated results.","type":"integer","format":"int32","example":99},"pageSize":{"description":"The number of items displayed per page.","type":"integer","format":"int32","example":5},"pageNumber":{"description":"The current page number in the pagination sequence.","type":"integer","format":"int32","example":1},"numberOfElements":{"description":"The number of items in the current page.","type":"integer","format":"int32","example":5}}},"CookieInformation":{"type":"object","properties":{"id":{"description":"The unique identifier of the item.","type":"string","format":"uuid","example":"f2229953-b4b5-4042-8cb9-b78038cc4c46"},"name":{"description":"The name or title of the item.","type":"string","example":"snn_id","maxLength":255,"minLength":1},"host":{"description":"The domain or website that created the cookie.","type":"string","example":"amazon.com","maxLength":255,"minLength":1},"expiryDate":{"description":"The date and time when the cookie expires.","type":"integer","format":"int32","example":30},"expiryUnit":{"description":"The time unit used for cookie expiration.","type":"integer","format":"int32","example":7},"urlDomain":{"description":"The domain portion extracted from a URL.","type":"string","example":"domain.com","maxLength":255,"minLength":1},"path":{"description":"The URL path where the cookie is active.","type":"string","example":"/","maxLength":500,"minLength":1},"isSecure":{"description":"This flag indicates whether the cookie requires HTTPS.","type":"boolean","example":true},"isHttpOnly":{"description":"This flag indicates whether the cookie is accessible only via HTTP.","type":"boolean","example":true},"isSession":{"description":"This flag indicates whether the cookie is a session cookie.","type":"boolean","example":true},"isBehindLogin":{"description":"This flag indicates whether the cookie is found behind authentication.","type":"boolean","example":true},"hostDescription":{"description":"The description of the host domain.","type":"string","example":"domain.com is a website","maxLength":1000,"minLength":1},"thirdPartyDescription":{"description":"The description of third-party cookies and their usage.","type":"string","example":"This cookie is used for advertising purposes","maxLength":1000,"minLength":1},"description":{"description":"The description of the cookie and its intended purpose.","type":"string","example":"This cookie is used for advertising purposes","maxLength":1000,"minLength":1},"purpose":{"description":"The intended use or function of the cookie.","type":"string","example":"This cookie is used for advertising purposes","maxLength":1000,"minLength":1},"cookiepediaCategory":{"description":"The category assigned by Cookiepedia classification system.","type":"string","example":"Functionality","maxLength":255,"minLength":1},"firstParty":{"description":"This flag indicates whether the cookie is set by the visited website.","type":"boolean","example":true},"status":{"description":"The current state or condition of the item.","type":"integer","format":"int32","example":1,"enum":["1","2","3","4","5"]},"color":{"description":"The color code used for visual identification.","type":"string","example":"red","maxLength":50,"minLength":1},"isNewFound":{"description":"This flag indicates whether the cookie was newly discovered.","type":"boolean","example":true},"isNewlyAdded":{"description":"This flag indicates whether the item was recently added.","type":"boolean","example":true},"categoryId":{"description":"The unique identifier of the category.","type":"string","example":"C0001","maxLength":100,"minLength":1},"customCategoryId":{"description":"Custom category Id for cookie","type":"string","format":"uuid","example":"f2229953-b4b5-4042-8cb9-b78038cc4c46"}}},"ScanDeltaDetails":{"type":"object","properties":{"addedCookies":{"description":"The cookies that were newly added.","type":"array","items":{"$ref":"#/components/schemas/CookieInformation"},"example":[{"cookieId":"f2229953-b4b5-4042-8cb9-b78038cc4c46","cookieName":"session_id","host":"example.com"}],"maxItems":1000,"minItems":0},"removedCookies":{"description":"The cookies that were removed or deleted.","type":"array","items":{"$ref":"#/components/schemas/CookieInformation"},"example":[{"cookieId":"a1b2c3d4-e5f6-7890-abcd-ef1234567890","cookieName":"old_cookie","host":"test.com"}],"maxItems":1000,"minItems":0},"scanDeltaMetadata":{"description":"The metadata information about changes between scans.","$ref":"#/components/schemas/ScanDeltaMetadataDto"}}},"ScanDeltaMetadataDto":{"type":"object","properties":{"id":{"description":"The unique identifier of the item.","type":"string","format":"uuid","example":"f2229953-b4b5-4042-8cb9-b78038cc4c46"},"sourceScanId":{"description":"The unique identifier of the original scan.","type":"string","format":"uuid","example":"f2229953-b4b5-4042-8cb9-b78038cc4c46"},"targetScanId":{"description":"The unique identifier of the comparison scan.","type":"string","format":"uuid","example":"f2229953-b4b5-4042-8cb9-b78038cc4c46"},"targetScanDate":{"description":"The date and time when the comparison scan was performed.","type":"string","format":"date-time","example":"2025-04-25T10:15:30Z"},"targetScanDeleted":{"description":"This flag indicates whether the comparison scan was deleted.","type":"boolean"}}},"PageTemplateDto":{"type":"object","properties":{"totalPages":{"type":"integer","format":"int32"},"totalElements":{"type":"integer","format":"int64"},"size":{"type":"integer","format":"int32"},"content":{"items":{"$ref":"#/components/schemas/TemplateDto"},"type":"array"},"number":{"type":"integer","format":"int32"},"sort":{"$ref":"#/components/schemas/SortObject"},"pageable":{"$ref":"#/components/schemas/PageableObject"},"first":{"type":"boolean"},"last":{"type":"boolean"},"numberOfElements":{"type":"integer","format":"int32"},"empty":{"type":"boolean"}}},"TemplateDto":{"type":"object","properties":{"id":{"description":"UUID of the template","type":"string","format":"uuid","example":"f2229953-b4b5-4042-8cb9-b78038cc4c46"},"currentVersion":{"description":"The current version number of the template","type":"integer","format":"int32","example":12},"templateName":{"description":"Name of the template","type":"string","example":"my-template-2026","maxLength":255,"minLength":1},"templateType":{"description":"The category of the template","type":"string","example":"GDPR","enum":["GDPR","IAB","CCPA","IAB2","GENERIC","LGPD","GENERIC_PROMPT","CPRA","CDPA","USNATIONAL","COLORADO","CTDPA","UCPA","QUEBEC","IABC","IAB2V2","OCPA","MODPA","VCDPA","UKGDPR","IND_DPDPA","CUSTOM"]},"status":{"description":"The template's status, published if status is ACTIVATED","type":"string","example":"DRAFTED","enum":["DRAFTED","ACTIVATED"]},"isDefault":{"description":"Indicates if the template is the default template","type":"boolean","example":false},"isUniversalDefault":{"description":"Indicates if the template is the universal default template","type":"boolean","example":false},"isOrgDefault":{"description":"Indicates if the template is the default template for the organization","type":"boolean","example":false},"orgDefaultEnabled":{"description":"Indicates if the organization default is enabled","type":"boolean","example":false},"orgId":{"description":"Organization ID","type":"string","example":"org-123","maxLength":255,"minLength":1},"orgName":{"description":"Organization name","type":"string","example":"OneTrust","maxLength":255,"minLength":1},"languages":{"description":"List of enabled language codes for this template","type":"array","items":{"type":"string"},"example":["en","fr-CA","es"]}}},"AttributeDto":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"value":{"type":"object"},"audit":{"description":"Indicates if this attribute should be audited","type":"boolean","example":true},"translatable":{"description":"Indicates if this attribute is translatable","type":"boolean","example":false},"type":{"type":"string","enum":["STRING","LONG","BOOLEAN","UUID"]},"customized":{"description":"Indicates if this attribute is customized","type":"boolean","example":false}}},"BrandingAttributeDTO":{"type":"object","properties":{"id":{"description":"Attribute ID","type":"string","format":"uuid","example":"f2229953-b4b5-4042-8cb9-b78038cc4c46"},"name":{"description":"Attribute name","type":"string","example":"dBannerButtonColor","maxLength":255,"minLength":1},"value":{"description":"Attribute value","type":"object","example":"#000000"},"type":{"description":"Attribute type","type":"string","example":"STRING","enum":["STRING","LONG","BOOLEAN","UUID"]},"important":{"description":"Attribute is important","type":"boolean","example":false}}},"DisplayGroupEntityDto":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"description":"Name of the display group.","type":"string","example":"Strictly Necessary Cookies","maxLength":255,"minLength":1},"type":{"description":"Type of the display group.","type":"string","example":"COOKIE","enum":["ROOT","BRANCH","COOKIE","IAB","IAB2_PURPOSE","IAB2_STACK","IAB2_FEATURE","IAB2_SPL_PURPOSE","IAB2_SPL_FEATURE","MOB_DEVICE_PERMISSION","IAB2V2_PURPOSE","IAB2V2_STACK","IAB2V2_FEATURE","IAB2V2_SPL_PURPOSE","IAB2V2_SPL_FEATURE","IAB2V2_DATA_CATEGORY"]},"creationMode":{"description":"Creation mode of the display group.","type":"string","example":"MANUAL","enum":["SEEDED","MANUAL"]},"description":{"description":"Description of the display group for web platforms.","type":"string","example":"These cookies are essential for the website to function.","maxLength":5000,"minLength":0},"mobileDescription":{"description":"Description of the display group for mobile platforms.","type":"string","example":"Essential cookies for mobile app.","maxLength":5000,"minLength":0},"ottDescription":{"description":"Description of the display group for OTT (Over-The-Top) platforms.","type":"string","example":"Essential cookies for OTT app.","maxLength":5000,"minLength":0},"mobileName":{"description":"Name of the display group for mobile platforms.","type":"string","example":"Essential Cookies","maxLength":255,"minLength":0},"ottName":{"description":"Name of the display group for OTT platforms.","type":"string","example":"Essential Cookies","maxLength":255,"minLength":0},"showMobDesc":{"description":"Indicates if mobile description should be displayed.","type":"boolean","example":true},"showOTTDesc":{"description":"Indicates if OTT description should be displayed.","type":"boolean","example":true},"alwaysShowCategory":{"description":"Indicates if the category should always be shown on web platforms.","type":"boolean","example":false},"mobileAlwaysShowCategory":{"description":"Indicates if the category should always be shown on mobile platforms.","type":"boolean","example":false},"ottAlwaysShowCategory":{"description":"Indicates if the category should always be shown on OTT platforms.","type":"boolean","example":false},"descriptionLegal":{"description":"Legal description of the display group.","type":"string","example":"Legal text for this category.","maxLength":5000,"minLength":0},"customCategoryId":{"description":"Unique identifier of the custom category.","type":"string","format":"uuid","example":"f2229953-b4b5-4042-8cb9-b78038cc4c46"},"customCategoryName":{"description":"Name of the custom category.","type":"string","example":"C0001","maxLength":255,"minLength":0},"enable":{"description":"Indicates if the display group is enabled.","type":"boolean","example":true},"show":{"description":"Indicates if the display group should be shown.","type":"boolean","example":true},"iabIllustrations":{"description":"List of IAB source illustrations associated with this display group.","type":"array","items":{"$ref":"#/components/schemas/IABSourceIllustrationsDto"},"example":[{"id":"f2229953-b4b5-4042-8cb9-b78038cc4c46","displayGroupId":"a1b2c3d4-e5f6-7890-abcd-ef1234567890","illustration":"This is an example illustration","sequence":1,"custom":false}],"maxItems":1000,"minItems":0},"machineTranslated":{"type":"boolean"},"iabPurpose":{"type":"boolean"}}},"DisplayGroupTreeDto":{"type":"object","properties":{"nodeId":{"description":"Unique identifier of the tree node.","type":"string","format":"uuid","example":"f2229953-b4b5-4042-8cb9-b78038cc4c46"},"sequence":{"description":"Sequence order of the node within its level.","type":"integer","format":"int32","example":1},"attributes":{"description":"Map of attributes associated with this display group node.","type":"object","example":{"showBanner":{"value":true,"type":"BOOLEAN"}},"additionalProperties":{"$ref":"#/components/schemas/AttributeDto"}},"displayGroup":{"description":"Display group entity details associated with this node.","$ref":"#/components/schemas/DisplayGroupEntityDto"},"cookiepediaCategoryId":{"description":"Cookiepedia category ID associated with this display group.","type":"integer","format":"int32","example":123}}},"IABSourceIllustrationsDto":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"displayGroupId":{"description":"Unique identifier of the display group.","type":"string","format":"uuid","example":"f2229953-b4b5-4042-8cb9-b78038cc4c46"},"illustration":{"description":"Illustration text.","type":"string","example":"This is an example illustration","maxLength":1000,"minLength":1},"sequence":{"description":"Sequence order of the illustration.","type":"integer","format":"int32","example":1},"custom":{"type":"boolean"}}},"TemplateDetailDto":{"type":"object","properties":{"template":{"description":"Template details","$ref":"#/components/schemas/TemplateDto"},"pcAdvancedConfig":{"description":"Root display group tree","$ref":"#/components/schemas/DisplayGroupTreeDto"},"bannerAttributes":{"description":"Map of branding attributes keyed by attribute name - For Banner","type":"object","example":{"dBannerButtonColor":{"id":"f2229953-b4b5-4042-8cb9-b78038cc4c46","name":"dBannerButtonColor","value":"#000000","type":"STRING","section":"BANNER","important":false},"dBannerPosition":{"id":"a1b2c3d4-e5f6-7890-abcd-ef1234567890","name":"dBannerPosition","value":"bottom","type":"STRING","section":"BANNER","important":false}},"additionalProperties":{"$ref":"#/components/schemas/BrandingAttributeDTO"}},"pcAttributes":{"description":"Map of branding attributes keyed by attribute name - For Preferences Center","type":"object","example":{"dPCButtonColor":{"id":"f2229953-b4b5-4042-8cb9-b78038cc4c46","name":"dPCButtonColor","value":"#0066FF","type":"STRING","section":"PREFERENCE_CENTER","important":false},"dPCShowCookieList":{"id":"b2c3d4e5-f6g7-8901-bcde-f12345678901","name":"dPCShowCookieList","value":true,"type":"BOOLEAN","section":"PREFERENCE_CENTER","important":false}},"additionalProperties":{"$ref":"#/components/schemas/BrandingAttributeDTO"}},"clistattributes":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/BrandingAttributeDTO"}}}},"GeoRuleDto":{"type":"object","properties":{"geoRuleId":{"description":"Unique identifier of the geo rule.","type":"string","format":"uuid","example":"f2229953-b4b5-4042-8cb9-b78038cc4c46"},"geoRuleName":{"description":"Name of the geo rule.","type":"string","example":"Europe Rule","maxLength":255,"minLength":1},"consentModel":{"description":"Consent model applied to this geo rule.","type":"string","example":"Opt-In","maxLength":50,"minLength":1},"default":{"type":"boolean"},"global":{"type":"boolean"}}},"GeoRuleGroupDto":{"type":"object","properties":{"geoRuleGroupId":{"description":"Unique identifier of the geo rule group.","type":"string","format":"uuid","example":"f2229953-b4b5-4042-8cb9-b78038cc4c46"},"geoRuleGroupName":{"description":"Name of the geo rule group.","type":"string","example":"Your New Geo Rule Group","maxLength":255,"minLength":1},"geoRules":{"description":"List of geo rules within this group.","type":"array","items":{"$ref":"#/components/schemas/GeoRuleDto"},"example":[{"geoRuleId":"f2229953-b4b5-4042-8cb9-b78038cc4c46","geoRuleName":"Europe Rule","consentModel":"Opt-In","default":false,"global":false}],"maxItems":1000,"minItems":0},"defaultConsentModel":{"description":"Default consent model for the geo rule group.","type":"string","example":"Opt-In","maxLength":50,"minLength":1},"associatedDomains":{"description":"Map of domain IDs to domain URLs associated with this geo rule group.","type":"object","example":{"f2229953-b4b5-4042-8cb9-b78038cc4c46":"example.com","a1234567-b4b5-4042-8cb9-b78038cc4c47":"test.com"},"additionalProperties":{"type":"string"}},"assignedMobileApps":{"description":"Map of mobile app IDs to app names assigned to this geo rule group.","type":"object","example":{"c3456789-b4b5-4042-8cb9-b78038cc4c48":"MyApp","d4567890-b4b5-4042-8cb9-b78038cc4c49":"TestApp"},"additionalProperties":{"type":"string"}},"status":{"description":"Current status of the geo rule group.","type":"string","example":"ACTIVE","enum":["DRAFT","ACTIVATED","PUBLISHED","DISABLED"]},"isUniversalDefault":{"description":"Indicates if the template is the universal default template","type":"boolean","example":false},"isOrgDefault":{"description":"Indicates if the template is the default template for the organization","type":"boolean","example":false},"orgDefaultEnabled":{"description":"Indicates if the organization default is enabled","type":"boolean","example":false},"orgId":{"description":"Organization ID that owns this geo rule group.","type":"string","format":"uuid","example":"f2229953-b4b5-4042-8cb9-b78038cc4c46"},"orgName":{"description":"Organization name","type":"string","example":"OneTrust","maxLength":255,"minLength":1},"description":{"description":"Description of the geo rule group.","type":"string","example":"Default geo rule group for all regions","maxLength":1000,"minLength":1},"version":{"description":"Version number of the geo rule group.","type":"integer","format":"int32","example":1},"default":{"type":"boolean"}}},"PageGeoRuleGroupDto":{"type":"object","properties":{"totalPages":{"type":"integer","format":"int32"},"totalElements":{"type":"integer","format":"int64"},"size":{"type":"integer","format":"int32"},"content":{"items":{"$ref":"#/components/schemas/GeoRuleGroupDto"},"type":"array"},"number":{"type":"integer","format":"int32"},"sort":{"$ref":"#/components/schemas/SortObject"},"pageable":{"$ref":"#/components/schemas/PageableObject"},"first":{"type":"boolean"},"last":{"type":"boolean"},"numberOfElements":{"type":"integer","format":"int32"},"empty":{"type":"boolean"}}},"CookieCategoryDto":{"type":"object","properties":{"id":{"description":"Unique identifier of the cookie category.","type":"string","format":"uuid","example":"f2229953-b4b5-4042-8cb9-b78038cc4c46"},"name":{"description":"Name of the cookie category.","type":"string","example":"Strictly Necessary","maxLength":255,"minLength":1},"status":{"description":"Consent status for this category.","type":"string","example":"Opt-out","maxLength":50,"minLength":1},"customCategoryName":{"description":"Custom category name.","type":"string","example":"C0001","maxLength":255,"minLength":1},"customCategoryId":{"description":"Unique identifier of the custom category.","type":"string","format":"uuid","example":"f2229953-b4b5-4042-8cb9-b78038cc4c46"},"type":{"description":"Type of the cookie category.","type":"string","example":"COOKIE","maxLength":50,"minLength":1},"doNotTrackEnabled":{"description":"Indicates if Do Not Track is enabled for this category.","type":"boolean","example":false},"globalPrivacyControlEnabled":{"description":"Indicates if Global Privacy Control is enabled for this category.","type":"boolean","example":false},"cookiepediaCategoryId":{"description":"Cookiepedia category ID.","type":"integer","format":"int32","example":123},"sequence":{"description":"Sequence of the cookie category.","type":"integer","format":"int32","example":1}}},"CountryResponseDto":{"type":"object","properties":{"id":{"description":"Unique identifier of the country.","type":"string","format":"uuid","example":"f2229953-b4b5-4042-8cb9-b78038cc4c46"},"name":{"description":"Name of the country.","type":"string","example":"Germany"},"code":{"description":"ISO country code.","type":"string","example":"DE"},"regionCode":{"description":"ISO region code of the region this country belongs to.","type":"string","example":"AS"}}},"GeoRuleDetailDto":{"type":"object","properties":{"geoRuleId":{"description":"Unique identifier of the geo rule.","type":"string","format":"uuid","example":"f2229953-b4b5-4042-8cb9-b78038cc4c46"},"geoRuleName":{"description":"Name of the geo rule.","type":"string","example":"Europe Rule","maxLength":255,"minLength":1},"createdDate":{"description":"Date when the geo rule was created.","type":"string","format":"date-time","example":"2025-01-01T00:00:00Z"},"audienceLogicEnabled":{"description":"Indicates if audience logic is enabled for this geo rule.","type":"boolean","example":true},"showBanner":{"description":"Indicates if the consent banner should be displayed.","type":"boolean","example":true},"enableGoogleConsent":{"description":"Indicates if Google Consent Mode is enabled.","type":"boolean","example":false},"consentModel":{"description":"Consent model applied to this geo rule.","type":"string","example":"Opt-In","maxLength":50,"minLength":1},"regions":{"description":"List of regions assigned to this geo rule.","type":"array","items":{"$ref":"#/components/schemas/RegionResponseDto"},"example":[{"id":"f2229953-b4b5-4042-8cb9-b78038cc4c46","name":"Europe"}],"maxItems":1000,"minItems":0},"countries":{"description":"List of countries assigned to this geo rule.","type":"array","items":{"$ref":"#/components/schemas/CountryResponseDto"},"example":[{"id":"f2229953-b4b5-4042-8cb9-b78038cc4c46","name":"Germany","code":"DE"}],"maxItems":1000,"minItems":0},"states":{"description":"List of states assigned to this geo rule.","type":"array","items":{"$ref":"#/components/schemas/StateResponseDto"},"example":[{"id":"f2229953-b4b5-4042-8cb9-b78038cc4c46","name":"California","code":"CA"}],"maxItems":1000,"minItems":0},"cookieCategories":{"description":"List of cookie categories and their consent status for this geo rule.","type":"array","items":{"$ref":"#/components/schemas/CookieCategoryDto"},"example":[{"id":"f2229953-b4b5-4042-8cb9-b78038cc4c46","name":"Strictly Necessary","status":"Opt-out","customCategoryName":"C0001","customCategoryId":"a1b2c3d4-e5f6-7890-abcd-ef1234567890","type":"COOKIE","doNotTrackEnabled":false,"globalPrivacyControlEnabled":false,"cookiepediaCategoryId":123,"sequence":1}],"maxItems":1000,"minItems":0},"attributes":{"description":"Map of template attributes for this geo rule.","type":"object","example":{"showBanner":{"value":true,"type":"BOOLEAN"},"audienceLogic":{"value":false,"type":"BOOLEAN"},"bannerPosition":{"value":"bottom","type":"STRING"}},"additionalProperties":{"$ref":"#/components/schemas/AttributeDto"}},"templateName":{"description":"Name of the template associated with this geo rule.","type":"string","example":"Default Template","maxLength":255,"minLength":1},"templateId":{"description":"Unique identifier of the template associated with this geo rule.","type":"string","format":"uuid","example":"f2229953-b4b5-4042-8cb9-b78038cc4c46"},"default":{"type":"boolean"},"global":{"type":"boolean"}}},"GeoRuleGroupDetailDto":{"type":"object","properties":{"geoRuleGroupId":{"description":"Unique identifier of the geo rule group.","type":"string","format":"uuid","example":"f2229953-b4b5-4042-8cb9-b78038cc4c46"},"geoRuleGroupName":{"description":"Name of the geo rule group.","type":"string","example":"My new Geo Rule Group","maxLength":255,"minLength":1},"geoRules":{"description":"List of geo rules within this group.","type":"array","items":{"$ref":"#/components/schemas/GeoRuleDetailDto"},"example":[{"geoRuleId":"f2229953-b4b5-4042-8cb9-b78038cc4c46","geoRuleName":"Europe Rule","isDefault":false,"isGlobal":false,"audienceLogicEnabled":true,"showBanner":true,"enableGoogleConsent":false,"consentModel":"Opt-In","regions":[{"id":"f2229953-b4b5-4042-8cb9-b78038cc4c46","name":"Europe"}],"countries":[{"id":"f2229953-b4b5-4042-8cb9-b78038cc4c46","name":"Germany","code":"DE"}],"states":[{"id":"f2229953-b4b5-4042-8cb9-b78038cc4c46","name":"California","code":"CA"}],"cookieCategories":[{"id":"f2229953-b4b5-4042-8cb9-b78038cc4c46","name":"Strictly Necessary","status":"Opt-out","customCategoryName":"C0001","type":"COOKIE","sequence":1}],"templateName":"Default Template","templateId":"f2229953-b4b5-4042-8cb9-b78038cc4c46"}],"maxItems":1000,"minItems":0},"defaultConsentModel":{"description":"Default consent model for the geo rule group.","type":"string","example":"Opt-In","maxLength":50,"minLength":1},"associatedDomains":{"description":"Map of domain IDs to domain URLs associated with this geo rule group.","type":"object","example":{"f2229953-b4b5-4042-8cb9-b78038cc4c46":"example.com","a1234567-b4b5-4042-8cb9-b78038cc4c47":"test.com"},"additionalProperties":{"type":"string"}},"assignedMobileApps":{"description":"Map of mobile app IDs to app names assigned to this geo rule group.","type":"object","example":{"c3456789-b4b5-4042-8cb9-b78038cc4c48":"MyApp","d4567890-b4b5-4042-8cb9-b78038cc4c49":"TestApp"},"additionalProperties":{"type":"string"}},"status":{"description":"Current status of the geo rule group.","type":"string","example":"ACTIVATED","enum":["DRAFT","ACTIVATED","PUBLISHED","DISABLED"]},"orgId":{"description":"Organization ID that owns this geo rule group.","type":"string","format":"uuid","example":"f2229953-b4b5-4042-8cb9-b78038cc4c46"},"orgName":{"description":"Organization name","type":"string","example":"OneTrust","maxLength":255,"minLength":1},"description":{"description":"Description of the geo rule group.","type":"string","example":"Default Geo Rule Group for all regions","maxLength":1000,"minLength":1},"version":{"description":"Version number of the geo rule group.","type":"integer","format":"int64","example":1},"default":{"type":"boolean"}}},"RegionResponseDto":{"type":"object","properties":{"id":{"description":"Unique identifier of the region.","type":"string","format":"uuid","example":"f2229953-b4b5-4042-8cb9-b78038cc4c46"},"name":{"description":"Name of the region.","type":"string","example":"Europe"}}},"StateResponseDto":{"type":"object","properties":{"id":{"description":"Unique identifier of the state.","type":"string","format":"uuid","example":"f2229953-b4b5-4042-8cb9-b78038cc4c46"},"name":{"description":"Name of the state.","type":"string","example":"California"},"code":{"description":"State code.","type":"string","example":"CA"},"countryCode":{"description":"ISO country code of the country this state belongs to.","type":"string","example":"US"}}},"DomainBrandingAttributesResponseDTO":{"type":"object","properties":{"id":{"description":"Resource ID (Domain ID)","type":"string","format":"uuid","example":"f2229953-b4b5-4042-8cb9-b78038cc4c46"},"resourceName":{"description":"Resource name (Domain name)","type":"string","example":"www.example.com","maxLength":255,"minLength":1},"attributes":{"description":"Map of branding attributes keyed by attribute name","type":"object","example":"[\"dPCenterCookiePolicyLinkScreenReader\": {\"name\": \"dPCenterCookiePolicyLinkScreenReader\", \"value\": \"#000000\"}, {\"name\": \"dPCenterButtonColor\", \"value\": \"#FFFFFF\"}]","additionalProperties":{"$ref":"#/components/schemas/PublicDomainBrandingAttributeDTO"}}}},"DomainScriptDetailsPublicDto":{"type":"object","properties":{"id":{"description":"Unique identifier (UUID).","type":"string","example":"f2229953-b4b5-4042-8cb9-b78038cc4c46"},"url":{"description":"URL assigned to this domain","type":"string","example":"onetrust.com","maxLength":255,"minLength":1},"cdnUrl":{"description":"The CDN script to use for production","type":"string","example":"https://cdn.cookielaw.org/scripttemplates/otSDKStub.js","maxLength":500,"minLength":1},"geoRuleId":{"description":"Unique identifier of the geo rule.","type":"string","format":"uuid","example":"f2229953-b4b5-4042-8cb9-b78038cc4c46"},"geoRuleName":{"description":"Name of the geo rule.","type":"string","example":"Europe Rule","maxLength":255,"minLength":1},"publishStatus":{"description":"The status of the script publication","type":"string","example":"PUBLISHED","enum":["DRAFT","PUBLISHED","PUBLISHING","FAILED","WAITING"]},"publishDate":{"description":"Date of this publish (timezone UTC)","type":"string","format":"date-time","example":"2024-01-15T14:30:45"},"publishVersion":{"description":"Version of this script publish","type":"string","example":"202212.1.0","maxLength":50,"minLength":1},"publishBy":{"description":"Tenant who triggered this publish","type":"string","example":"Adithya H.","maxLength":255},"webformIntegrationEnabled":{"description":"If webform integration is enabled","type":"boolean","example":false},"autoBlockingEnabled":{"description":"Is autoblocking enabled for this script","type":"boolean","example":true},"distinctSrcUrl":{"type":"boolean"}}},"ApplicationListPublicDto":{"type":"object","properties":{"id":{"description":"Unique identifier of the application","type":"string","format":"uuid","example":"f2229953-b4b5-4042-8cb9-b78038cc4c46"},"name":{"description":"Name of the application","type":"string","example":"My Mobile App","maxLength":255,"minLength":1},"os":{"description":"Operating system type","type":"string","example":"ANDROID","enum":["IOS","ANDROID","APPLETV","ANDROIDTV","FIRETV","ROKU","SAMSUNGTV","LGTV","VIZIOTV","HBBTV","PANASONICTV","PS5","YOUVIEW"]},"status":{"description":"Current scan status of the application","type":"string","example":"COMPLETED","enum":["PENDING","PROGRESS","COMPLETED","FAILED","INTERRUPTED","UNSCANNED"]},"publishStatus":{"description":"Publish status of the application","type":"string","example":"PUBLISHED","enum":["DRAFT","PUBLISHED","PUBLISHING","FAILED","WAITING"]},"consentPolicyId":{"description":"Consent policy ID assigned to this application","type":"string","format":"uuid","example":"f2229953-b4b5-4042-8cb9-b78038cc4c46"},"consentPolicyName":{"description":"Name of the assigned consent policy","type":"string","example":"GDPR Policy","maxLength":255,"minLength":1},"consentPolicyAssignDate":{"description":"Date when consent policy was assigned","type":"string","format":"date-time","example":"2024-01-15T10:30:00Z"},"orgId":{"description":"Organization ID that owns this application","type":"string","example":"org-123"},"orgName":{"description":"Organization name","type":"string","example":"OneTrust","maxLength":255,"minLength":1},"scriptVersion":{"description":"Script version","type":"string","example":"202603.1.0","maxLength":100},"createdDate":{"description":"Date when the application was created","type":"string","format":"date-time","example":"2024-01-01T10:00:00Z"},"modifiedDate":{"description":"Date when the application was last modified","type":"string","format":"date-time","example":"2024-01-15T10:30:00Z"},"publishedDate":{"description":"Date when the application was last published","type":"string","format":"date-time","example":"2024-01-10T10:00:00Z"}}},"PageApplicationListPublicDto":{"type":"object","properties":{"totalPages":{"type":"integer","format":"int32"},"totalElements":{"type":"integer","format":"int64"},"size":{"type":"integer","format":"int32"},"content":{"items":{"$ref":"#/components/schemas/ApplicationListPublicDto"},"type":"array"},"number":{"type":"integer","format":"int32"},"sort":{"$ref":"#/components/schemas/SortObject"},"pageable":{"$ref":"#/components/schemas/PageableObject"},"first":{"type":"boolean"},"last":{"type":"boolean"},"numberOfElements":{"type":"integer","format":"int32"},"empty":{"type":"boolean"}}},"ApplicationScriptDetailsPublicDto":{"type":"object","properties":{"id":{"description":"Unique identifier of this Application.","type":"string","format":"uuid","example":"f2229953-b4b5-4042-8cb9-b78038cc4c46"},"name":{"description":"The name of this mobile Application.","type":"string","example":"CashPro Mobile-iOS","maxLength":255,"minLength":1},"version":{"description":"The version of the script","type":"string","example":"202212.1.0","maxLength":50,"minLength":1},"geoRuleId":{"description":"Unique identifier of the geo rule.","type":"string","format":"uuid","example":"f2229953-b4b5-4042-8cb9-b78038cc4c46"},"geoRuleName":{"description":"Name of the geo rule.","type":"string","example":"Europe Rule","maxLength":255,"minLength":1},"platform":{"description":"The platform of this Application.","type":"string","example":"IOS","enum":["IOS","ANDROID","APPLETV","ANDROIDTV","FIRETV","ROKU","SAMSUNGTV","LGTV","VIZIOTV","HBBTV","PANASONICTV","PS5","YOUVIEW"]},"lastPublishedStatus":{"description":"The status of the SDK publication","type":"string","example":"PUBLISHED","enum":["DRAFT","PUBLISHED","PUBLISHING","FAILED","WAITING"]},"lastPublishedDate":{"description":"Last date publish date (timezone UTC)","type":"string","format":"date-time","example":"2024-01-15T14:30:45"},"lastPublishedVersion":{"description":"Version of the latest publish","type":"string","example":"202212.1.0","maxLength":50,"minLength":1},"lastPublishedBy":{"description":"User who triggered the latest publish","type":"string","example":"Adithya H.","maxLength":255,"minLength":1},"solution":{"description":"The type of the SDK published within the application.","type":"string","example":"ONETRUST_SDK","enum":["API","ONETRUST_SDK"]},"publishedVersions":{"description":"The published version of this script.","type":"array","items":{"type":"string"},"example":["202602.1.0","202212.1.1"],"uniqueItems":true}}},"ApplicationScanDetailDto":{"type":"object","properties":{"scanId":{"description":"Unique identifier for this scan","type":"string","format":"uuid","example":"f2229953-b4b5-4042-8cb9-b78038cc4c46"},"status":{"description":"Status of this scan","type":"string","example":"COMPLETED","enum":["PENDING","PROGRESS","COMPLETED","FAILED","INTERRUPTED","UNSCANNED"]},"sdkCount":{"description":"Total number of SDKs found","type":"integer","format":"int32"},"sdkCategories":{"description":"SDK counts grouped by category","type":"object","example":{"Strictly Necessary":10,"Performance":5,"Functionality":3,"Targeting":2,"Unknown":1},"additionalProperties":{"type":"integer","format":"int32"}},"permissionCount":{"description":"Total number of permissions found","type":"integer","format":"int32"},"permissionCountHighRisk":{"description":"Number of high-risk permissions","type":"integer","format":"int32"},"permissionCategories":{"description":"Permission counts grouped by category","type":"object","example":{"Device Hardware":4,"Accounts":1,"Media":1,"System Notifications":3,"Security":1},"additionalProperties":{"type":"integer","format":"int32"}},"scanDate":{"description":"Date and time of the scan","type":"string","format":"date-time","example":"2022-01-01T00:00:00.000Z"},"version":{"description":"Detected version of the given application","type":"string","example":"1.0.0"},"engineVersion":{"description":"OneTrust mobile scan engine version used for this scan","type":"string","example":"2.0.0"}}},"PageApplicationScanDetailDto":{"type":"object","properties":{"totalPages":{"type":"integer","format":"int32"},"totalElements":{"type":"integer","format":"int64"},"size":{"type":"integer","format":"int32"},"content":{"items":{"$ref":"#/components/schemas/ApplicationScanDetailDto"},"type":"array"},"number":{"type":"integer","format":"int32"},"sort":{"$ref":"#/components/schemas/SortObject"},"pageable":{"$ref":"#/components/schemas/PageableObject"},"first":{"type":"boolean"},"last":{"type":"boolean"},"numberOfElements":{"type":"integer","format":"int32"},"empty":{"type":"boolean"}}},"ApplicationScanSdkPublicDto":{"type":"object","properties":{"packageId":{"description":"PackageId of the SDK","type":"string","example":"org.apache.commons.math3"},"name":{"description":"Name of the SDK","type":"string","example":"Apache Commons Math Library"},"vendor":{"description":"Vendor for this SDK","type":"string","example":"Apache Software Foundation"},"category":{"description":"Categorisation of the SDK","type":"string","example":"Strictly Necessary"},"description":{"description":"Description for the SDK","type":"string","example":"The Apache Commons Math project is a library of lightweight, self-contained mathematics and statistics components addressing the most common practical problems not immediately available in the Java programming language or commons-lang."}}},"PageApplicationScanSdkPublicDto":{"type":"object","properties":{"totalPages":{"type":"integer","format":"int32"},"totalElements":{"type":"integer","format":"int64"},"size":{"type":"integer","format":"int32"},"content":{"items":{"$ref":"#/components/schemas/ApplicationScanSdkPublicDto"},"type":"array"},"number":{"type":"integer","format":"int32"},"sort":{"$ref":"#/components/schemas/SortObject"},"pageable":{"$ref":"#/components/schemas/PageableObject"},"first":{"type":"boolean"},"last":{"type":"boolean"},"numberOfElements":{"type":"integer","format":"int32"},"empty":{"type":"boolean"}}},"AppPrivacyManifestResponseDataPublicDto":{"type":"object","properties":{"dataType":{"description":"The Privacy Manifest data type these results relate to","type":"string","example":"DEVICE_ID","enum":["NAME","EMAIL","PHONE_NUMBER","PHYSICAL_ADDRESS","OTHER_USER_CONTACT_INFO","HEALTH","FITNESS","PAYMENT_INFO","CREDIT_INFO","OTHER_FINANCIAL_INFO","PRECISE_LOCATION","COARSE_LOCATION","SENSITIVE_INFO","CONTACTS","MESSAGES","PHOTOS_VIDEOS","AUDIO_DATA","GAMEPLAY_CONTENT","CUSTOMER_SUPPORT","OTHER_USER_CONTENT","BROWSING_HISTORY","SEARCH_HISTORY","USER_ID","DEVICE_ID","PURCHASE_HISTORY","PRODUCT_INTERACTION","ADVERTISING_DATA","OTHER_USAGE_DATA","CRASH_DATA","PERFORMANCE_DATA","OTHER_DIAGNOSTIC_DATA","ENVIRONMENT_SCANNING","HANDS","HEAD","OTHER_DATA_TYPES","UNKNOWN"]},"sdkCount":{"description":"Number of SDKs detected that relate to this data type","type":"integer","format":"int32","example":3},"purposes":{"description":"Data collection purposes declared for this data type","type":"array","items":{"type":"string","enum":["THIRD_PARTY_ADVERTISING","DEVELOPER_ADVERTISING","ANALYTICS","PRODUCT_PERSONALIZATION","APP_FUNCTIONALITY","OTHER","UNKNOWN"]}},"mismatches":{"description":"Mismatch categories detected for this data type","type":"array","items":{"type":"string","enum":["NONE","DATA_TYPE","DATA_PURPOSE","TRACKING","USERLINK"]}}}},"AppPrivacyManifestResponsePublicDto":{"type":"object","properties":{"editVersion":{"description":"The current edit version of the Privacy Manifest","type":"string","example":2},"versions":{"description":"All available edit versions for this application's Privacy Manifest","type":"array","items":{"type":"string"},"example":["1","2"]},"countTotal":{"description":"Total number of data types present in the scan results","type":"integer","format":"int32","example":5},"countAligned":{"description":"Number of data types that are fully aligned with the Privacy Manifest","type":"integer","format":"int32","example":3},"countMismatched":{"description":"Number of data types with at least one non-DATA_TYPE mismatch","type":"integer","format":"int32","example":1},"countMissing":{"description":"Number of data types missing from the Privacy Manifest declaration","type":"integer","format":"int32","example":1},"dataTypes":{"description":"Per-data-type scan summary, keyed by data type.","type":"object","additionalProperties":{"$ref":"#/components/schemas/AppPrivacyManifestResponseDataPublicDto"}}}},"AppPrivacyManifestMismatchPublicDto":{"type":"object","properties":{"sdkPackageId":{"description":"Package identifier of the SDK that triggered this mismatch","type":"string","example":"com.google.firebase"},"sdkName":{"description":"Display name of the SDK that triggered this mismatch","type":"string","example":"Firebase"},"dataType":{"description":"The Privacy Manifest data type this mismatch relates to","type":"string","example":"DEVICE_ID","enum":["NAME","EMAIL","PHONE_NUMBER","PHYSICAL_ADDRESS","OTHER_USER_CONTACT_INFO","HEALTH","FITNESS","PAYMENT_INFO","CREDIT_INFO","OTHER_FINANCIAL_INFO","PRECISE_LOCATION","COARSE_LOCATION","SENSITIVE_INFO","CONTACTS","MESSAGES","PHOTOS_VIDEOS","AUDIO_DATA","GAMEPLAY_CONTENT","CUSTOMER_SUPPORT","OTHER_USER_CONTENT","BROWSING_HISTORY","SEARCH_HISTORY","USER_ID","DEVICE_ID","PURCHASE_HISTORY","PRODUCT_INTERACTION","ADVERTISING_DATA","OTHER_USAGE_DATA","CRASH_DATA","PERFORMANCE_DATA","OTHER_DIAGNOSTIC_DATA","ENVIRONMENT_SCANNING","HANDS","HEAD","OTHER_DATA_TYPES","UNKNOWN"]},"mismatch":{"description":"The category of mismatch detected","type":"string","example":"DATA_PURPOSE","enum":["NONE","DATA_TYPE","DATA_PURPOSE","TRACKING","USERLINK"]},"appValue":{"description":"The value declared in the app's Privacy Manifest","type":"string","example":true},"sdkValue":{"description":"The value detected in the SDK scan","type":"string","example":false}}},"AppPrivacyManifestResponseDatatypePublicDto":{"type":"object","properties":{"dataType":{"description":"The Privacy Manifest data type these results relate to","type":"string","example":"DEVICE_ID","enum":["NAME","EMAIL","PHONE_NUMBER","PHYSICAL_ADDRESS","OTHER_USER_CONTACT_INFO","HEALTH","FITNESS","PAYMENT_INFO","CREDIT_INFO","OTHER_FINANCIAL_INFO","PRECISE_LOCATION","COARSE_LOCATION","SENSITIVE_INFO","CONTACTS","MESSAGES","PHOTOS_VIDEOS","AUDIO_DATA","GAMEPLAY_CONTENT","CUSTOMER_SUPPORT","OTHER_USER_CONTENT","BROWSING_HISTORY","SEARCH_HISTORY","USER_ID","DEVICE_ID","PURCHASE_HISTORY","PRODUCT_INTERACTION","ADVERTISING_DATA","OTHER_USAGE_DATA","CRASH_DATA","PERFORMANCE_DATA","OTHER_DIAGNOSTIC_DATA","ENVIRONMENT_SCANNING","HANDS","HEAD","OTHER_DATA_TYPES","UNKNOWN"]},"mismatches":{"description":"Mismatches detected for this data type, keyed by mismatch category.","type":"object","additionalProperties":{"type":"array","items":{"$ref":"#/components/schemas/AppPrivacyManifestMismatchPublicDto"}}}}},"ApplicationScanPermissionPublicDto":{"type":"object","properties":{"name":{"description":"Name of the permission","type":"string","example":"Use Fingerprint"},"category":{"description":"Categorisation of the permission","type":"string","example":"Device Hardware"},"description":{"description":"Description of the permission","type":"string","example":"Deprecated in API level 28. Use USE_BIOMETRIC instead."},"status":{"description":"Status of the permission","type":"string","example":"Deprecated"},"sensitivity":{"description":"Sensitivity of the permission","type":"string","example":"Sensitive"}}},"ApplicationBrandingAttributesResponseDTO":{"type":"object","properties":{"id":{"description":"Resource ID (Application ID)","type":"string","format":"uuid","example":"f2229953-b4b5-4042-8cb9-b78038cc4c46"},"resourceName":{"description":"Resource name (Application/Domain name)","type":"string","example":"My Application","maxLength":255,"minLength":1},"attributes":{"description":"Map of branding attributes keyed by attribute name","type":"object","example":"[\"dPCenterCookiePolicyLinkScreenReader\": {\"name\": \"dPCenterCookiePolicyLinkScreenReader\", \"value\": \"#000000\"}, {\"name\": \"dPCenterButtonColor\", \"value\": \"#FFFFFF\"}]","additionalProperties":{"$ref":"#/components/schemas/PublicApplicationBrandingAttributeDTO"}}}},"BulkCookieDeletionRequest":{"type":"object","properties":{"cookieIds":{"description":"The list of cookie identifiers.","type":"array","items":{"type":"string","format":"uuid"},"maxItems":100,"minItems":0},"filters":{"description":"The criteria used to filter the results.","$ref":"#/components/schemas/CookieFilters"},"language":{"description":"The language code for localized content.","type":"string","example":"en","maxLength":10,"minLength":2},"countryCode":{"description":"The country code for regional settings.","type":"string","example":"us","maxLength":10,"minLength":2},"deleteByFilterCriteria":{"description":"This flag indicates whether to delete items based on filter conditions rather than specific identifiers.","type":"boolean","example":false,"default":"false"},"cookieName":{"description":"The name of the cookie.","type":"string","example":"cookie123","maxLength":255,"minLength":1}},"required":["cookieIds","filters"]}},"securitySchemes":{"OAUTH2":{"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://{hostname}/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."}}}}}}}