Customer REST API

• Introduction
• Authentication
• Pagination, Limits, and Sorting
• General
  • Cookie Consent Configurations
    • getList Cookie Consent Configurations
    • postCreate New Cookie Consent Configuration
    • getReturn Detailed Cookie Consent Configuration
    • patchUpdate Cookie Consent Configuration
    • postPublish Cookie Consent Configuration
    • getList Configuration Discoveries
    • getList Configuration Rules
  • Cookie Consent Discoveries & Rules
    • postCreate New Cookie Consent Rules
    • patchUpdate Cookie Consent Rule
    • delDelete Cookie Consent Rule
  • Data Mapping Connectors
    • getList Connectors (DEPRECATED)
    • getList Connectors
  • Subject Rights
    • getList Subject Rights Requests (DEPRECATED)
    • postCreate New Subject Rights Request(s) (DEPRECATED)
    • getReturn Detailed Subject Rights Request (DEPRECATED)
    • patchUpdate Subject Rights Request (DEPRECATED)
    • postUpdate Identification Photo (DEPRECATED)
    • getList Subject Rights Requests
    • postCreate New Subject Rights Request(s)
    • getReturn Detailed Subject Rights Request
    • patchUpdate Subject Rights Request
    • postUpdate Identification Photo
  • Data Discovery
    • getList Data Stores
    • postCreate New Data Store
    • getReturn Single Data Store
    • delDeactivate a data store
    • patchUpdate an existing data store
    • putUpdate Data Store Fields
    • getReturns Data Store Fields
    • delDelete Data Store Field
    • patchUpdate Data Store Field
    • getList Data Stores (DEPRECATED)
    • postCreate New Data Store (DEPRECATED)
    • getReturn Single Data Store (DEPRECATED)
    • delDeactivate a data store (DEPRECATED)
    • patchUpdate an existing data store (DEPRECATED)
    • putUpdate Data Store Fields (DEPRECATED)
    • getReturns Data Store Fields (DEPRECATED)
    • delDelete Data Store Field (DEPRECATED)
    • patchUpdate Data Store Field (DEPRECATED)
  • Subject Rights Action Items
    • getList Subject Rights Action Items (DEPRECATED)
    • getReturn Single Subject Rights Action Item (DEPRECATED)
    • patchUpdate Subject Rights Action Item (DEPRECATED)
    • getReturn Action Item Summary Entries (DEPRECATED)
    • postUpload a Subject Rights Action Item Summary (DEPRECATED)
    • patchUpdate a Subject Rights Action Item Summary (DEPRECATED)
    • getList Subject Rights Action Items
    • getReturn Single Subject Rights Action Item
    • patchUpdate Subject Rights Action Item
    • getReturn Action Item Summary Entries
    • postUpload a Subject Rights Action Item Summary
    • patchUpdate a Subject Rights Action Item Summary
  • Subject Rights Portal
    • getGet Portal Messages
    • postCreate Portal Message
    • patchUpdate Portal Message

API docs by Redocly

Osano API Reference (1.0.0)

Download OpenAPI specification:Download

Introduction

This is the Osano API. Use of this API is subject to the Osano API Terms of Service.

Authentication

The Osano API uses API keys to authenticate requests that are generated on a per-user basis. All calls require a valid, unexpired API key.

API keys may be generated within the Osano settings -> API Keys page. You must be an admin or have the correct privileges to generate an API key.

Once generated, the API key should be included in the x-osano-api-key header of all requests. For example:

curl --header 'x-osano-api-key: <API_KEY>' https://api.osano.dev/v1/<API_PATH>

Pagination, Limits, and Sorting

Except where noted, all "list" resources will be sorted in descending order by creation time, and this may not be changed. The number of results returned may be controlled via the limit param, but may not exceed 500.

Within the response of each "list" API call, there will be a "next" field, which represents the pagination token. This token may be added as a query parameter, i.e. ?next=<...> to retrieve subsequent pages of the same resource.

Cookie Consent Configurations

List Cookie Consent Configurations

Returns a list of Cookie Consent Configurations. Results are sorted in descending order by creation time by default. The sort by field can be overridden by specifying a sortBy param. The number of results returned may be controlled via the limit param, but may not exceed 1000. The "next" object in the response may be used to retrieve subsequent pages of the same resource.

Authorizations:

ApiKeyAuth

query Parameters

limit	integer <int32> <= 1000 Default: 100 The number of items to return.
next	string The pagination token from the previous request.
sortBy	string Default: "created" Enum: "name" "created" "updated" "lastPublished" Specify a field to sort by. If omitted, the default sort order is used.
mode	string Enum: "debug" "permissive" "production" The compliance mode for the configuration.
status	string Enum: "unpublished" "in-progress" "published" "outdated" "error" The publish status for the configuration.
tattleRecordStopped	boolean The tattle record stopped status for the configuration.

Responses

Production API

https://api.osano.com/v1/cookie-consent/configs

Response samples

• 200
• 400

Content type

application/json

{

• "items": [

  • {

    • "name": "string",
    • "domains": [

      • "string"

      ],
    • "mode": "debug",
    • "configuration": {

      • "additionalLinks": [

        • [

          • "string",
          • "string"

          ]

        ],
      • "allowTimeout": true,
      • "ccpaRelaxed": true,
      • "codeSplitting": true,
      • "crossDomain": true,
      • "dntSupport": true,
      • "forcedClassifyEnabled": true,
      • "forceManagePreferences": true,
      • "googleConsent": true,
      • "gpcSupport": true,
      • "iframeBlocking": "",
      • "managePreferencesEnabled": true,
      • "palette": {

        • "buttonBackgroundColor": "string",
        • "buttonDenyBackgroundColor": "string",
        • "buttonDenyForegroundColor": "string",
        • "buttonForegroundColor": "string",
        • "dialogBackgroundColor": "string",
        • "dialogForegroundColor": "string",
        • "dialogType": "bar",
        • "displayPosition": "string",
        • "infoDialogBackgroundColor": "string",
        • "infoDialogForegroundColor": "string",
        • "infoDialogOverlayColor": "string",
        • "infoDialogPosition": "right",
        • "linkColor": "string",
        • "toggleButtonOnColor": "string",
        • "toggleButtonOffColor": "string",
        • "toggleOnBackgroundColor": "string",
        • "toggleOffBackgroundColor": "string",
        • "widgetPosition": "right"

        },
      • "policyLinkText": "cookieNotice",
      • "policyLinkInDrawer": true,
      • "storagePolicyHref": "string",
      • "timeoutSeconds": 0

      },
    • "created": 0,
    • "updated": 0,
    • "publishStatus": "unpublished",
    • "lastPublished": 0,
    • "publishedRevision": 0,
    • "tattleRecordStopped": true,
    • "configId": "46ff6d11-d8b2-40d8-9197-dfa33c61cd6c",
    • "customerId": "string"

    }

  ],
• "next": "string"

}

Create New Cookie Consent Configuration

Create a new Cookie Consent Configuration.

Authorizations:

ApiKeyAuth

Request Body schema: application/json

required

name required	string The name of the configuration.
domains required	Array of strings non-empty A list of domains (cannot be null or empty) that are permitted to host the configuration.
mode required	string Enum: "debug" "permissive" "production" The compliance mode for the configuration. debug: Discovery/Listener Mode - Script and cookie information will be gathered for categorization, but blocking will not occur and the consent dialog will not be displayed. permissive: Permissive Mode - The consent dialog will be displayed. All uncategorized scripts will be reported as discoveries and allowed regardless of consent given. All categorized scripts will be allowed or blocked based on the user selection. production: Strict Mode (recommended) - The consent dialog will be displayed, and all uncategorized scripts will be blocked until they have been classified. Note: It is recommended that all discovered scripts & cookies are classified before changing the mode to production as all unclassified entities will be blocked. For more information, see Compliance Mode Definitions in the Cmp Setup Guide
required	object non-empty

Responses

Production API

https://api.osano.com/v1/cookie-consent/configs

Request samples

• Payload

Content type

application/json

{

• "name": "string",
• "domains": [

  • "string"

  ],
• "mode": "debug",
• "configuration": {

  • "additionalLinks": [

    • [

      • "string",
      • "string"

      ]

    ],
  • "allowTimeout": true,
  • "ccpaRelaxed": false,
  • "codeSplitting": false,
  • "crossDomain": false,
  • "dntSupport": true,
  • "forcedClassifyEnabled": true,
  • "forceManagePreferences": true,
  • "googleConsent": true,
  • "gpcSupport": true,
  • "iframeBlocking": "",
  • "managePreferencesEnabled": false,
  • "palette": {

    • "buttonBackgroundColor": "#7A3FF1",
    • "buttonDenyBackgroundColor": "#7A3FF1",
    • "buttonDenyForegroundColor": "#FFFFFF",
    • "buttonForegroundColor": "#FFFFFF",
    • "dialogBackgroundColor": "#180D43",
    • "dialogForegroundColor": "#FFFFFF",
    • "dialogType": "bar",
    • "displayPosition": "string",
    • "infoDialogBackgroundColor": "#180D43",
    • "infoDialogForegroundColor": "#FFFFFF",
    • "infoDialogOverlayColor": "",
    • "infoDialogPosition": "right",
    • "linkColor": "#37CD8F",
    • "toggleButtonOnColor": "#FFFFFF",
    • "toggleButtonOffColor": "#FFFFFF",
    • "toggleOnBackgroundColor": "#37CD8F",
    • "toggleOffBackgroundColor": "#7A3FF1",
    • "widgetPosition": "right"

    },
  • "policyLinkText": "privacyPolicy",
  • "policyLinkInDrawer": false,
  • "storagePolicyHref": "string",
  • "timeoutSeconds": 10

  }

}

Response samples

• 200
• 400

Content type

application/json

{

• "name": "string",
• "domains": [

  • "string"

  ],
• "mode": "debug",
• "configuration": {

  • "additionalLinks": [

    • [

      • "string",
      • "string"

      ]

    ],
  • "allowTimeout": true,
  • "ccpaRelaxed": true,
  • "codeSplitting": true,
  • "crossDomain": true,
  • "dntSupport": true,
  • "forcedClassifyEnabled": true,
  • "forceManagePreferences": true,
  • "googleConsent": true,
  • "gpcSupport": true,
  • "iframeBlocking": "",
  • "managePreferencesEnabled": true,
  • "palette": {

    • "buttonBackgroundColor": "string",
    • "buttonDenyBackgroundColor": "string",
    • "buttonDenyForegroundColor": "string",
    • "buttonForegroundColor": "string",
    • "dialogBackgroundColor": "string",
    • "dialogForegroundColor": "string",
    • "dialogType": "bar",
    • "displayPosition": "string",
    • "infoDialogBackgroundColor": "string",
    • "infoDialogForegroundColor": "string",
    • "infoDialogOverlayColor": "string",
    • "infoDialogPosition": "right",
    • "linkColor": "string",
    • "toggleButtonOnColor": "string",
    • "toggleButtonOffColor": "string",
    • "toggleOnBackgroundColor": "string",
    • "toggleOffBackgroundColor": "string",
    • "widgetPosition": "right"

    },
  • "policyLinkText": "cookieNotice",
  • "policyLinkInDrawer": true,
  • "storagePolicyHref": "string",
  • "timeoutSeconds": 0

  },
• "created": 0,
• "updated": 0,
• "publishStatus": "unpublished",
• "lastPublished": 0,
• "publishedRevision": 0,
• "tattleRecordStopped": true,
• "configId": "46ff6d11-d8b2-40d8-9197-dfa33c61cd6c",
• "customerId": "string"

}

Return Detailed Cookie Consent Configuration

Get a detailed Cookie Consent Configuration by ID.

Authorizations:

ApiKeyAuth

Responses

Production API

https://api.osano.com/v1/cookie-consent/configs/{configId}

Response samples

• 200
• 400

Content type

application/json

{

• "name": "string",
• "domains": [

  • "string"

  ],
• "mode": "debug",
• "configuration": {

  • "additionalLinks": [

    • [

      • "string",
      • "string"

      ]

    ],
  • "allowTimeout": true,
  • "ccpaRelaxed": true,
  • "codeSplitting": true,
  • "crossDomain": true,
  • "dntSupport": true,
  • "forcedClassifyEnabled": true,
  • "forceManagePreferences": true,
  • "googleConsent": true,
  • "gpcSupport": true,
  • "iframeBlocking": "",
  • "managePreferencesEnabled": true,
  • "palette": {

    • "buttonBackgroundColor": "string",
    • "buttonDenyBackgroundColor": "string",
    • "buttonDenyForegroundColor": "string",
    • "buttonForegroundColor": "string",
    • "dialogBackgroundColor": "string",
    • "dialogForegroundColor": "string",
    • "dialogType": "bar",
    • "displayPosition": "string",
    • "infoDialogBackgroundColor": "string",
    • "infoDialogForegroundColor": "string",
    • "infoDialogOverlayColor": "string",
    • "infoDialogPosition": "right",
    • "linkColor": "string",
    • "toggleButtonOnColor": "string",
    • "toggleButtonOffColor": "string",
    • "toggleOnBackgroundColor": "string",
    • "toggleOffBackgroundColor": "string",
    • "widgetPosition": "right"

    },
  • "policyLinkText": "cookieNotice",
  • "policyLinkInDrawer": true,
  • "storagePolicyHref": "string",
  • "timeoutSeconds": 0

  },
• "created": 0,
• "updated": 0,
• "publishStatus": "unpublished",
• "lastPublished": 0,
• "publishedRevision": 0,
• "tattleRecordStopped": true,
• "configId": "46ff6d11-d8b2-40d8-9197-dfa33c61cd6c",
• "customerId": "string"

}

Update Cookie Consent Configuration

Update an existing Cookie Consent Configuration.

Authorizations:

ApiKeyAuth

path Parameters

configId required

string The identifier of the Cookie Consent Configuration to be updated.

Request Body schema: application/json

required

The properties to be updated on the Cookie Consent Configuration. Note: this allows for a partial update, so all fields are optional.

name	string The name of the configuration.
domains	Array of strings non-empty A list of domains (cannot be null or empty) that are permitted to host the configuration.
mode	string Enum: "debug" "permissive" "production" The compliance mode for the configuration. debug: Discovery/Listener Mode - Script and cookie information will be gathered for categorization, but blocking will not occur and the consent dialog will not be displayed. permissive: Permissive Mode - The consent dialog will be displayed. All uncategorized scripts will be reported as discoveries and allowed regardless of consent given. All categorized scripts will be allowed or blocked based on the user selection. production: Strict Mode (recommended) - The consent dialog will be displayed, and all uncategorized scripts will be blocked until they have been classified. Note: It is recommended that all discovered scripts & cookies are classified before changing the mode to production as all unclassified entities will be blocked. For more information, see Compliance Mode Definitions in the Cmp Setup Guide
	object non-empty

Responses

Production API

https://api.osano.com/v1/cookie-consent/configs/{configId}

Request samples

• Payload

Content type

application/json

{

• "name": "string",
• "domains": [

  • "string"

  ],
• "mode": "debug",
• "configuration": {

  • "additionalLinks": [

    • [

      • "string",
      • "string"

      ]

    ],
  • "allowTimeout": true,
  • "ccpaRelaxed": true,
  • "codeSplitting": true,
  • "crossDomain": true,
  • "dntSupport": true,
  • "forcedClassifyEnabled": true,
  • "forceManagePreferences": true,
  • "googleConsent": true,
  • "gpcSupport": true,
  • "iframeBlocking": "",
  • "managePreferencesEnabled": true,
  • "palette": {

    • "buttonBackgroundColor": "string",
    • "buttonDenyBackgroundColor": "string",
    • "buttonDenyForegroundColor": "string",
    • "buttonForegroundColor": "string",
    • "dialogBackgroundColor": "string",
    • "dialogForegroundColor": "string",
    • "dialogType": "bar",
    • "displayPosition": "string",
    • "infoDialogBackgroundColor": "string",
    • "infoDialogForegroundColor": "string",
    • "infoDialogOverlayColor": "string",
    • "infoDialogPosition": "right",
    • "linkColor": "string",
    • "toggleButtonOnColor": "string",
    • "toggleButtonOffColor": "string",
    • "toggleOnBackgroundColor": "string",
    • "toggleOffBackgroundColor": "string",
    • "widgetPosition": "right"

    },
  • "policyLinkText": "cookieNotice",
  • "policyLinkInDrawer": true,
  • "storagePolicyHref": "string",
  • "timeoutSeconds": 0

  }

}

Response samples

• 200
• 400

Content type

application/json

{

• "name": "string",
• "domains": [

  • "string"

  ],
• "mode": "debug",
• "configuration": {

  • "additionalLinks": [

    • [

      • "string",
      • "string"

      ]

    ],
  • "allowTimeout": true,
  • "ccpaRelaxed": true,
  • "codeSplitting": true,
  • "crossDomain": true,
  • "dntSupport": true,
  • "forcedClassifyEnabled": true,
  • "forceManagePreferences": true,
  • "googleConsent": true,
  • "gpcSupport": true,
  • "iframeBlocking": "",
  • "managePreferencesEnabled": true,
  • "palette": {

    • "buttonBackgroundColor": "string",
    • "buttonDenyBackgroundColor": "string",
    • "buttonDenyForegroundColor": "string",
    • "buttonForegroundColor": "string",
    • "dialogBackgroundColor": "string",
    • "dialogForegroundColor": "string",
    • "dialogType": "bar",
    • "displayPosition": "string",
    • "infoDialogBackgroundColor": "string",
    • "infoDialogForegroundColor": "string",
    • "infoDialogOverlayColor": "string",
    • "infoDialogPosition": "right",
    • "linkColor": "string",
    • "toggleButtonOnColor": "string",
    • "toggleButtonOffColor": "string",
    • "toggleOnBackgroundColor": "string",
    • "toggleOffBackgroundColor": "string",
    • "widgetPosition": "right"

    },
  • "policyLinkText": "cookieNotice",
  • "policyLinkInDrawer": true,
  • "storagePolicyHref": "string",
  • "timeoutSeconds": 0

  },
• "created": 0,
• "updated": 0,
• "publishStatus": "unpublished",
• "lastPublished": 0,
• "publishedRevision": 0,
• "tattleRecordStopped": true,
• "configId": "46ff6d11-d8b2-40d8-9197-dfa33c61cd6c",
• "customerId": "string"

}

Publish Cookie Consent Configuration

Publish an existing Cookie Consent Configuration.

Guidelines for publishing a configuration:

• A configuration cannot be queued again for publishing until the publish operation is complete. It's recommended that all configuration changes are made prior to sending a publish request for that configuration.
• A maximum of 300 configs per customer account can be queued for publishing at a time.
• It's recommended to send a batch of publish requests (up to 250 requests) every 30 minutes. Note: this is not the equivalent to sending X number of publish requests per minute over a 30 minute period."

Authorizations:

ApiKeyAuth

path Parameters

configId required

string The identifier of the Cookie Consent Configuration to be published.

Request Body schema: application/json

required

keepUnclassifiedTattles	boolean When true, unclassified cookie/script/iframe discoveries will not be deleted. When false, all unclassified cookie/script/iframe discoveries will be deleted.
description	string When included in the request, allows for text comments provided about the publish to be retained with the version number for reference in the Osano Admin UI.
webhookUrl	string The URL to be called when the publish operation is complete.

Responses

Production API

https://api.osano.com/v1/cookie-consent/configs/{configId}/publish

Request samples

• Payload

Content type

application/json

{

• "keepUnclassifiedTattles": true,
• "description": "string",
• "webhookUrl": "string"

}

Response samples

• 400
• 404
• 409
• 429

Content type

application/json

{

• "message": "string"

}

List Configuration Discoveries

Retrieve a list of Discoveries for a Cookie Consent Configuration by configuration ID.

Authorizations:

ApiKeyAuth

path Parameters

configId required

string The identifier of the Cookie Consent Configuration to be queried.

query Parameters

type	string Default: "cookie" Enum: "cookie" "script" "iframe" The type of Discovery to be returned. If omitted, only cookie type discoveries are returned.

Responses

Production API

https://api.osano.com/v1/cookie-consent/configs/{configId}/discoveries

Response samples

• 200
• 400

Content type

application/json

{

• "items": [

  • {

    • "configId": "46ff6d11-d8b2-40d8-9197-dfa33c61cd6c",
    • "customerId": "string",
    • "storeKey": "string",
    • "storeType": "string",
    • "created": "2019-08-24T14:15:22Z",
    • "updated": "2019-08-24T14:15:22Z"

    }

  ]

}

List Configuration Rules

Retrieve a list of Rules for a Cookie Consent Configuration by configuration ID.

Authorizations:

ApiKeyAuth

path Parameters

configId required

string The identifier of the Cookie Consent Configuration to be queried.

query Parameters

type	string Enum: "cookie" "script" "iframe" The type of Rule to be returned. If omitted, all rule types are returned.
classification	string Enum: "ESSENTIAL" "ANALYTICS" "MARKETING" "PERSONALIZATION" "HIDDEN" "BLACKLISTED" The type of rule classification to be returned.
limit	integer <int32> <= 500 Default: 100 The number of items to return.
next	string The pagination token from the previous request.

Responses

Production API

https://api.osano.com/v1/cookie-consent/configs/{configId}/rules

Response samples

• 200
• 400
• 404

Content type

application/json

{

• "items": [

  • {

    • "classification": "ANALYTICS",
    • "rule": "string",
    • "vendorName": "string",
    • "type": "cookie",
    • "ruleId": 0,
    • "configId": "46ff6d11-d8b2-40d8-9197-dfa33c61cd6c",
    • "vendorId": "string",
    • "created": "2019-08-24T14:15:22Z",
    • "updated": "2019-08-24T14:15:22Z"

    }

  ]

}

Cookie Consent Discoveries & Rules

Create New Cookie Consent Rules

Create one or more Cookie Consent Rules. The maximum number of rules that may be created in a single call is 100. If the request is successful, the response will contain a list of the created rules.

Authorizations:

ApiKeyAuth

Request Body schema: application/json

required

The Cookie Consent Rule(s) to be created and the ID(s) of the config(s) to create them for.

configIds required	Array of strings <uuid> [ 1 .. 25 ] items [ items <uuid > ]
	Array of objects (CmpCookieRuleRequiredProps) non-empty [ items non-empty ]
	Array of objects (CmpRuleRequiredProps) non-empty [ items non-empty ]
	Array of objects (CmpRuleRequiredProps) non-empty [ items non-empty ]

Responses

Production API

https://api.osano.com/v1/cookie-consent/rules

Request samples

• Payload

Content type

application/json

{

• "configIds": [

  • "497f6eca-6276-4993-bfeb-53cbbbba6f08"

  ],
• "cookies": [

  • {

    • "classification": "ANALYTICS",
    • "rule": "string",
    • "vendorName": "string",
    • "description": "string",
    • "disclosure": true,
    • "expiry": "string"

    }

  ],
• "iframes": [

  • {

    • "classification": "ANALYTICS",
    • "rule": "string",
    • "vendorName": "string"

    }

  ],
• "scripts": [

  • {

    • "classification": "ANALYTICS",
    • "rule": "string",
    • "vendorName": "string"

    }

  ]

}

Response samples

• 200
• 400
• 409
• 429

Content type

application/json

{

• "items": [

  • {

    • "classification": "ANALYTICS",
    • "rule": "string",
    • "vendorName": "string",
    • "type": "cookie",
    • "ruleId": 0,
    • "configId": "46ff6d11-d8b2-40d8-9197-dfa33c61cd6c",
    • "vendorId": "string",
    • "created": "2019-08-24T14:15:22Z",
    • "updated": "2019-08-24T14:15:22Z"

    }

  ]

}

Update Cookie Consent Rule

Update an existing Cookie Consent Rule by ID.

Authorizations:

ApiKeyAuth

path Parameters

ruleId required

integer <int32> The identifier of the Cookie Consent Rule to be updated.

Request Body schema: application/json

required

The Cookie Consent Rule property(ies) to be updated.

Any of

non-empty

classification	string Enum: "ANALYTICS" "BLACKLISTED" "ESSENTIAL" "HIDDEN" "MARKETING" "PERSONALIZATION"
rule	string [ 3 .. 1000 ] characters The type of the rule.
vendorName	string or null <= 100 characters The value of the rule.

Responses

Production API

https://api.osano.com/v1/cookie-consent/rules/{ruleId}

Request samples

• Payload

Content type

application/json

Example

CmpRuleCmpCookieRuleCmpRule

{

• "classification": "ANALYTICS",
• "rule": "string",
• "vendorName": "string"

}

Response samples

• 200
• 400

Content type

application/json

Example

CmpCookieRule

{

• "classification": "ANALYTICS",
• "rule": "string",
• "vendorName": "string",
• "type": "cookie",
• "ruleId": 0,
• "configId": "46ff6d11-d8b2-40d8-9197-dfa33c61cd6c",
• "vendorId": "string",
• "created": "2019-08-24T14:15:22Z",
• "updated": "2019-08-24T14:15:22Z"

}

Delete Cookie Consent Rule

Deletes a single Cookie Consent Rule by ID.

Authorizations:

ApiKeyAuth

path Parameters

ruleId required

integer <int32> The identifier of the Cookie Consent Rule to be deleted.

Responses

Production API

https://api.osano.com/v1/cookie-consent/rules/{ruleId}

Response samples

• 400
• 404

Content type

application/json

{

• "message": "string"

}

Data Mapping Connectors

List Connectors (DEPRECATED)

Deprecated: Please use /v1/data-discovery/connectors instead

Authorizations:

ApiKeyAuth

query Parameters

limit	integer <int32> <= 500 Default: 100 The number of items to return.
next	string The pagination token from the previous request.
name	string Product name to filter by. This may return partial matches.
type	string Enum: "saas" "onprem" The type of Connectors to be returned. By default, all Connectors are returned.

Responses

Production API

https://api.osano.com/v1/connectors

Response samples

• 200
• 400

Content type

application/json

{

• "items": [

  • {

    • "connectorId": 0,
    • "productName": "string",
    • "authType": "string"

    }

  ],
• "next": "string"

}

List Connectors

Returns a detailed list of connectors by type (On-Prem or SaaS) available in the Osano platform.

Authorizations:

ApiKeyAuth

query Parameters

limit	integer <int32> <= 500 Default: 100 The number of items to return.
next	string The pagination token from the previous request.
name	string Product name to filter by. This may return partial matches.
type	string Enum: "saas" "onprem" The type of Connectors to be returned. By default, all Connectors are returned.

Responses

Production API

https://api.osano.com/v1/data-discovery/connectors

Response samples

• 200
• 400

Content type

application/json

{

• "items": [

  • {

    • "connectorId": 0,
    • "productName": "string",
    • "authType": "string"

    }

  ],
• "next": "string"

}

Subject Rights

List Subject Rights Requests (DEPRECATED)

Deprecated: Please use /v1/subject-rights/requests instead

Authorizations:

ApiKeyAuth

query Parameters

limit	integer <int32> <= 500 Default: 100 The number of items to return.
next	string The pagination token from the previous request.
after	string Specify UTC date and time in ISO-8601 format (e.g. 2021-01-01T00:00:00Z) to filter items created after this date.
source	string Enum: "EMAIL_INTAKE" "WEB" "API" Source filter for the request. Must be one of EMAIL_INTAKE, WEB, or API.
status	string Enum: "PENDING_IDENTITY_VERIFICATION" "IN_PROGRESS" "IN_REVIEW" "COMPLETED" "REJECTED" Status filter for the request. Must be one of PENDING_IDENTITY_VERIFICATION, IN_PROGRESS, IN_REVIEW, COMPLETED, or REJECTED.
requestType	string Enum: "DELETE" "CORRECT" "SUMMARIZE" "DO_NOT_SELL" "OPT_OUT" "LIMIT_USE" "OTHER" "PORTABILITY" "CUSTOM_1" "CUSTOM_2" "CUSTOM_3" "CUSTOM_4" "CUSTOM_5" Request type filter for the request. Must be one of DELETE, CORRECT, SUMMARIZE, DO_NOT_SELL, OPT_OUT, LIMIT_USE, OTHER, PORTABILITY, or CUSTOM_[1-5]
formId	integer <int32> Form identifier through which the Subject Rights Request was made.

Responses

Production API

https://api.osano.com/v1/dsar

Response samples

• 200
• 400

Content type

application/json

{

• "items": [

  • {

    • "dsarId": "string",
    • "status": "string",
    • "requestType": "string",
    • "requestSource": "string",
    • "notes": "string",
    • "dsarDetails": { },
    • "due": "2019-08-24T14:15:22Z",
    • "created": "2019-08-24T14:15:22Z",
    • "form": {

      • "formId": 0,
      • "formName": "string"

      }

    }

  ],
• "next": "string"

}

Create New Subject Rights Request(s) (DEPRECATED)

Deprecated: Please use /v1/subject-rights/requests instead

Authorizations:

ApiKeyAuth

Request Body schema: application/json

required

The Subject Rights Request(s) to be created.

Array (<= 100 items)

formId required	integer
requestType required	string
status required	string
due	string <date-time>
lastUpdated	string <date-time>
lastUpdatedBy	string <email>
notes	string
required	object

Responses

Production API

https://api.osano.com/v1/dsar

Request samples

• Payload

Content type

application/json

[

• {

  • "formId": 0,
  • "requestType": "string",
  • "status": "string",
  • "due": "2019-08-24T14:15:22Z",
  • "lastUpdated": "2019-08-24T14:15:22Z",
  • "lastUpdatedBy": "user@example.com",
  • "notes": "string",
  • "dsarDetails": {

    • "email": "user@example.com",
    • "given-name": "string",
    • "family-name": "string"

    }

  }

]

Response samples

• 200
• 400

Content type

application/json

{

• "items": [

  • {

    • "dsarId": "string",
    • "status": "string",
    • "requestType": "string",
    • "requestSource": "string",
    • "notes": "string",
    • "dsarDetails": { },
    • "due": "2019-08-24T14:15:22Z",
    • "created": "2019-08-24T14:15:22Z",
    • "form": {

      • "formId": 0,
      • "formName": "string"

      }

    }

  ],
• "next": "string"

}

Return Detailed Subject Rights Request (DEPRECATED)

Deprecated: Please use /v1/subject-rights/requests/{dsarId} instead

Authorizations:

ApiKeyAuth

path Parameters

dsarId required

string The identifier of the Subject Rights Request to return.

Responses

Production API

https://api.osano.com/v1/dsar/{dsarId}

Response samples

• 200
• 404

Content type

application/json

{

• "dsarId": "string",
• "status": "string",
• "requestType": "string",
• "requestSource": "string",
• "notes": "string",
• "dsarDetails": { },
• "due": "2019-08-24T14:15:22Z",
• "created": "2019-08-24T14:15:22Z",
• "form": {

  • "formId": 0,
  • "formName": "string"

  }

}

Update Subject Rights Request (DEPRECATED)

Deprecated: Please use /v1/subject-rights/requests/{dsarId} instead

Authorizations:

ApiKeyAuth

path Parameters

dsarId required

string The identifier of the Subject Rights Request to be updated.

Request Body schema: application/json

required

Object containing the fields to be updated.

status	string
notes	string
property name* additional property	any

Responses

Production API

https://api.osano.com/v1/dsar/{dsarId}

Request samples

• Payload

Content type

application/json

{

• "status": "string",
• "notes": "string"

}

Response samples

• 200
• 400
• 404

Content type

application/json

{

• "dsarId": "string",
• "status": "string",
• "requestType": "string",
• "requestSource": "string",
• "notes": "string",
• "dsarDetails": { },
• "due": "2019-08-24T14:15:22Z",
• "created": "2019-08-24T14:15:22Z",
• "form": {

  • "formId": 0,
  • "formName": "string"

  }

}

Update Identification Photo (DEPRECATED)

Deprecated: Please use /v1/subject-rights/requests/{dsarId}/identification instead

Authorizations:

ApiKeyAuth

path Parameters

dsarId required

string The identifier of the Subject Rights Request to be updated.

Request Body schema:

image/webpimage/jpegimage/pngapplication/octet-streamimage/webp

string <binary>

Responses

Production API

https://api.osano.com/v1/dsar/{dsarId}/identification

Response samples

• 400
• 404

Content type

application/json

{

• "message": "string"

}

List Subject Rights Requests

Query for Subject Rights Requests. Results are sorted in descending order by creation time. The number of results returned may be controlled via the limit param, but may not exceed 500. The "next" object in the response may be used to retrieve subsequent pages of the same resource.

Authorizations:

ApiKeyAuth

query Parameters

limit	integer <int32> <= 500 Default: 100 The number of items to return.
next	string The pagination token from the previous request.
after	string Specify UTC date and time in ISO-8601 format (e.g. 2021-01-01T00:00:00Z) to filter items created after this date.
source	string Enum: "EMAIL_INTAKE" "WEB" "API" Source filter for the request. Must be one of EMAIL_INTAKE, WEB, or API.
status	string Enum: "PENDING_IDENTITY_VERIFICATION" "IN_PROGRESS" "IN_REVIEW" "COMPLETED" "REJECTED" Status filter for the request. Must be one of PENDING_IDENTITY_VERIFICATION, IN_PROGRESS, IN_REVIEW, COMPLETED, or REJECTED.
requestType	string Enum: "DELETE" "CORRECT" "SUMMARIZE" "DO_NOT_SELL" "OPT_OUT" "LIMIT_USE" "OTHER" "PORTABILITY" "CUSTOM_1" "CUSTOM_2" "CUSTOM_3" "CUSTOM_4" "CUSTOM_5" Request type filter for the request. Must be one of DELETE, CORRECT, SUMMARIZE, DO_NOT_SELL, OPT_OUT, LIMIT_USE, OTHER, PORTABILITY, or CUSTOM_[1-5]
formId	integer <int32> Form identifier through which the Subject Rights Request was made.

Responses

Production API

https://api.osano.com/v1/subject-rights/requests

Response samples

• 200
• 400

Content type

application/json

{

• "items": [

  • {

    • "dsarId": "string",
    • "status": "string",
    • "requestType": "string",
    • "requestSource": "string",
    • "notes": "string",
    • "dsarDetails": { },
    • "due": "2019-08-24T14:15:22Z",
    • "created": "2019-08-24T14:15:22Z",
    • "form": {

      • "formId": 0,
      • "formName": "string"

      }

    }

  ],
• "next": "string"

}

Create New Subject Rights Request(s)

Create one or more Subject Rights Requests. The maximum number of requests that may be created in a single call is 100. If the request is successful, the response will contain a list of the created requests.

Authorizations:

ApiKeyAuth

Request Body schema: application/json

required

The Subject Rights Request(s) to be created.

Array (<= 100 items)

formId required	integer
requestType required	string
status required	string
due	string <date-time>
lastUpdated	string <date-time>
lastUpdatedBy	string <email>
notes	string
required	object

Responses

Production API

https://api.osano.com/v1/subject-rights/requests

Request samples

• Payload

Content type

application/json

[

• {

  • "formId": 0,
  • "requestType": "string",
  • "status": "string",
  • "due": "2019-08-24T14:15:22Z",
  • "lastUpdated": "2019-08-24T14:15:22Z",
  • "lastUpdatedBy": "user@example.com",
  • "notes": "string",
  • "dsarDetails": {

    • "email": "user@example.com",
    • "given-name": "string",
    • "family-name": "string"

    }

  }

]

Response samples

• 200
• 400

Content type

application/json

{

• "items": [

  • {

    • "dsarId": "string",
    • "status": "string",
    • "requestType": "string",
    • "requestSource": "string",
    • "notes": "string",
    • "dsarDetails": { },
    • "due": "2019-08-24T14:15:22Z",
    • "created": "2019-08-24T14:15:22Z",
    • "form": {

      • "formId": 0,
      • "formName": "string"

      }

    }

  ],
• "next": "string"

}

Return Detailed Subject Rights Request

Get a detailed Subject Rights Request by ID.

Authorizations:

ApiKeyAuth

path Parameters

dsarId required

string The identifier of the Subject Rights Request to return.

Responses

Production API

https://api.osano.com/v1/subject-rights/requests/{dsarId}

Response samples

• 200
• 404

Content type

application/json

{

• "dsarId": "string",
• "status": "string",
• "requestType": "string",
• "requestSource": "string",
• "notes": "string",
• "dsarDetails": { },
• "due": "2019-08-24T14:15:22Z",
• "created": "2019-08-24T14:15:22Z",
• "form": {

  • "formId": 0,
  • "formName": "string"

  }

}

Update Subject Rights Request

Update metadata about a Subject Rights Request as specified. A partial update may be performed.

Authorizations:

ApiKeyAuth

path Parameters

dsarId required

string The identifier of the Subject Rights Request to be updated.

Request Body schema: application/json

required

Object containing the fields to be updated.

status	string
notes	string
property name* additional property	any

Responses

Production API

https://api.osano.com/v1/subject-rights/requests/{dsarId}

Request samples

• Payload

Content type

application/json

{

• "status": "string",
• "notes": "string"

}

Response samples

• 200
• 400
• 404

Content type

application/json

{

• "dsarId": "string",
• "status": "string",
• "requestType": "string",
• "requestSource": "string",
• "notes": "string",
• "dsarDetails": { },
• "due": "2019-08-24T14:15:22Z",
• "created": "2019-08-24T14:15:22Z",
• "form": {

  • "formId": 0,
  • "formName": "string"

  }

}

Update Identification Photo

Updates the file used for Identity Verification within the Osano platform. It should be an image.

Authorizations:

ApiKeyAuth

path Parameters

dsarId required

string The identifier of the Subject Rights Request to be updated.

Request Body schema:

image/webpimage/jpegimage/pngapplication/octet-streamimage/webp

string <binary>

Responses

Production API

https://api.osano.com/v1/subject-rights/requests/{dsarId}/identification

Response samples

• 400
• 404

Content type

application/json

{

• "message": "string"

}

Data Discovery

List Data Stores

Returns a list of Data Stores. Results are sorted in descending order by creation time. The number of results returned may be controlled via the limit param, but may not exceed 500. The "next" object in the response may be used to retrieve subsequent pages of the same resource.

Authorizations:

ApiKeyAuth

query Parameters

limit	integer <int32> <= 500 Default: 100 The number of items to return.
next	string The pagination token from the previous request.
after	string Specify UTC date and time in ISO-8601 format (e.g. 2021-01-01T00:00:00Z) to filter items created after this date.
connectorId	integer <int32> Optional connector identifier to filter data stores by. This value is ignored when the Data Store type is 'internal'.
active	boolean The active status of the Data Stores to be returned. If omitted, only active Data Stores are returned.
name	string <= 64 characters The name of the Data Stores to be returned. Partial matches will also be returned.
type	string Enum: "internal" "saas" "onprem" The type of the Data Stores to be returned. If omitted, all Data Stores are returned.

Responses

Production API

https://api.osano.com/v1/data-discovery/data-stores

Response samples

• 200
• 400

Content type

application/json

{

• "items": [

  • {

    • "dataStoreId": 0,
    • "name": "string",
    • "description": "string",
    • "alias": "string",
    • "type": "string",
    • "active": true,
    • "created": "2019-08-24T14:15:22Z",
    • "connector": {

      • "connectorId": 0,
      • "productName": "string",
      • "authType": "string"

      },
    • "owners": [

      • {

        • "email": "user@example.com",
        • "primary": true

        }

      ]

    }

  ],
• "next": "string"

}

Create New Data Store

Creates a new Data Store using the provided parameters. If successful, the created Data Store will be returned.

Authorizations:

ApiKeyAuth

Request Body schema: application/json

required

Details of the Data Store to be created.

name required	string [ 1 .. 64 ] characters
description	string [ 1 .. 256 ] characters
alias	string [ 1 .. 64 ] characters
connectorId	integer <int32>
	Array of objects (DataStoreOwner) non-empty
property name* additional property	any

Responses

Production API

https://api.osano.com/v1/data-discovery/data-stores

Request samples

• Payload

Content type

application/json

{

• "name": "string",
• "description": "string",
• "alias": "string",
• "connectorId": 0,
• "owners": [

  • {

    • "email": "user@example.com",
    • "primary": true

    }

  ]

}

Response samples

• 200
• 400

Content type

application/json

{

• "dataStoreId": 0,
• "name": "string",
• "description": "string",
• "alias": "string",
• "type": "string",
• "active": true,
• "created": "2019-08-24T14:15:22Z",
• "connector": {

  • "connectorId": 0,
  • "productName": "string",
  • "authType": "string"

  },
• "owners": [

  • {

    • "email": "user@example.com",
    • "primary": true

    }

  ]

}

Return Single Data Store

Returns a detailed Data Store by ID.

Authorizations:

ApiKeyAuth

path Parameters

dataStoreId required

string The identifier of the Data Store to be returned.

Responses

Production API

https://api.osano.com/v1/data-discovery/data-stores/{dataStoreId}

Response samples

• 200
• 400
• 404

Content type

application/json

{

• "dataStoreId": 0,
• "name": "string",
• "description": "string",
• "alias": "string",
• "type": "string",
• "active": true,
• "created": "2019-08-24T14:15:22Z",
• "connector": {

  • "connectorId": 0,
  • "productName": "string",
  • "authType": "string"

  },
• "owners": [

  • {

    • "email": "user@example.com",
    • "primary": true

    }

  ]

}

Deactivate a data store

Deactivate a Data Store by ID. This will prevent the Data Store from being used in future Data Mapping operations.

Authorizations:

ApiKeyAuth

path Parameters

dataStoreId required

string The identifier of the Data Store to be deactivated.

Responses

Production API

https://api.osano.com/v1/data-discovery/data-stores/{dataStoreId}

Response samples

• 404

Content type

application/json

{

• "message": "string"

}

Update an existing data store

Update specific properties about a Data Store by ID.

Authorizations:

ApiKeyAuth

path Parameters

dataStoreId required

string The identifier of the Data Store to be updated.

Request Body schema: application/json

required

The properties to be updated in the Data Store. Note that this allows for a partial update, not all fields are required.

name	string
description	string or null
alias	string or null
	Array of objects (DataStoreOwner)
property name* additional property	any

Responses

Production API

https://api.osano.com/v1/data-discovery/data-stores/{dataStoreId}

Request samples

• Payload

Content type

application/json

{

• "name": "string",
• "description": "string",
• "alias": "string",
• "owners": [

  • {

    • "email": "user@example.com",
    • "primary": true

    }

  ]

}

Update Data Store Fields

Add to the list of personal data fields for a particular Data Store. Note that fields may not have the same path and name as an existing field. Any such fields in the payload will be ignored.

Authorizations:

ApiKeyAuth

path Parameters

dataStoreId required

string The identifier of the Data Store to be updated.

Request Body schema: application/json

required

An array of personal data fields to be added to this Data Store.

Array

name	string [ 1 .. 64 ] characters
path	string or null
classification	string or null <= 32 characters

Responses

Production API

https://api.osano.com/v1/data-discovery/data-stores/{dataStoreId}/fields

Request samples

• Payload

Content type

application/json

[

• {

  • "name": "string",
  • "path": "string",
  • "classification": "string"

  }

]

Response samples

• 400
• 404

Content type

application/json

{

• "message": "string"

}

Returns Data Store Fields

Returns a list of personal data fields for a particular Data Store.

Authorizations:

ApiKeyAuth

path Parameters

dataStoreId required

string The identifier of the Data Store being queried.

query Parameters

limit	integer <int32> <= 500 Default: 100 The number of items to return.
next	string The pagination token from the previous request.

Responses

Production API

https://api.osano.com/v1/data-discovery/data-stores/{dataStoreId}/fields

Response samples

• 200
• 400
• 404

Content type

application/json

{

• "items": [

  • {

    • "fieldId": 0,
    • "name": "string",
    • "path": "string",
    • "classification": "string",
    • "created": "2019-08-24T14:15:22Z"

    }

  ],
• "next": "string"

}

Delete Data Store Field

Deletes a single Data Store Field by ID.

Authorizations:

ApiKeyAuth

path Parameters

dataStoreId required	string The identifier of the Data Store being queried.
fieldId required	string The identifier of the Data Store Field being deleted.

Responses

Production API

https://api.osano.com/v1/data-discovery/data-stores/{dataStoreId}/fields/{fieldId}

Response samples

• 400
• 404

Content type

application/json

{

• "message": "string"

}

Update Data Store Field

Updates a single Data Store Field by ID. Note that this allows for a partial update, not all fields are required.

Authorizations:

ApiKeyAuth

path Parameters

dataStoreId required	string The identifier of the Data Store being queried.
fieldId required	string The identifier of the Data Store Field being updated.

Request Body schema: application/json

required

Field data to be updated.

name	string [ 1 .. 64 ] characters
path	string or null
classification	string or null <= 32 characters

Responses

Production API

https://api.osano.com/v1/data-discovery/data-stores/{dataStoreId}/fields/{fieldId}

Request samples

• Payload

Content type

application/json

{

• "name": "string",
• "path": "string",
• "classification": "string"

}

Response samples

• 400
• 404

Content type

application/json

{

• "message": "string"

}

List Data Stores (DEPRECATED)

Deprecated: Please use /v1/data-discovery/data-stores instead

Authorizations:

ApiKeyAuth

query Parameters

limit	integer <int32> <= 500 Default: 100 The number of items to return.
next	string The pagination token from the previous request.
after	string Specify UTC date and time in ISO-8601 format (e.g. 2021-01-01T00:00:00Z) to filter items created after this date.
connectorId	integer <int32> Optional connector identifier to filter data stores by. This value is ignored when the Data Store type is 'internal'.
active	boolean The active status of the Data Stores to be returned. If omitted, only active Data Stores are returned.
name	string <= 64 characters The name of the Data Stores to be returned. Partial matches will also be returned.
type	string Enum: "internal" "saas" "onprem" The type of the Data Stores to be returned. If omitted, all Data Stores are returned.

Responses

Production API

https://api.osano.com/v1/data-stores

Response samples

• 200
• 400

Content type

application/json

{

• "items": [

  • {

    • "dataStoreId": 0,
    • "name": "string",
    • "description": "string",
    • "alias": "string",
    • "type": "string",
    • "active": true,
    • "created": "2019-08-24T14:15:22Z",
    • "connector": {

      • "connectorId": 0,
      • "productName": "string",
      • "authType": "string"

      },
    • "owners": [

      • {

        • "email": "user@example.com",
        • "primary": true

        }

      ]

    }

  ],
• "next": "string"

}

Create New Data Store (DEPRECATED)

Deprecated: Please use /v1/data-discovery/data-stores instead

Authorizations:

ApiKeyAuth

Request Body schema: application/json

required

Details of the Data Store to be created.

name required	string [ 1 .. 64 ] characters
description	string [ 1 .. 256 ] characters
alias	string [ 1 .. 64 ] characters
connectorId	integer <int32>
	Array of objects (DataStoreOwner) non-empty
property name* additional property	any

Responses

Production API

https://api.osano.com/v1/data-stores

Request samples

• Payload

Content type

application/json

{

• "name": "string",
• "description": "string",
• "alias": "string",
• "connectorId": 0,
• "owners": [

  • {

    • "email": "user@example.com",
    • "primary": true

    }

  ]

}

Response samples

• 200
• 400

Content type

application/json

{

• "dataStoreId": 0,
• "name": "string",
• "description": "string",
• "alias": "string",
• "type": "string",
• "active": true,
• "created": "2019-08-24T14:15:22Z",
• "connector": {

  • "connectorId": 0,
  • "productName": "string",
  • "authType": "string"

  },
• "owners": [

  • {

    • "email": "user@example.com",
    • "primary": true

    }

  ]

}

Return Single Data Store (DEPRECATED)

Deprecated: Please use /v1/data-discovery/data-stores/{dataStoreId} instead

Authorizations:

ApiKeyAuth

path Parameters

dataStoreId required

string The identifier of the Data Store to be returned.

Responses

Production API

https://api.osano.com/v1/data-stores/{dataStoreId}

Response samples

• 200
• 400
• 404

Content type

application/json

{

• "dataStoreId": 0,
• "name": "string",
• "description": "string",
• "alias": "string",
• "type": "string",
• "active": true,
• "created": "2019-08-24T14:15:22Z",
• "connector": {

  • "connectorId": 0,
  • "productName": "string",
  • "authType": "string"

  },
• "owners": [

  • {

    • "email": "user@example.com",
    • "primary": true

    }

  ]

}

Deactivate a data store (DEPRECATED)

Deprecated: Please use /v1/data-discovery/data-stores/{dataStoreId} instead

Authorizations:

ApiKeyAuth

path Parameters

dataStoreId required

string The identifier of the Data Store to be deactivated.

Responses

Production API

https://api.osano.com/v1/data-stores/{dataStoreId}

Response samples

• 404

Content type

application/json

{

• "message": "string"

}

Update an existing data store (DEPRECATED)

Deprecated: Please use /v1/data-discovery/data-stores/{dataStoreId} instead

Authorizations:

ApiKeyAuth

path Parameters

dataStoreId required

string The identifier of the Data Store to be updated.

Request Body schema: application/json

required

The properties to be updated in the Data Store. Note that this allows for a partial update, not all fields are required.

name	string
description	string or null
alias	string or null
	Array of objects (DataStoreOwner)
property name* additional property	any

Responses

Production API

https://api.osano.com/v1/data-stores/{dataStoreId}

Request samples

• Payload

Content type

application/json

{

• "name": "string",
• "description": "string",
• "alias": "string",
• "owners": [

  • {

    • "email": "user@example.com",
    • "primary": true

    }

  ]

}

Update Data Store Fields (DEPRECATED)

Deprecated: Please use /v1/data-discovery/data-stores/{dataStoreId}/fields instead

Authorizations:

ApiKeyAuth

path Parameters

dataStoreId required

string The identifier of the Data Store to be updated.

Request Body schema: application/json

required

An array of personal data fields to be added to this Data Store.

Array

name	string [ 1 .. 64 ] characters
path	string or null
classification	string or null <= 32 characters

Responses

Production API

https://api.osano.com/v1/data-stores/{dataStoreId}/fields

Request samples

• Payload

Content type

application/json

[

• {

  • "name": "string",
  • "path": "string",
  • "classification": "string"

  }

]

Response samples

• 400
• 404

Content type

application/json

{

• "message": "string"

}

Returns Data Store Fields (DEPRECATED)

Deprecated: Please use /v1/data-discovery/data-stores/{dataStoreId}/fields instead

Authorizations:

ApiKeyAuth

path Parameters

dataStoreId required

string The identifier of the Data Store being queried.

query Parameters

limit	integer <int32> <= 500 Default: 100 The number of items to return.
next	string The pagination token from the previous request.

Responses

Production API

https://api.osano.com/v1/data-stores/{dataStoreId}/fields

Response samples

• 200
• 400
• 404

Content type

application/json

{

• "items": [

  • {

    • "fieldId": 0,
    • "name": "string",
    • "path": "string",
    • "classification": "string",
    • "created": "2019-08-24T14:15:22Z"

    }

  ],
• "next": "string"

}

Delete Data Store Field (DEPRECATED)

Deprecated: Please use /v1/data-discovery/data-stores/{dataStoreId}/fields/{fieldId} instead

Authorizations:

ApiKeyAuth

path Parameters

dataStoreId required	string The identifier of the Data Store being queried.
fieldId required	string The identifier of the Data Store Field being deleted.

Responses

Production API

https://api.osano.com/v1/data-stores/{dataStoreId}/fields/{fieldId}

Response samples

• 400
• 404

Content type

application/json

{

• "message": "string"

}

Update Data Store Field (DEPRECATED)

Deprecated: Please use /v1/data-discovery/data-stores/{dataStoreId}/fields/{fieldId} instead

Authorizations:

ApiKeyAuth

path Parameters

dataStoreId required	string The identifier of the Data Store being queried.
fieldId required	string The identifier of the Data Store Field being updated.

Request Body schema: application/json

required

Field data to be updated.

name	string [ 1 .. 64 ] characters
path	string or null
classification	string or null <= 32 characters

Responses

Production API

https://api.osano.com/v1/data-stores/{dataStoreId}/fields/{fieldId}

Request samples

• Payload

Content type

application/json

{

• "name": "string",
• "path": "string",
• "classification": "string"

}

Response samples

• 400
• 404

Content type

application/json

{

• "message": "string"

}

Subject Rights Action Items

List Subject Rights Action Items (DEPRECATED)

Deprecated: Please use /v1/subject-rights/action-items instead

Authorizations:

ApiKeyAuth

query Parameters

dsarId	string The id of the Subject Rights request to filter by
status	Array of strings Status filter for the request. Must be one of CLAIMED, IN_PROGRESS, COMPLETED, or REJECTED.
limit	integer <int32> <= 500 Default: 100 The number of items to return.
next	string The pagination token from the previous request.
after	string Specify UTC date and time in ISO-8601 format (e.g. 2021-01-01T00:00:00Z) to filter items created after this date.

Responses

Production API

https://api.osano.com/v1/dsar-action-items

Response samples

• 200
• 400
• 404

Content type

application/json

{

• "items": [

  • {

    • "dsarActionItemId": 0,
    • "assignees": [

      • "user@example.com"

      ],
    • "dataStore": {

      • "dataStoreId": 0,
      • "name": "string"

      },
    • "dsarId": "string",
    • "dsarDetails": { },
    • "due": "2019-08-24T14:15:22Z",
    • "created": "2019-08-24T14:15:22Z",
    • "status": "string",
    • "internalNotes": "string",
    • "requestStatus": "string",
    • "requestType": "string"

    }

  ],
• "next": "string"

}

Return Single Subject Rights Action Item (DEPRECATED)

Deprecated: Please use /v1/subject-rights/action-items/{actionItemId} instead

Authorizations:

ApiKeyAuth

path Parameters

actionItemId required

number The id of the Action Item to return

Responses

Production API

https://api.osano.com/v1/dsar-action-items/{actionItemId}

Response samples

• 200
• 400
• 404

Content type

application/json

{

• "dsarActionItemId": 0,
• "assignees": [

  • "user@example.com"

  ],
• "dataStore": {

  • "dataStoreId": 0,
  • "name": "string"

  },
• "dsarId": "string",
• "dsarDetails": { },
• "due": "2019-08-24T14:15:22Z",
• "created": "2019-08-24T14:15:22Z",
• "status": "string",
• "internalNotes": "string",
• "requestStatus": "string",
• "requestType": "string"

}

Update Subject Rights Action Item (DEPRECATED)

Deprecated: Please use /v1/subject-rights/action-items/{actionItemId} instead

Authorizations:

ApiKeyAuth

path Parameters

actionItemId required

number The id of the Action Item to update

Request Body schema: application/json

required

The properties to be updated in the Action Item. Note that this allows for a partial update, not all fields are required.

assignee	string or null <email>
status	string Enum: "IN_PROGRESS" "COMPLETED" "CLAIMED" "REJECTED"
internalNotes	string
property name* additional property	any

Responses

Production API

https://api.osano.com/v1/dsar-action-items/{actionItemId}

Request samples

• Payload

Content type

application/json

{

• "assignee": "user@example.com",
• "status": "IN_PROGRESS",
• "internalNotes": "string"

}

Response samples

• 200
• 400
• 404

Content type

application/json

{

• "dsarActionItemId": 0,
• "assignees": [

  • "user@example.com"

  ],
• "dataStore": {

  • "dataStoreId": 0,
  • "name": "string"

  },
• "dsarId": "string",
• "dsarDetails": { },
• "due": "2019-08-24T14:15:22Z",
• "created": "2019-08-24T14:15:22Z",
• "status": "string",
• "internalNotes": "string",
• "requestStatus": "string",
• "requestType": "string"

}

Return Action Item Summary Entries (DEPRECATED)

Deprecated: Please use /v1/subject-rights/action-items/{actionItemId}/summaries instead

Authorizations:

ApiKeyAuth

path Parameters

actionItemId required

number The id of the Action Item whose summaries are to be returned

Responses

Production API

https://api.osano.com/v1/dsar-action-items/{actionItemId}/summary-entry

Response samples

• 200
• 400
• 404

Content type

application/json

{

• "items": [

  • {

    • "dsarSummaryId": "string",
    • "dsarId": "string",
    • "dataStore": {

      • "dataStoreId": 0,
      • "name": "string"

      },
    • "fileName": "string",
    • "fileType": "string",
    • "manual": true,
    • "created": "2019-08-24T14:15:22Z"

    }

  ],
• "next": "string"

}

Upload a Subject Rights Action Item Summary (DEPRECATED)

Deprecated: Please use /v1/subject-rights/action-items/{actionItemId}/summaries instead

Authorizations:

ApiKeyAuth

path Parameters

actionItemId required

number The id of the Action Item to attach the summaries to

query Parameters

limit	integer <int32> <= 500 Default: 100 The number of items to return.
next	string The pagination token from the previous request.

Request Body schema:

application/jsonapplication/pdfapplication/gzapplication/ziptext/csvtext/plaintext/rich-textmultipart/form-dataapplication/json

required

Contents of the summary file.

string <binary>

Responses

Production API

https://api.osano.com/v1/dsar-action-items/{actionItemId}/summary-entry

Request samples

• Payload

Content type

application/jsonapplication/pdfapplication/gzapplication/ziptext/csvtext/plaintext/rich-textmultipart/form-dataapplication/json

"string"

Response samples

• 200
• 400
• 404

Content type

application/json

[

• {

  • "dsarSummaryId": "string",
  • "dsarId": "string",
  • "dataStore": {

    • "dataStoreId": 0,
    • "name": "string"

    },
  • "fileName": "string",
  • "fileType": "string",
  • "manual": true,
  • "created": "2019-08-24T14:15:22Z"

  }

]

Update a Subject Rights Action Item Summary (DEPRECATED)

Deprecated: Please use /v1/subject-rights/action-items/{actionItemId}/summaries/{dsarSummaryId} instead

Authorizations:

ApiKeyAuth

path Parameters

actionItemId required	number The id of the Action Item whose summary we are updating.
dsarSummaryId required	number The id of the Action Item Summary to update

Request Body schema: application/json

required

The properties to be updated in the Action Item Summary.

excluded required

boolean

Responses

Production API

https://api.osano.com/v1/dsar-action-items/{actionItemId}/summary-entry/{dsarSummaryId}

Request samples

• Payload

Content type

application/json

{

• "excluded": true

}

Response samples

• 400
• 404

Content type

application/json

{

• "message": "string"

}

List Subject Rights Action Items

Returns a detailed list of Subject Rights Action Items

Authorizations:

ApiKeyAuth

query Parameters

dsarId	string The id of the Subject Rights request to filter by
status	Array of strings Status filter for the request. Must be one of CLAIMED, IN_PROGRESS, COMPLETED, or REJECTED.
limit	integer <int32> <= 500 Default: 100 The number of items to return.
next	string The pagination token from the previous request.
after	string Specify UTC date and time in ISO-8601 format (e.g. 2021-01-01T00:00:00Z) to filter items created after this date.

Responses

Production API

https://api.osano.com/v1/subject-rights/action-items

Response samples

• 200
• 400
• 404

Content type

application/json

{

• "items": [

  • {

    • "dsarActionItemId": 0,
    • "assignees": [

      • "user@example.com"

      ],
    • "dataStore": {

      • "dataStoreId": 0,
      • "name": "string"

      },
    • "dsarId": "string",
    • "dsarDetails": { },
    • "due": "2019-08-24T14:15:22Z",
    • "created": "2019-08-24T14:15:22Z",
    • "status": "string",
    • "internalNotes": "string",
    • "requestStatus": "string",
    • "requestType": "string"

    }

  ],
• "next": "string"

}

Return Single Subject Rights Action Item

Returns a single Subject Rights Action Item

Authorizations:

ApiKeyAuth

path Parameters

actionItemId required

number The id of the Action Item to return

Responses

Production API

https://api.osano.com/v1/subject-rights/action-items/{actionItemId}

Response samples

• 200
• 400
• 404

Content type

application/json

{

• "dsarActionItemId": 0,
• "assignees": [

  • "user@example.com"

  ],
• "dataStore": {

  • "dataStoreId": 0,
  • "name": "string"

  },
• "dsarId": "string",
• "dsarDetails": { },
• "due": "2019-08-24T14:15:22Z",
• "created": "2019-08-24T14:15:22Z",
• "status": "string",
• "internalNotes": "string",
• "requestStatus": "string",
• "requestType": "string"

}

Update Subject Rights Action Item

Updates a single Subject Rights Action Item

Authorizations:

ApiKeyAuth

path Parameters

actionItemId required

number The id of the Action Item to update

Request Body schema: application/json

required

The properties to be updated in the Action Item. Note that this allows for a partial update, not all fields are required.

assignee	string or null <email>
status	string Enum: "IN_PROGRESS" "COMPLETED" "CLAIMED" "REJECTED"
internalNotes	string
property name* additional property	any

Responses

Production API

https://api.osano.com/v1/subject-rights/action-items/{actionItemId}

Request samples

• Payload

Content type

application/json

{

• "assignee": "user@example.com",
• "status": "IN_PROGRESS",
• "internalNotes": "string"

}

Response samples

• 200
• 400
• 404

Content type

application/json

{

• "dsarActionItemId": 0,
• "assignees": [

  • "user@example.com"

  ],
• "dataStore": {

  • "dataStoreId": 0,
  • "name": "string"

  },
• "dsarId": "string",
• "dsarDetails": { },
• "due": "2019-08-24T14:15:22Z",
• "created": "2019-08-24T14:15:22Z",
• "status": "string",
• "internalNotes": "string",
• "requestStatus": "string",
• "requestType": "string"

}

Return Action Item Summary Entries

Returns a list of Summary Entries for a Subject Rights Action Item

Authorizations:

ApiKeyAuth

path Parameters

actionItemId required

number The id of the Action Item whose summaries are to be returned

Responses

Production API

https://api.osano.com/v1/subject-rights/action-items/{actionItemId}/summaries

Response samples

• 200
• 400
• 404

Content type

application/json

{

• "items": [

  • {

    • "dsarSummaryId": "string",
    • "dsarId": "string",
    • "dataStore": {

      • "dataStoreId": 0,
      • "name": "string"

      },
    • "fileName": "string",
    • "fileType": "string",
    • "manual": true,
    • "created": "2019-08-24T14:15:22Z"

    }

  ],
• "next": "string"

}

Upload a Subject Rights Action Item Summary

Create a Subject Rights Action Item Summary from the data in the request body. If the content-type header is one of: application/json, application/pdf, application/gz, application/zip, text/csv, text/plain, or text/rich-text, the request body will be treated as a file and uploaded as-is. If the content-type is multipart/form-data, the request body will be treated as a form and the file and name will be extracted from the "file" and "name" fields.

Authorizations:

ApiKeyAuth

path Parameters

actionItemId required

number The id of the Action Item to attach the summaries to

query Parameters

limit	integer <int32> <= 500 Default: 100 The number of items to return.
next	string The pagination token from the previous request.

Request Body schema:

application/jsonapplication/pdfapplication/gzapplication/ziptext/csvtext/plaintext/rich-textmultipart/form-dataapplication/json

required

Contents of the summary file.

string <binary>

Responses

Production API

https://api.osano.com/v1/subject-rights/action-items/{actionItemId}/summaries

Request samples

• Payload

Content type

application/jsonapplication/pdfapplication/gzapplication/ziptext/csvtext/plaintext/rich-textmultipart/form-dataapplication/json

"string"

Response samples

• 200
• 400
• 404

Content type

application/json

[

• {

  • "dsarSummaryId": "string",
  • "dsarId": "string",
  • "dataStore": {

    • "dataStoreId": 0,
    • "name": "string"

    },
  • "fileName": "string",
  • "fileType": "string",
  • "manual": true,
  • "created": "2019-08-24T14:15:22Z"

  }

]

Update a Subject Rights Action Item Summary

Updates the metadata for a single Subject Rights Action Item Summary

Authorizations:

ApiKeyAuth

path Parameters

actionItemId required	number The id of the Action Item whose summary we are updating.
dsarSummaryId required	number The id of the Action Item Summary to update

Request Body schema: application/json

required

The properties to be updated in the Action Item Summary.

excluded required

boolean

Responses

Production API

https://api.osano.com/v1/subject-rights/action-items/{actionItemId}/summaries/{dsarSummaryId}

Request samples

• Payload

Content type

application/json

{

• "excluded": true

}

Response samples

• 400
• 404

Content type

application/json

{

• "message": "string"

}

Subject Rights Portal

Get Portal Messages

Get the messages for a specific request

Authorizations:

ApiKeyAuth

query Parameters

dsarId	string The id of the Subject Rights request to filter by
limit	integer <int32> <= 500 Default: 100 The number of items to return.
next	string The pagination token from the previous request.
after	string Specify UTC date and time in ISO-8601 format (e.g. 2021-01-01T00:00:00Z) to filter items created after this date.

Responses

Production API

https://api.osano.com/v1/subject-rights/requests/{requestId}/portal-messages

Response samples

• 200
• 400
• 404

Content type

application/json

{

• "items": [

  • {

    • "messageId": 0,
    • "content": "string",
    • "sent": "2019-08-24T14:15:22Z",
    • "read": true,
    • "source": "string",
    • "attachments": [

      • {

        • "messageAttachmentId": 0,
        • "fileName": "string",
        • "fileType": "string",
        • "fileExt": "string"

        }

      ]

    }

  ],
• "next": "string"

}

Create Portal Message

Create a new message for a specific request

Authorizations:

ApiKeyAuth

query Parameters

dsarId

string The id of the Subject Rights request to filter by

Request Body schema: application/json

required

The message to add to the request conversation

content required

string

Responses

Production API

https://api.osano.com/v1/subject-rights/requests/{requestId}/portal-messages

Request samples

• Payload

Content type

application/json

{

• "content": "string"

}

Response samples

• 400

Content type

application/json

{

• "message": "string"

}

Update Portal Message

Update a message for a specific request

Authorizations:

ApiKeyAuth

path Parameters

messageId required

string The id of the message to update

query Parameters

dsarId

string The id of the Subject Rights request to filter by

Request Body schema: application/json

required

The read status to update

read required

boolean

Responses

Production API

https://api.osano.com/v1/subject-rights/requests/{requestId}/portal-messages/{messageId}

Request samples

• Payload

Content type

application/json

{

• "read": true

}

Response samples

• 200
• 400
• 404

Content type

application/json

{

• "messageId": 0,
• "updated": "2019-08-24T14:15:22Z"

}