Skip to content
TD API
/
API References
/
Access Control - Policy Groups
/
Get an Access Control Policy Group's Policies

Treasure Data API (3)

Download OpenAPI description
td-api.json
td-api.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

Access Control - Policy Groups

Operations

get Access Control Policy Groups

Request

Retrieves a list of policy groups.

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

Responses

OK

Bodyapplication/jsonArray [
idinteger(AccessControlPolicyGroupId)
Example: 10
account_idinteger(AccountId)
Example: 123
namestringrequired

Policy Group's name

Example: "some_policy_group"
taggable_namestring(AccessControlPolicyGroupTaggableName)

Policy Group's taggable name

Example: "some_policy_group"
descriptionstring or null

Policy Group's description

Example: "some_policy_group_description"
policy_countinteger

Policy Group's policy count

Example: 1
created_atstring(date-time)

when the policy group was created

Example: "2012-01-01T12:00:00Z"
updated_atstring(date-time)

when policy group was updated

Example: "2012-01-01T12:00:00Z"
]
Response
application/json
[
  {
    "id": 10,
    "account_id": 123,
    "name": "some_policy_group",
    "taggable_name": "some_policy_group",
    "description": "some_policy_group_description",
    "policy_count": 1,
    "created_at": "2012-01-01T12:00:00Z",
    "updated_at": "2012-01-01T12:00:00Z"
  }
]

Create an Access Control Policy Group

Request

Creates a policy group.

Security
ApiKeyAuth
Bodyapplication/json
namestringrequired

Policy Group's name

Example: "some_policy_group"
curl -i -X POST \
  https://api.treasuredata.com/v3/access_control/policy_groups \
  -H 'Authorization: TD1 <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "some_policy_group"
  }'

Responses

OK

Bodyapplication/json
idinteger(AccessControlPolicyGroupId)
Example: 10
account_idinteger(AccountId)
Example: 123
namestringrequired

Policy Group's name

Example: "some_policy_group"
taggable_namestring(AccessControlPolicyGroupTaggableName)

Policy Group's taggable name

Example: "some_policy_group"
descriptionstring or null

Policy Group's description

Example: "some_policy_group_description"
policy_countinteger

Policy Group's policy count

Example: 1
created_atstring(date-time)

when the policy group was created

Example: "2012-01-01T12:00:00Z"
updated_atstring(date-time)

when policy group was updated

Example: "2012-01-01T12:00:00Z"
Response
application/json
{
  "id": 10,
  "account_id": 123,
  "name": "some_policy_group",
  "taggable_name": "some_policy_group",
  "description": "some_policy_group_description",
  "policy_count": 1,
  "created_at": "2012-01-01T12:00:00Z",
  "updated_at": "2012-01-01T12:00:00Z"
}

Get an Access Control Policy Group

Request

Retrieves information about the specified policy group.

Security
ApiKeyAuth
Path
policy_group_id_or_taggable_nameAccessControlPolicyGroupId (integer) or AccessControlPolicyGroupTaggableName (string)required
Example: 67 or some_policy_group
Any of:
integer(AccessControlPolicyGroupId)
curl -i -X GET \
  'https://api.treasuredata.com/v3/access_control/policy_groups/67 or some_policy_group' \
  -H 'Authorization: TD1 <YOUR_TOKEN_HERE>'

Responses

OK

Bodyapplication/json
idinteger(AccessControlPolicyGroupId)
Example: 10
account_idinteger(AccountId)
Example: 123
namestringrequired

Policy Group's name

Example: "some_policy_group"
taggable_namestring(AccessControlPolicyGroupTaggableName)

Policy Group's taggable name

Example: "some_policy_group"
descriptionstring or null

Policy Group's description

Example: "some_policy_group_description"
policy_countinteger

Policy Group's policy count

Example: 1
created_atstring(date-time)

when the policy group was created

Example: "2012-01-01T12:00:00Z"
updated_atstring(date-time)

when policy group was updated

Example: "2012-01-01T12:00:00Z"
Response
application/json
{
  "id": 10,
  "account_id": 123,
  "name": "some_policy_group",
  "taggable_name": "some_policy_group",
  "description": "some_policy_group_description",
  "policy_count": 1,
  "created_at": "2012-01-01T12:00:00Z",
  "updated_at": "2012-01-01T12:00:00Z"
}

Update an Access Control Policy Group

Request

Updates information related to a policy group.

Security
ApiKeyAuth
Path
policy_group_id_or_taggable_nameAccessControlPolicyGroupId (integer) or AccessControlPolicyGroupTaggableName (string)required
Example: 67 or some_policy_group
Any of:
integer(AccessControlPolicyGroupId)
Bodyapplication/json
namestringrequired

Policy Group's name

Example: "some_policy_group"
descriptionstring or null

Policy Group's description

Example: "some_policy_group_description"
curl -i -X PATCH \
  'https://api.treasuredata.com/v3/access_control/policy_groups/67 or some_policy_group' \
  -H 'Authorization: TD1 <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "some_policy_group",
    "description": "some_policy_group_description"
  }'

Responses

OK

Bodyapplication/json
idinteger(AccessControlPolicyGroupId)
Example: 10
account_idinteger(AccountId)
Example: 123
namestringrequired

Policy Group's name

Example: "some_policy_group"
taggable_namestring(AccessControlPolicyGroupTaggableName)

Policy Group's taggable name

Example: "some_policy_group"
descriptionstring or null

Policy Group's description

Example: "some_policy_group_description"
policy_countinteger

Policy Group's policy count

Example: 1
created_atstring(date-time)

when the policy group was created

Example: "2012-01-01T12:00:00Z"
updated_atstring(date-time)

when policy group was updated

Example: "2012-01-01T12:00:00Z"
Response
application/json
{
  "id": 10,
  "account_id": 123,
  "name": "some_policy_group",
  "taggable_name": "some_policy_group",
  "description": "some_policy_group_description",
  "policy_count": 1,
  "created_at": "2012-01-01T12:00:00Z",
  "updated_at": "2012-01-01T12:00:00Z"
}

Delete an Access Control Policy Group

Request

Deletes a policy group.

Security
ApiKeyAuth
Path
policy_group_id_or_taggable_nameAccessControlPolicyGroupId (integer) or AccessControlPolicyGroupTaggableName (string)required
Example: 67 or some_policy_group
Any of:
integer(AccessControlPolicyGroupId)
curl -i -X DELETE \
  'https://api.treasuredata.com/v3/access_control/policy_groups/67 or some_policy_group' \
  -H 'Authorization: TD1 <YOUR_TOKEN_HERE>'

Responses

OK

Get an Access Control Policy Group's Policies

Request

Retrieves the list of the specified policy group's policies.

Security
ApiKeyAuth
Path
policy_group_id_or_taggable_nameAccessControlPolicyGroupId (integer) or AccessControlPolicyGroupTaggableName (string)required
Example: 67 or some_policy_group
Any of:
integer(AccessControlPolicyGroupId)
curl -i -X GET \
  'https://api.treasuredata.com/v3/access_control/policy_groups/67 or some_policy_group/policies' \
  -H 'Authorization: TD1 <YOUR_TOKEN_HERE>'

Responses

OK

Bodyapplication/json
policy_idsArray of integers(AccessControlPolicyId)required

Policy Group's Policies

Example: [67]
Response
application/json
{
  "policy_ids": [
    67
  ]
}

Update an Access Control Policy Group's Policies

Request

Updates the policies attached to a policy group.

Security
ApiKeyAuth
Path
policy_group_id_or_taggable_nameAccessControlPolicyGroupId (integer) or AccessControlPolicyGroupTaggableName (string)required
Example: 67 or some_policy_group
Any of:
integer(AccessControlPolicyGroupId)
Bodyapplication/json
policy_idsArray of integers(AccessControlPolicyId)required

Policy Group's Policies

Example: [67]
curl -i -X PATCH \
  'https://api.treasuredata.com/v3/access_control/policy_groups/67 or some_policy_group/policies' \
  -H 'Authorization: TD1 <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "policy_ids": [
      67
    ]
  }'

Responses

OK

Bodyapplication/json
policy_idsArray of integers(AccessControlPolicyId)required

Policy Group's Policies

Example: [67]
Response
application/json
{
  "policy_ids": [
    67
  ]
}

Connections

Operations

Databases

Operations

Jobs

Operations

Tables

Operations

Policy Group Tags

Operations

Schedules

Operations

Users

Operations