Osano API Reference (1.0.0)
Download OpenAPI specification:Download
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>
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.
Create New Cookie Consent Configuration
Create a new Cookie Consent Configuration.
Authorizations:
Request Body schema: application/json
name required | string The name of the configuration. |
domains required | Array of strings non-empty A list of domains (cannot be null or empty). |
mode required | string Enum: "debug" "permissive" "production" |
required | object (Configuration) non-empty |
Responses
Request samples
- Payload
{- "name": "string",
- "domains": [
- "string"
], - "mode": "debug",
- "configuration": {
- "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": "top",
- "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
{- "name": "string",
- "domains": [
- "string"
], - "configuration": {
- "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": "top",
- "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
}, - "mode": "debug"
}
Update Cookie Consent Configuration
Update an existing Cookie Consent Configuration.
Authorizations:
path Parameters
configId required | string The identifier of the Cookie Consent Configuration to be updated. |
Request Body schema: application/json
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). |
mode | string Enum: "debug" "permissive" "production" |
object (ConfigurationUpdate) non-empty |
Responses
Request samples
- Payload
{- "name": "string",
- "domains": [
- "string"
], - "mode": "debug",
- "configuration": {
- "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": "top",
- "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
{- "name": "string",
- "domains": [
- "string"
], - "configuration": {
- "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": "top",
- "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
}, - "mode": "debug"
}
List Connectors (DEPRECATED)
Deprecated: Please use /v1/data-discovery/connectors instead
Authorizations:
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
Response samples
- 200
- 400
{- "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:
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
Response samples
- 200
- 400
{- "items": [
- {
- "connectorId": 0,
- "productName": "string",
- "authType": "string"
}
], - "next": "string"
}
List Subject Rights Requests (DEPRECATED)
Deprecated: Please use /v1/subject-rights/requests instead
Authorizations:
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" Request type filter for the request. Must be one of DELETE, CORRECT, SUMMARIZE, DO_NOT_SELL, OPT_OUT, LIMIT_USE, OTHER, or PORTABILITY. |
formId | integer <int32> Form identifier through which the Subject Rights Request was made. |
Responses
Response samples
- 200
- 400
{- "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:
Request Body schema: application/json
The Subject Rights Request(s) to be created.
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
Request samples
- Payload
[- {
- "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
{- "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:
path Parameters
dsarId required | string The identifier of the Subject Rights Request to return. |
Responses
Response samples
- 200
- 404
{- "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:
path Parameters
dsarId required | string The identifier of the Subject Rights Request to be updated. |
Request Body schema: application/json
Object containing the fields to be updated.
status | string |
notes | string |
property name* additional property | any |
Responses
Request samples
- Payload
{- "status": "string",
- "notes": "string"
}
Response samples
- 200
- 400
- 404
{- "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:
path Parameters
dsarId required | string The identifier of the Subject Rights Request to be updated. |
Request Body schema:
Responses
Response samples
- 400
- 404
{- "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:
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" Request type filter for the request. Must be one of DELETE, CORRECT, SUMMARIZE, DO_NOT_SELL, OPT_OUT, LIMIT_USE, OTHER, or PORTABILITY. |
formId | integer <int32> Form identifier through which the Subject Rights Request was made. |
Responses
Response samples
- 200
- 400
{- "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:
Request Body schema: application/json
The Subject Rights Request(s) to be created.
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
Request samples
- Payload
[- {
- "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
{- "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:
path Parameters
dsarId required | string The identifier of the Subject Rights Request to return. |
Responses
Response samples
- 200
- 404
{- "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:
path Parameters
dsarId required | string The identifier of the Subject Rights Request to be updated. |
Request Body schema: application/json
Object containing the fields to be updated.
status | string |
notes | string |
property name* additional property | any |
Responses
Request samples
- Payload
{- "status": "string",
- "notes": "string"
}
Response samples
- 200
- 400
- 404
{- "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:
path Parameters
dsarId required | string The identifier of the Subject Rights Request to be updated. |
Request Body schema:
Responses
Response samples
- 400
- 404
{- "message": "string"
}
List Data Stores (DEPRECATED)
Deprecated: Please use /v1/data-discovery/data-stores instead
Authorizations:
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
Response samples
- 200
- 400
{- "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:
Request Body schema: application/json
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
Request samples
- Payload
{- "name": "string",
- "description": "string",
- "alias": "string",
- "connectorId": 0,
- "owners": [
- {
- "email": "user@example.com",
- "primary": true
}
]
}
Response samples
- 200
- 400
{- "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:
path Parameters
dataStoreId required | string The identifier of the Data Store to be returned. |
Responses
Response samples
- 200
- 400
- 404
{- "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:
path Parameters
dataStoreId required | string The identifier of the Data Store to be deactivated. |
Responses
Response samples
- 404
{- "message": "string"
}
Update an existing data store (DEPRECATED)
Deprecated: Please use /v1/data-discovery/data-stores/{dataStoreId} instead
Authorizations:
path Parameters
dataStoreId required | string The identifier of the Data Store to be updated. |
Request Body schema: application/json
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
Request samples
- Payload
{- "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:
path Parameters
dataStoreId required | string The identifier of the Data Store to be updated. |
Request Body schema: application/json
An array of personal data fields to be added to this Data Store.
name | string [ 1 .. 64 ] characters |
path | string or null |
classification | string or null <= 32 characters |
Responses
Request samples
- Payload
[- {
- "name": "string",
- "path": "string",
- "classification": "string"
}
]
Response samples
- 400
- 404
{- "message": "string"
}
Returns Data Store Fields (DEPRECATED)
Deprecated: Please use /v1/data-discovery/data-stores/{dataStoreId}/fields instead
Authorizations:
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
Response samples
- 200
- 400
- 404
{- "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:
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
Response samples
- 400
- 404
{- "message": "string"
}
Update Data Store Field (DEPRECATED)
Deprecated: Please use /v1/data-discovery/data-stores/{dataStoreId}/fields/{fieldId} instead
Authorizations:
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
Field data to be updated.
name | string [ 1 .. 64 ] characters |
path | string or null |
classification | string or null <= 32 characters |
Responses
Request samples
- Payload
{- "name": "string",
- "path": "string",
- "classification": "string"
}
Response samples
- 400
- 404
{- "message": "string"
}
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:
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
Response samples
- 200
- 400
{- "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:
Request Body schema: application/json
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
Request samples
- Payload
{- "name": "string",
- "description": "string",
- "alias": "string",
- "connectorId": 0,
- "owners": [
- {
- "email": "user@example.com",
- "primary": true
}
]
}
Response samples
- 200
- 400
{- "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:
path Parameters
dataStoreId required | string The identifier of the Data Store to be returned. |
Responses
Response samples
- 200
- 400
- 404
{- "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:
path Parameters
dataStoreId required | string The identifier of the Data Store to be deactivated. |
Responses
Response samples
- 404
{- "message": "string"
}
Update an existing data store
Update specific properties about a Data Store by ID.
Authorizations:
path Parameters
dataStoreId required | string The identifier of the Data Store to be updated. |
Request Body schema: application/json
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
Request samples
- Payload
{- "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:
path Parameters
dataStoreId required | string The identifier of the Data Store to be updated. |
Request Body schema: application/json
An array of personal data fields to be added to this Data Store.
name | string [ 1 .. 64 ] characters |
path | string or null |
classification | string or null <= 32 characters |
Responses
Request samples
- Payload
[- {
- "name": "string",
- "path": "string",
- "classification": "string"
}
]
Response samples
- 400
- 404
{- "message": "string"
}
Returns Data Store Fields
Returns a list of personal data fields for a particular Data Store.
Authorizations:
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
Response samples
- 200
- 400
- 404
{- "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:
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
Response samples
- 400
- 404
{- "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:
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
Field data to be updated.
name | string [ 1 .. 64 ] characters |
path | string or null |
classification | string or null <= 32 characters |
Responses
Request samples
- Payload
{- "name": "string",
- "path": "string",
- "classification": "string"
}
Response samples
- 400
- 404
{- "message": "string"
}
List Subject Rights Action Items (DEPRECATED)
Deprecated: Please use /v1/subject-rights/action-items instead
Authorizations:
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
Response samples
- 200
- 400
- 404
{- "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:
path Parameters
actionItemId required | number The id of the Action Item to return |
Responses
Response samples
- 200
- 400
- 404
{- "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:
path Parameters
actionItemId required | number The id of the Action Item to update |
Request Body schema: application/json
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
Request samples
- Payload
{- "assignee": "user@example.com",
- "status": "IN_PROGRESS",
- "internalNotes": "string"
}
Response samples
- 200
- 400
- 404
{- "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:
path Parameters
actionItemId required | number The id of the Action Item whose summaries are to be returned |
Responses
Response samples
- 200
- 400
- 404
{- "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:
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:
Contents of the summary file.
Responses
Request samples
- Payload
"string"
Response samples
- 200
- 400
- 404
[- {
- "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:
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
The properties to be updated in the Action Item Summary.
excluded required | boolean |
Responses
Request samples
- Payload
{- "excluded": true
}
Response samples
- 400
- 404
{- "message": "string"
}
List Subject Rights Action Items
Returns a detailed list of Subject Rights Action Items
Authorizations:
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
Response samples
- 200
- 400
- 404
{- "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:
path Parameters
actionItemId required | number The id of the Action Item to return |
Responses
Response samples
- 200
- 400
- 404
{- "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:
path Parameters
actionItemId required | number The id of the Action Item to update |
Request Body schema: application/json
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
Request samples
- Payload
{- "assignee": "user@example.com",
- "status": "IN_PROGRESS",
- "internalNotes": "string"
}
Response samples
- 200
- 400
- 404
{- "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:
path Parameters
actionItemId required | number The id of the Action Item whose summaries are to be returned |
Responses
Response samples
- 200
- 400
- 404
{- "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:
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:
Contents of the summary file.
Responses
Request samples
- Payload
"string"
Response samples
- 200
- 400
- 404
[- {
- "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:
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
The properties to be updated in the Action Item Summary.
excluded required | boolean |
Responses
Request samples
- Payload
{- "excluded": true
}
Response samples
- 400
- 404
{- "message": "string"
}
Get Portal Messages
Get the messages for a specific request
Authorizations:
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
Response samples
- 200
- 400
- 404
{- "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:
query Parameters
dsarId | string The id of the Subject Rights request to filter by |
Request Body schema: application/json
The message to add to the request conversation
content required | string |
Responses
Request samples
- Payload
{- "content": "string"
}
Response samples
- 400
{- "message": "string"
}
Update Portal Message
Update a message for a specific request
Authorizations:
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
The read status to update
read required | boolean |
Responses
Request samples
- Payload
{- "read": true
}
Response samples
- 200
- 400
- 404
{- "messageId": 0,
- "updated": "2019-08-24T14:15:22Z"
}