---
title: "Role"
method: GET
path: "/roles/{publicId}"
tags: ["Role"]
---

# Role

`GET /roles/{publicId}`

## Path parameters

- `publicId` string, required

## Query parameters

- `fields` string[]

## Headers

- `Api-Version` 2, required
- `Api-Application` string, required
- `Api-Company` string, required
- `Api-Branding` string

## Response `200`

Success response

- object
  - `status` string, required
  - `type` string, required
  - `data` object, required
    - `publicId` string
    - `name` string
    - `description` string, nullable
    - `enforce2fa` boolean
    - `enforceSso` boolean
    - `permissions` object[]
      - `publicId` string
      - `custom` object
    - `audiences` object[]
      - `publicId` string
      - `name` string
      - `description` string, nullable
      - `custom` object
      - `default` boolean
      - `type` 'alarm' | 'page' | 'service', nullable
    - `custom` object

## Other responses

- `4XX` — 4XX error response

---

[API](https://skmtc.net/ixon/apis/ixon-api.md) · [All operations](https://skmtc.net/ixon/apis/ixon-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/ixon/ixon-api/revisions/7875dc33d41f/schema)