neoserver 0.1.2

Inspect role deletion dependencies

GET /api/v1/roles/{roleId}/deletion-plan · Roles

← All operations and schemas

GET /api/v1/roles/{roleId}/deletion-plan

Operation ID: getRoleDeletionPlan

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

Parameters

roleId path required: Role ID

string

Responses

200 Role dependencies

Content type application/json

object

dependencies object required: Additional properties: values must match the following schema

integer
is_system boolean required
role_id string required

401 Authentication required or credential rejected

Content type application/json

403 Insufficient permission, disabled login, or invalid CSRF

Content type application/json

404 Role not found

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 Dependency inspection unavailable

Content type application/json

OpenAPI operation definition

{
  "operationId": "getRoleDeletionPlan",
  "parameters": [
    {
      "description": "Role ID",
      "in": "path",
      "name": "roleId",
      "required": true,
      "schema": {
        "type": "string"
      }
    }
  ],
  "responses": {
    "200": {
      "content": {
        "application/json": {
          "schema": {
            "properties": {
              "dependencies": {
                "additionalProperties": {
                  "type": "integer"
                },
                "type": "object"
              },
              "is_system": {
                "type": "boolean"
              },
              "role_id": {
                "type": "string"
              }
            },
            "required": [
              "role_id",
              "is_system",
              "dependencies"
            ],
            "type": "object"
          }
        }
      },
      "description": "Role dependencies"
    },
    "401": {
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/Error"
          }
        }
      },
      "description": "Authentication required or credential rejected"
    },
    "403": {
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/Error"
          }
        }
      },
      "description": "Insufficient permission, disabled login, or invalid CSRF"
    },
    "404": {
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/Error"
          }
        }
      },
      "description": "Role not found"
    },
    "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": "Dependency inspection unavailable"
    }
  },
  "summary": "Inspect role deletion dependencies",
  "tags": [
    "Roles"
  ]
}