Returns an Access group by ID.

Request

Security

ApiKeyAuth

Path

accessGroupIdstring, non-emptyrequired

The ID of the Access group.

curl -i -X GET \
  'https://help-api.delphix.com/_mock/data-control-tower/continuous-data/22.0.0/continuous-data-apis-dct-22.0.0/access-groups/{accessGroupId}' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

OK

Bodyapplication/json

idstringread-only

The Access group ID.

namestring, [ 1 .. 256 ] charactersrequired

The Access group name

single_accountboolean

Indicates that this Access group defines the permissions of a single account, and thus account and account tags cannot be modified. Instead create a new Access group to manage permissions of multiple accounts.

account_idsArray of integers, (int64)

List of accounts ids included individually (as opposed to added by tags) in the Access group.

tagged_account_idsArray of integers, (int64)read-only

List of accounts ids included by tags in the Access group.

account_tagsArray of objects(Tag)

List of account tags. Accounts matching any of these tags will be automatically added to the Access group.

scopesArray of objects(AccessGroupScope)

The Access group scopes.

Response

{
  "id": "string",
  "name": "string",
  "single_account": true,
  "account_ids": [
    0
  ],
  "tagged_account_ids": [
    0
  ],
  "account_tags": [
    { … }
  ],
  "scopes": [
    { … }
  ]
}