---
title: "List roles"
url: "https://nov18-dev.movespot.fyi/apis/internal-pdp-auth-admin-api-v1-1/versions/65945f7f-ee1f-40d6-be36-704dd7f85fcb/operations/listRoles"
---

> Full API specification: https://nov18-dev.movespot.fyi/apis/internal-pdp-auth-admin-api-v1-1/versions/65945f7f-ee1f-40d6-be36-704dd7f85fcb.md

# List roles

`GET` `/roles`

Operation ID: `listRoles`

Returns a paginated list of all roles

## Responses

- `200` - Successful response

## OpenAPI definition

```yaml
openapi: 3.0.3
info:
  title: Internal PDP Auth Admin API v1
  version: 1.0.0
servers:
  - url: http://authorization-admin-api.kauth.svc.cluster.local:8000/v1
    description: Konnect cluster
paths:
  /roles:
    get:
      operationId: listRoles
      summary: List roles
      description: Returns a paginated list of all roles
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/RolesResponse"
      tags:
        - Roles
components:
  schemas:
    RolesResponse:
      type: object
      properties:
        meta:
          $ref: "#/components/schemas/PaginatedMeta"
        data:
          type: array
          items:
            $ref: "#/components/schemas/Role"
      required:
        - meta
        - data
    PaginatedMeta:
      description: returns the pagination information
      type: object
      properties:
        page:
          $ref: "#/components/schemas/PageMeta"
      required:
        - page
      title: PaginatedMeta
    Role:
      description: A role that can be assigned to users or teams
      type: object
      properties:
        id:
          description: Unique identifier of the role
          type: string
        domain:
          description: Domain the role is associated with
          type: string
        name:
          description: Name of the role
          type: string
        display_name:
          description: Display name of the role
          type: string
        description:
          description: Description of the role
          type: string
        feature_flag:
          description: Optional feature flag which guards the role
          type: string
          nullable: true
        actions:
          description: List of actions granted by the role
          type: array
          items:
            type: string
        entity_type:
          description: Entity type of the role
          type: string
        internal:
          description: Whether the role is available to Konnect users
          type: boolean
      required:
        - id
        - domain
        - name
        - display_name
        - description
        - actions
        - entity_type
        - internal
    PageMeta:
      description: Contains pagination query parameters and the total number of
        objects returned.
      type: object
      properties:
        number:
          type: number
          example: 1
        size:
          type: number
          example: 10
        total:
          type: number
          example: 100
      required:
        - number
        - size
        - total
```
