attributeGroups.list

List attribute groups, their management types, and their attribute values.

Facts


Method	`GET https://api.getdx.com/attributeGroups.list`
Required scope	`snapshots:read`

Arguments

Name	Type	Description
`token`	`Token`	Auth token passed as an HTTP header.

Example request

This request lists every attribute group and its values:

curl -X GET 'https://api.getdx.com/attributeGroups.list' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer xxxx-xxxxxxxxx-xxxx'

Example response

This is a typical success response:

{
  "ok": true,
  "attribute_groups": [
    {
      "id": "MTAx",
      "name": "Location",
      "type": "admin_managed",
      "attributes": [
        {
          "id": "NDAx",
          "name": "US-East"
        },
        {
          "id": "NDAy",
          "name": "Northeast"
        }
      ]
    }
  ]
}

Response fields

Attribute group list item

Each list item contains the AttributeGroup fields plus an attributes array.

Field	Type	Description
`id`	`String`	The unique attribute-group ID.
`name`	`String`	The attribute-group name.
`type`	`String`	`admin_managed`, `self_reported`, or `dx_managed`.
`attributes`	`Array`	Attribute values that belong to this group.

Attribute object

Field	Type	Description
`id`	`String`	The unique attribute value ID.
`name`	`String`	The attribute value name.

Errors

Check ok in every response. If it is false, use the error code to identify the problem.

Error	Description
`not_authed`	No authentication token provided.
`invalid_auth`	DX cannot validate the authentication credentials.