Skip to content
TD API/
API References
/
/
Get Access Control User

Treasure Data API (3)

Download OpenAPI description
td_api_v3-public.json
td_api_v3-public.yaml
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

Access Control - Users

Operations

Get Access Control users.

Request

Retrieves a list of users and their permissions.

Security
ApiKeyAuth
curl -i -X GET \
  https://api.treasuredata.com/v3/access_control/users \
  -H 'Authorization: TD1 <YOUR_TOKEN_HERE>'

Responses

OK

Bodyapplication/jsonArray [
user_idinteger(UserId)required
Example: 123
account_idinteger(AccountId)required
Example: 123
permissionsobject(Access Control Permissions)required
permissions.​WorkflowProjectArray of objects

Permissions on resource

permissions.​WorkflowProjectLevelArray of objects

Permissions on resource

permissions.​WorkflowRestrictedOperatorsArray of objects

Permissions on resource

permissions.​SegmentationArray of objects

Permissions on resource

permissions.​MasterSegmentConfigsArray of objects

Permissions on resource

permissions.​MasterSegmentConfigArray of objects

Permissions on resource

permissions.​MasterSegmentColumnArray of objects

Permissions on MasterSegmentColumn

permissions.​MasterSegmentAllColumnsArray of objects

Permissions on MasterSegmentAllColumns

permissions.​CookieConsentArray of objects

Permissions on CookieConsent

permissions.​SegmentAllFoldersArray of objects

Permissions on resource

permissions.​SegmentFolderArray of objects

Permissions on resource

permissions.​ProfilesArray of objects

Permissions on resource

permissions.​ProfilesApiTokenArray of objects

Permissions on resource

permissions.​ActivationTemplateArray of objects

Permissions on ActivationTemplate

permissions.​AuthenticationsArray of objects

Permissions on resource

permissions.​SourcesArray of objects

Permissions on resource

permissions.​DestinationsArray of objects

Permissions on resource

permissions.​DatabasesArray of objects

Permissions on databases

permissions.​UniversalConsentArray of objects

Permissions on UniversalConsent

permissions.​TrafficControlsArray of objects

Permissions on TrafficControl

permissions.​TrafficControlArray of objects

Permissions on TrafficControl

permissions.​JourneysArray of objects

Permissions on Journeys

permissions.​JourneyArray of objects

Permissions on Journeys in the audience

permissions.​LlmProjectArray of objects

Permissions on LLM Projects

policiesArray of objects(Access Control Policy)
]
Response
application/json
[
  {
    "user_id": 123,
    "account_id": 123,
    "permissions": { … },
    "policies": [ … ]
  }
]

Get Access Control User

Request

Retrieves the specified user.

Security
ApiKeyAuth
Path
user_idinteger(UserId)required
Example: 123
curl -i -X GET \
  https://api.treasuredata.com/v3/access_control/users/123 \
  -H 'Authorization: TD1 <YOUR_TOKEN_HERE>'

Responses

OK

Bodyapplication/json
user_idinteger(UserId)required
Example: 123
account_idinteger(AccountId)required
Example: 123
permissionsobject(Access Control Permissions)required
permissions.​WorkflowProjectArray of objects

Permissions on resource

permissions.​WorkflowProjectLevelArray of objects

Permissions on resource

permissions.​WorkflowRestrictedOperatorsArray of objects

Permissions on resource

permissions.​SegmentationArray of objects

Permissions on resource

permissions.​MasterSegmentConfigsArray of objects

Permissions on resource

permissions.​MasterSegmentConfigArray of objects

Permissions on resource

permissions.​MasterSegmentColumnArray of objects

Permissions on MasterSegmentColumn

permissions.​MasterSegmentAllColumnsArray of objects

Permissions on MasterSegmentAllColumns

permissions.​CookieConsentArray of objects

Permissions on CookieConsent

permissions.​SegmentAllFoldersArray of objects

Permissions on resource

permissions.​SegmentFolderArray of objects

Permissions on resource

permissions.​ProfilesArray of objects

Permissions on resource

permissions.​ProfilesApiTokenArray of objects

Permissions on resource

permissions.​ActivationTemplateArray of objects

Permissions on ActivationTemplate

permissions.​AuthenticationsArray of objects

Permissions on resource

permissions.​SourcesArray of objects

Permissions on resource

permissions.​DestinationsArray of objects

Permissions on resource

permissions.​DatabasesArray of objects

Permissions on databases

permissions.​UniversalConsentArray of objects

Permissions on UniversalConsent

permissions.​TrafficControlsArray of objects

Permissions on TrafficControl

permissions.​TrafficControlArray of objects

Permissions on TrafficControl

permissions.​JourneysArray of objects

Permissions on Journeys

permissions.​JourneyArray of objects

Permissions on Journeys in the audience

permissions.​LlmProjectArray of objects

Permissions on LLM Projects

policiesArray of objects(Access Control Policy)
Response
application/json
{
  "user_id": 123,
  "account_id": 123,
  "permissions": {
    "WorkflowProject": [ … ],
    "WorkflowProjectLevel": [ … ],
    "WorkflowRestrictedOperators": [ … ],
    "Segmentation": [ … ],
    "MasterSegmentConfigs": [ … ],
    "MasterSegmentConfig": [ … ],
    "MasterSegmentColumn": [ … ],
    "MasterSegmentAllColumns": [ … ],
    "CookieConsent": [ … ],
    "SegmentAllFolders": [ … ],
    "SegmentFolder": [ … ],
    "Profiles": [ … ],
    "ProfilesApiToken": [ … ],
    "ActivationTemplate": [ … ],
    "Authentications": [ … ],
    "Sources": [ … ],
    "Destinations": [ … ],
    "Databases": [ … ],
    "UniversalConsent": [ … ],
    "TrafficControls": [ … ],
    "TrafficControl": [ … ],
    "Journeys": [ … ],
    "Journey": [ … ],
    "LlmProject": [ … ]
  },
  "policies": [
    { … }
  ]
}

Update Access Control User Permissions

Request

Updates a user's permissions.

Security
ApiKeyAuth
Path
user_idinteger(UserId)required
Example: 123
Bodyapplication/json
WorkflowProjectArray of objects

Permissions on resource

SegmentationArray of objects

Permissions on resource

MasterSegmentConfigsArray of objects

Permissions on resource

MasterSegmentConfigArray of objects

Permissions on resource

SegmentAllFoldersArray of objects

Permissions on resource

SegmentFolderArray of objects

Permissions on resource

ActivationTemplateArray of objects

Permissions on ActivationTemplate

curl -i -X PATCH \
  https://api.treasuredata.com/v3/access_control/users/123/permissions \
  -H 'Authorization: TD1 <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "WorkflowProject": [
      {
        "operation": "view"
      }
    ],
    "Segmentation": [
      {
        "operation": "full"
      }
    ],
    "MasterSegmentConfigs": [
      {
        "operation": "view"
      }
    ],
    "MasterSegmentConfig": [
      {
        "operation": "view",
        "id": "42"
      }
    ],
    "SegmentAllFolders": [
      {
        "operation": "view",
        "audience_id": "42"
      }
    ],
    "SegmentFolder": [
      {
        "operation": "view",
        "id": "42"
      }
    ],
    "ActivationTemplate": [
      {
        "operation": "view"
      }
    ]
  }'

Responses

OK

Bodyapplication/json
user_idinteger(UserId)required
Example: 123
permissionsobject(Access Control Permissions)required
permissions.​WorkflowProjectArray of objects

Permissions on resource

permissions.​SegmentationArray of objects

Permissions on resource

permissions.​MasterSegmentConfigsArray of objects

Permissions on resource

permissions.​MasterSegmentConfigArray of objects

Permissions on resource

permissions.​SegmentAllFoldersArray of objects

Permissions on resource

permissions.​SegmentFolderArray of objects

Permissions on resource

permissions.​ActivationTemplateArray of objects

Permissions on ActivationTemplate

Response
application/json
{
  "user_id": 123,
  "permissions": {
    "WorkflowProject": [ … ],
    "Segmentation": [ … ],
    "MasterSegmentConfigs": [ … ],
    "MasterSegmentConfig": [ … ],
    "SegmentAllFolders": [ … ],
    "SegmentFolder": [ … ],
    "ActivationTemplate": [ … ]
  }
}

Get Policy users

Request

Retrieves a list of users attached to a policy.

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

Responses

OK

Bodyapplication/jsonArray [
user_idinteger(UserId)required
Example: 123
account_idinteger(AccountId)required
Example: 123
emailstring(email)required

the email user uses to log in

Example: "td@example.com"
namestringrequired

user's full name or email

Example: "Treasure Data"
]
Response
application/json
[
  {
    "user_id": 123,
    "account_id": 123,
    "email": "td@example.com",
    "name": "Treasure Data"
  }
]

Update Policy Users

Request

Updates users attached to a policy.

Security
ApiKeyAuth
Path
policy_idinteger(AccessControlPolicyId)required
Example: 67
Bodyapplication/json
user_idsArray of integers(UserId)required
Example: [123]
curl -i -X PATCH \
  https://api.treasuredata.com/v3/access_control/policies/67/users \
  -H 'Authorization: TD1 <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "user_ids": [
      123
    ]
  }'

Responses

OK

Bodyapplication/jsonArray [
user_idinteger(UserId)required
Example: 123
account_idinteger(AccountId)required
Example: 123
permissionsobject(Access Control Permissions)required
permissions.​WorkflowProjectArray of objects

Permissions on resource

permissions.​WorkflowProjectLevelArray of objects

Permissions on resource

permissions.​WorkflowRestrictedOperatorsArray of objects

Permissions on resource

permissions.​SegmentationArray of objects

Permissions on resource

permissions.​MasterSegmentConfigsArray of objects

Permissions on resource

permissions.​MasterSegmentConfigArray of objects

Permissions on resource

permissions.​MasterSegmentColumnArray of objects

Permissions on MasterSegmentColumn

permissions.​MasterSegmentAllColumnsArray of objects

Permissions on MasterSegmentAllColumns

permissions.​CookieConsentArray of objects

Permissions on CookieConsent

permissions.​SegmentAllFoldersArray of objects

Permissions on resource

permissions.​SegmentFolderArray of objects

Permissions on resource

permissions.​ProfilesArray of objects

Permissions on resource

permissions.​ProfilesApiTokenArray of objects

Permissions on resource

permissions.​ActivationTemplateArray of objects

Permissions on ActivationTemplate

permissions.​AuthenticationsArray of objects

Permissions on resource

permissions.​SourcesArray of objects

Permissions on resource

permissions.​DestinationsArray of objects

Permissions on resource

permissions.​DatabasesArray of objects

Permissions on databases

permissions.​UniversalConsentArray of objects

Permissions on UniversalConsent

permissions.​TrafficControlsArray of objects

Permissions on TrafficControl

permissions.​TrafficControlArray of objects

Permissions on TrafficControl

permissions.​JourneysArray of objects

Permissions on Journeys

permissions.​JourneyArray of objects

Permissions on Journeys in the audience

permissions.​LlmProjectArray of objects

Permissions on LLM Projects

policiesArray of objects(Access Control Policy)
]
Response
application/json
[
  {
    "user_id": 123,
    "account_id": 123,
    "permissions": { … },
    "policies": [ … ]
  }
]

Access Control - Policy Groups

Operations

Connections

Operations

Databases

Operations

Jobs

Operations

Policy Group Tags

Operations

Schedules

Operations

Tables

Operations

Users

Operations

Data Connector Restrictions

Operations