Skip to content

ListRoles

Request

Fetches list of roles. User must have a valid token with required permissions.

Endpoint: GET /v1/roles. Authentication: requires AuthorizationHeader bearer token unless this operation's security is changed. Required AuthMind permission/scope: admin/user (grant this scope on the API token in Admin > API Tokens; a token without it receives 403 Forbidden). No query or path parameters are documented for this operation. Response parsing: inspect success; on failure inspect error, errors, or message depending on the referenced schema.

Security
AuthorizationHeader
curl -i -X GET \
  https://apidoc.authmind.com/_mock/v1/docs/v1/roles \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Request completed successfully. See the referenced schema for the response envelope and result payload.

Bodyapplication/json
errorstring

Error message returned when the request fails. This is free-form, human-readable text intended for logging/display -- AuthMind does not define a stable, cross-endpoint error-code contract for it. Branch integration logic on the HTTP status code and the success boolean, not on the contents of this string.

resultArray of strings

List of role names available for this tenant. Built-in roles are Admin, Analyst, Security Operator, and Incident Responder; self-hosted deployments additionally expose Platform Admin to root callers. The internal Root role is never returned. Use these exact strings for role when creating or updating a user.

Example:
[
  "Admin",
  "Analyst",
  "Security Operator",
  "Incident Responder"
]
successboolean

Indicates whether the request was successful.

Response
{
  "error": "",
  "result": [
    "Admin",
    "Analyst",
    "Security Operator",
    "Incident Responder"
  ],
  "success": true
}