neoserver 0.1.2

List roles

GET /api/v1/roles · Roles

← All operations and schemas

GET /api/v1/roles

Returns all roles. Requires super_admin role.

Operation ID: listRoles

Authentication

Use one of the following authentication options. Permissions and workspace scope still apply. See authentication and access control.

Authorization: Bearer YOUR_ACCESS_TOKEN
X-API-Key: YOUR_API_KEY

Responses

200 List of roles

Content type application/json

object

roles array of Role ↗

401 Unauthorized

Content type application/json

403 Forbidden - requires super_admin role

Content type application/json

413 Request body exceeds the configured limit

Content type application/json

426 HTTPS required

Content type application/json

429 Request rate exceeded

Content type application/json

503 Service temporarily unavailable

Content type application/json

OpenAPI operation definition

{
  "description": "Returns all roles. Requires super_admin role.",
  "operationId": "listRoles",
  "responses": {
    "200": {
      "content": {
        "application/json": {
          "schema": {
            "properties": {
              "roles": {
                "items": {
                  "$ref": "#/components/schemas/Role"
                },
                "type": "array"
              }
            },
            "type": "object"
          }
        }
      },
      "description": "List of roles"
    },
    "401": {
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/Error"
          }
        }
      },
      "description": "Unauthorized"
    },
    "403": {
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/Error"
          }
        }
      },
      "description": "Forbidden - requires super_admin role"
    },
    "413": {
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/Error"
          }
        }
      },
      "description": "Request body exceeds the configured limit"
    },
    "426": {
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/Error"
          }
        }
      },
      "description": "HTTPS required"
    },
    "429": {
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/Error"
          }
        }
      },
      "description": "Request rate exceeded"
    },
    "503": {
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/Error"
          }
        }
      },
      "description": "Service temporarily unavailable"
    }
  },
  "summary": "List roles",
  "tags": [
    "Roles"
  ]
}