permissions

Description

Retrieves access permissions for the current user.

Request

Method Path
GET /api/v1/permissions

Response

Fields

Name Type Description
roles array List of user roles.
user-groups array List of groups to which the user belongs.
entity-groups map read and write entity group permissions granted to the user, for example "aws-ec2": "WRITE".
portals array List of portals the user is authorized to view.
all-entities-read boolean User is authorized to read data for any entity.
all-entities-write boolean User is authorized to write data for any entity.
all-portals-permission boolean User is authorized to view all portals enabled in the system.
ip-filter string String with IP address or CIDR ranges from which the user is allowed to make requests.

Example

Request

URI

GET /api/v1/permissions

curl

curl https://atsd_hostname:8443/api/v1/permissions \
  --insecure --include --user {username}:{password}

Response

  • Non-administrative user
{
  "roles": [
    "ROLE_API_DATA_WRITE", "ROLE_API_DATA_READ", "ROLE_API_META_WRITE", "ROLE_API_META_READ"
  ],
  "user-groups": [
    "Editors"
  ],
  "entity-groups": {
    "java-virtual-machine": "READ"
  },
  "portals": [
    "ATSD"
  ],
  "all-entities-read": false,
  "all-entities-write": true,
  "all-portals-permission": false,
  "ip-filter": "203.0.113.0/24"
}
  • API user:
{
  "roles": ["ROLE_API_DATA_WRITE", "ROLE_API_DATA_READ", "ROLE_API_META_WRITE", "ROLE_API_META_READ"],
  "user-groups": ["data-meta-all-entity-write-collectors", "docker-entities-read"],
  "entity-groups": {
    "docker-containers": "READ",
    "docker-images": "READ",
    "docker-networks": "READ",
    "docker-volumes": "READ"
  },
  "all-entities-read": false,
  "all-entities-write": true,
  "all-portals-permission": false,
  "portals": [],
  "ip-filter": "192.0.2.1 192.0.2.2"
}
  • Administrator user:
{
  "roles": ["ROLE_ADMIN"] ,
  "user-groups":[],
  "entity-groups":{},
  "all-entities-read":true,
  "all-entities-write":true,
  "all-portals-permission":true,
  "portals":[],
  "ip-filter": null
}