Skip to content

Treasure Data API (3)

Download OpenAPI description
Languages
Servers

https://api.treasuredata.com/v3/

https://api.treasuredata.co.jp/v3/

https://api.ap02.treasuredata.com/v3/

https://api.eu01.treasuredata.com/v3/

Access Control - Policies

Operations

Access Control - Permissions

Operations

Show Column Permissions

Request

Shows column permission by policy ID.

Security
ApiKeyAuth
Path
policy_idinteger(AccessControlPolicyId)required
Example: 67
curl -i -X GET \
  https://api.treasuredata.com/v3/access_control/policies/67/column_permissions \
  -H 'Authorization: TD1 <YOUR_TOKEN_HERE>'

Responses

OK

Bodyapplication/jsonArray [
tagsArray of stringsrequired
exceptboolean or null
maskingstring or null
Value"hash"
]
Response
application/json
[ { "tags": [], "except": true, "masking": "hash" } ]

Update Column Permissions

Request

Updates column permissions by policy ID.

Security
ApiKeyAuth
Path
policy_idinteger(AccessControlPolicyId)required
Example: 67
Bodyapplication/json
column_permissionsArray of objects(AccessControlColumnPermission)
curl -i -X PATCH \
  https://api.treasuredata.com/v3/access_control/policies/67/column_permissions \
  -H 'Authorization: TD1 <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "column_permissions": [
      {
        "tags": [
          "string"
        ],
        "except": true,
        "masking": "hash"
      }
    ]
  }'

Responses

OK

Bodyapplication/jsonArray [
tagsArray of stringsrequired
exceptboolean or null
maskingstring or null
Value"hash"
]
Response
application/json
[ { "tags": [], "except": true, "masking": "hash" } ]

Show Policy Permissions

Request

Shows policy permissions by policy ID.

Security
ApiKeyAuth
Path
policy_idinteger(AccessControlPolicyId)required
Example: 67
curl -i -X GET \
  https://api.treasuredata.com/v3/access_control/policies/67/permissions \
  -H 'Authorization: TD1 <YOUR_TOKEN_HERE>'

Responses

OK

Bodyapplication/json
WorkflowProjectArray of objects

Permissions on resource

WorkflowProjectLevelArray of objects

Permissions on resource

WorkflowRestrictedOperatorsArray of objects

Permissions on resource

SegmentationArray of objects

Permissions on resource

MasterSegmentConfigsArray of objects

Permissions on resource

MasterSegmentConfigArray of objects

Permissions on resource

MasterSegmentColumnArray of objects

Permissions on MasterSegmentColumn

MasterSegmentAllColumnsArray of objects

Permissions on MasterSegmentAllColumns

CookieConsentArray of objects

Permissions on CookieConsent

SegmentAllFoldersArray of objects

Permissions on resource

SegmentFolderArray of objects

Permissions on resource

ProfilesArray of objects

Permissions on resource

ProfilesApiTokenArray of objects

Permissions on resource

ActivationTemplateArray of objects

Permissions on ActivationTemplate

ActivationArray of objects

Permissions on Activation

AuthenticationsArray of objects

Permissions on resource

SourcesArray of objects

Permissions on resource

DestinationsArray of objects

Permissions on resource

DatabasesArray of objects

Permissions on databases

UniversalConsentArray of objects

Permissions on UniversalConsent

TrafficControlsArray of objects

Permissions on TrafficControl

TrafficControlArray of objects

Permissions on TrafficControl

JourneysArray of objects

Permissions on Journeys

JourneyArray of objects

Permissions on Journeys in the audience

LlmProjectArray of objects

Permissions on LLM Projects

Response
application/json
{ "WorkflowProject": [ {} ], "WorkflowProjectLevel": [ {} ], "WorkflowRestrictedOperators": [ {} ], "Segmentation": [ {} ], "MasterSegmentConfigs": [ {} ], "MasterSegmentConfig": [ {} ], "MasterSegmentColumn": [ {} ], "MasterSegmentAllColumns": [ {} ], "CookieConsent": [ {} ], "SegmentAllFolders": [ {} ], "SegmentFolder": [ {} ], "Profiles": [ {} ], "ProfilesApiToken": [ {} ], "ActivationTemplate": [ {} ], "Activation": [ {} ], "Authentications": [ {} ], "Sources": [ {} ], "Destinations": [ {} ], "Databases": [ {} ], "UniversalConsent": [ {} ], "TrafficControls": [ {} ], "TrafficControl": [ {} ], "Journeys": [ {} ], "Journey": [ {} ], "LlmProject": [ {} ] }

Update Policy Permissions

Request

Updates policy permissions.

Security
ApiKeyAuth
Path
policy_idinteger(AccessControlPolicyId)required
Example: 67
Bodyapplication/json
WorkflowProjectArray of objects

Permissions on resource

WorkflowProjectLevelArray of objects

Permissions on resource

WorkflowRestrictedOperatorsArray of objects

Permissions on resource

SegmentationArray of objects

Permissions on resource

MasterSegmentConfigsArray of objects

Permissions on resource

MasterSegmentConfigArray of objects

Permissions on resource

MasterSegmentColumnArray of objects

Permissions on MasterSegmentColumn

MasterSegmentAllColumnsArray of objects

Permissions on MasterSegmentAllColumns

CookieConsentArray of objects

Permissions on CookieConsent

SegmentAllFoldersArray of objects

Permissions on resource

SegmentFolderArray of objects

Permissions on resource

ProfilesArray of objects

Permissions on resource

ProfilesApiTokenArray of objects

Permissions on resource

ActivationTemplateArray of objects

Permissions on ActivationTemplate

ActivationArray of objects

Permissions on Activation

AuthenticationsArray of objects

Permissions on resource

SourcesArray of objects

Permissions on resource

DestinationsArray of objects

Permissions on resource

DatabasesArray of objects

Permissions on databases

UniversalConsentArray of objects

Permissions on UniversalConsent

TrafficControlsArray of objects

Permissions on TrafficControl

TrafficControlArray of objects

Permissions on TrafficControl

JourneysArray of objects

Permissions on Journeys

JourneyArray of objects

Permissions on Journeys in the audience

LlmProjectArray of objects

Permissions on LLM Projects

curl -i -X PATCH \
  https://api.treasuredata.com/v3/access_control/policies/67/permissions \
  -H 'Authorization: TD1 <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "WorkflowProject": [
      {
        "operation": "view"
      }
    ],
    "WorkflowProjectLevel": [
      {
        "operation": "view",
        "name": "my_wf"
      }
    ],
    "WorkflowRestrictedOperators": [
      {
        "operation": "edit"
      }
    ],
    "Segmentation": [
      {
        "operation": "full"
      }
    ],
    "MasterSegmentConfigs": [
      {
        "operation": "view"
      }
    ],
    "MasterSegmentConfig": [
      {
        "operation": "view",
        "id": "42"
      }
    ],
    "MasterSegmentColumn": [
      {
        "operation": "view_clear",
        "column_identifiers": "1$attribute.customers.age,1$attribute.customers.first_name"
      }
    ],
    "MasterSegmentAllColumns": [
      {
        "operation": "view_clear",
        "audience_id": "1"
      }
    ],
    "CookieConsent": [
      {
        "operation": "view"
      }
    ],
    "SegmentAllFolders": [
      {
        "operation": "view",
        "audience_id": "42"
      }
    ],
    "SegmentFolder": [
      {
        "operation": "view",
        "id": "42"
      }
    ],
    "Profiles": [
      {
        "operation": "view",
        "audience_id": "42"
      }
    ],
    "ProfilesApiToken": [
      {
        "operation": "full",
        "audience_id": "42"
      }
    ],
    "ActivationTemplate": [
      {
        "operation": "view"
      }
    ],
    "Activation": [
      {
        "operation": "create_only_with_template"
      }
    ],
    "Authentications": [
      {
        "operation": "use_limited",
        "ids": "1,2,3"
      }
    ],
    "Sources": [
      {
        "operation": "restricted"
      }
    ],
    "Destinations": [
      {
        "operation": "restricted"
      }
    ],
    "Databases": [
      {
        "operation": "query",
        "ids": "1,2,3"
      }
    ],
    "UniversalConsent": [
      {
        "operation": "full"
      }
    ],
    "TrafficControls": [
      {
        "operation": "full"
      }
    ],
    "TrafficControl": [
      {
        "operation": "full",
        "audience_id": "42"
      }
    ],
    "Journeys": [
      {
        "operation": "full"
      }
    ],
    "Journey": [
      {
        "operation": "full",
        "audience_id": "42"
      }
    ],
    "LlmProject": [
      {
        "operation": "full",
        "project_id": "1"
      }
    ]
  }'

Responses

OK

Bodyapplication/json
WorkflowProjectArray of objects

Permissions on resource

WorkflowProjectLevelArray of objects

Permissions on resource

WorkflowRestrictedOperatorsArray of objects

Permissions on resource

SegmentationArray of objects

Permissions on resource

MasterSegmentConfigsArray of objects

Permissions on resource

MasterSegmentConfigArray of objects

Permissions on resource

MasterSegmentColumnArray of objects

Permissions on MasterSegmentColumn

MasterSegmentAllColumnsArray of objects

Permissions on MasterSegmentAllColumns

CookieConsentArray of objects

Permissions on CookieConsent

SegmentAllFoldersArray of objects

Permissions on resource

SegmentFolderArray of objects

Permissions on resource

ProfilesArray of objects

Permissions on resource

ProfilesApiTokenArray of objects

Permissions on resource

ActivationTemplateArray of objects

Permissions on ActivationTemplate

ActivationArray of objects

Permissions on Activation

AuthenticationsArray of objects

Permissions on resource

SourcesArray of objects

Permissions on resource

DestinationsArray of objects

Permissions on resource

DatabasesArray of objects

Permissions on databases

UniversalConsentArray of objects

Permissions on UniversalConsent

TrafficControlsArray of objects

Permissions on TrafficControl

TrafficControlArray of objects

Permissions on TrafficControl

JourneysArray of objects

Permissions on Journeys

JourneyArray of objects

Permissions on Journeys in the audience

LlmProjectArray of objects

Permissions on LLM Projects

Response
application/json
{ "WorkflowProject": [ {} ], "WorkflowProjectLevel": [ {} ], "WorkflowRestrictedOperators": [ {} ], "Segmentation": [ {} ], "MasterSegmentConfigs": [ {} ], "MasterSegmentConfig": [ {} ], "MasterSegmentColumn": [ {} ], "MasterSegmentAllColumns": [ {} ], "CookieConsent": [ {} ], "SegmentAllFolders": [ {} ], "SegmentFolder": [ {} ], "Profiles": [ {} ], "ProfilesApiToken": [ {} ], "ActivationTemplate": [ {} ], "Activation": [ {} ], "Authentications": [ {} ], "Sources": [ {} ], "Destinations": [ {} ], "Databases": [ {} ], "UniversalConsent": [ {} ], "TrafficControls": [ {} ], "TrafficControl": [ {} ], "Journeys": [ {} ], "Journey": [ {} ], "LlmProject": [ {} ] }

Access Control - Users

Operations

Access Control - Policy Groups

Operations

Connections

Operations

Databases

Operations

Jobs

Operations

Tables

Operations

Policy Group Tags

Operations

Schedules

Operations

Users

Operations