App versions
Applications
Apps
Assets
Categories
License types
Migrations
Privacy and Security
Products
Promotions (Removed)
Reporting
Reviews
Vendors

Rate this page:

Privacy and Security

Below are the APIs to fill privacy and security information about apps. We have also created a loom video for you that explains the process and steps involved.

Get app privacy and security information

GET /rest/2/addons/{addonKey}/privacy-and-security

Get the privacy and security info for the specified app. This resource requires authentication for fetching "draft" version of privacy and security information.

Request

Path parameters
addonKey Required

string

The unique identifier for this app, for example "com.atlassian.confluence.plugins.confluence-questions".

Query parameters
state

string

Specifies the version of Privacy and security information to be fetched. Possible values are "live" or "draft". For partners with manage app permissions, if a draft version exists then the default value will be "draft", or else the default value will be "live".

Example

1
2
3
4
curl --request GET \
  --url 'https://marketplace.atlassian.com/rest/2/addons/{addonKey}/privacy-and-security' \
  --user 'email@example.com:<api_token>' \
  --header 'Accept: application/json'

Responses

Content typeValue
application/json

TrustInfo

Create/Update app draft version of privacy and security info

PUT /rest/2/addons/{addonKey}/privacy-and-security

Create/Update draft version of privacy and security info for the specified app. Any update will create a new draft version. This resource requires authentication.

Request

Path parameters
addonKey Required

string

The unique identifier for this app, for example "com.atlassian.confluence.plugins.confluence-questions".

Body parameters
appTrustInformation Required

appTrustInformation

Example

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
curl --request PUT \
  --url 'https://marketplace.atlassian.com/rest/2/addons/{addonKey}/privacy-and-security' \
  --user 'email@example.com:<api_token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "appTrustInformation": {
    "dataAccessAndStorage": {
      "isSameDataProcessedAndStored": true,
      "appProcessEUDOutsideAtlassian": true,
      "typesOfDataAccessed": [
        "<string>"
      ],
      "appStoresEUDOutsideAtlassian": true,
      "typesOfDataStored": [
        "<string>"
      ]
    },
    "thirdPartyInformation": {
      "isEndUserDataShared": true,
      "dataSubProcessors": "<string>",
      "thirdPartyDetails": [
        {}
      ]
    },
    "logDetails": {
      "logEndUserData": true,
      "logProcessAndOrStoreEUDOutsideAtlassian": true,
      "logEUDShareWithThirdParty": true,
      "logsIntegralForAppFunctionality": true
    },
    "dataResidency": {
      "isDataResidencySupported": "STORED_IN_ATLASSIAN_N_DR_SUPPORTED",
      "countriesWhereEndUserDataStored": [
        "<string>"
      ],
      "realmMigrationSupported": true,
      "inScopeDataTypes": [
        "<string>"
      ]
    },
    "dataRetention": {
      "isDataRetentionSupported": true,
      "retentionDurationInDays": {},
      "isCustomRetentionPeriodAllowed": true
    },
    "security": {
      "securityContact": "<string>",
      "publicSecurityPoliciesLink": "<string>",
      "caiq": {},
      "isDiskEncryptionSupported": true,
      "hasCompliantCertifications": true,
      "compliantCertifications": [
        "<string>"
      ]
    },
    "privacy": {
      "privacyEnhancingTechniques": {},
      "gdpr": {},
      "ccpa": {},
      "dataProcessingAgreement": {}
    }
  }
}'

Responses

Privacy & security information saved successfully.

A schema has not been defined for this response code.

Delete draft version of privacy and security info

DELETE /rest/2/addons/{addonKey}/privacy-and-security

Discards the draft version of privacy and security information for the specified app. This resource requires authentication.

Request

Path parameters
addonKey Required

string

The unique identifier for this app, for example "com.atlassian.confluence.plugins.confluence-questions".

Example

1
2
3
4
curl --request DELETE \
  --url 'https://marketplace.atlassian.com/rest/2/addons/{addonKey}/privacy-and-security' \
  --user 'email@example.com:<api_token>' \
  --header 'Accept: application/json'

Responses

Draft version of privacy & security information discarded successfully.

Content typeValue
application/json

appTrustInformation

Update draft version of privacy and security info for the specific app

PATCH /rest/2/addons/{addonKey}/privacy-and-security

Update draft version of privacy and security info for the specific app.

The request body must be a valid JSON Patch document. The properties which can be referenced in the PATCH are the same ones returned by a GET on this URI.

This resource requires authentication.

Request

Path parameters
addonKey Required

string

The unique identifier for this app, for example "com.atlassian.confluence.plugins.confluence-questions".

Body parameters
Content typeValue
application/json-patch+json

Array<JsonPatchDocumentation>

Example

1
2
3
curl --request PATCH \
  --url 'https://marketplace.atlassian.com/rest/2/addons/{addonKey}/privacy-and-security' \
  --user 'email@example.com:<api_token>'

Responses

Privacy & security information updated successfully.

A schema has not been defined for this response code.

Publish app privacy and security info

PUT /rest/2/addons/{addonKey}/privacy-and-security/publish

Publish the privacy and security info for the specified app. This resource requires authentication.

Request

Path parameters
addonKey Required

string

The unique identifier for this app, for example "com.atlassian.confluence.plugins.confluence-questions".

Example

1
2
3
curl --request PUT \
  --url 'https://marketplace.atlassian.com/rest/2/addons/{addonKey}/privacy-and-security/publish' \
  --user 'email@example.com:<api_token>'

Responses

Privacy & security information submitted successfully.

A schema has not been defined for this response code.

Rate this page: