get_org_admin_by_orgid_roles

Read-only

Calls GET /api/org-admin/{orgId}/roles as the signed-in person · REST reference

The organization's roles and what each grants

With the caller's own token; requires admin.roles.view in the organization.

Arguments

ArgumentTypeDescription
orgIdpathstring (uuid)required

Example call

A client sends this over the MCP session; Claude and other agents build it for you. The values are placeholders — the shape is real.

json
{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "get_org_admin_by_orgid_roles",
    "arguments": {
      "orgId": "11111111-1111-4111-8111-111111111111"
    }
  }
}

Result

On success (HTTP 200) the tool returns one text item holding the API's JSON, pretty-printed.

The organization's live roles, built-in ones first.

json
{
  "data": [
    {
      "editable": true,
      "grants": [],
      "groupCount": 1,
      "id": "11111111-1111-4111-8111-111111111111",
      "name": "string",
      "orgId": "11111111-1111-4111-8111-111111111111",
      "code": "string",
      "description": "string"
    }
  ],
  "success": true
}

Fields

FieldTypeDescription
dataarray of object
data[].codestring | nullOWNER or ORG_USER for the two built-in roles; null for a role the organization made.
data[].descriptionstring | null
data[].editablebooleanFalse for the built-in roles — OWNER holds exactly the type's entitlements, ORG_USER exactly the read-only baseline — and for a role this organization does not own.
data[].grantsarray of object
data[].grants[].categorystring
data[].grants[].descriptionstring
data[].grants[].featurestringThe catalog feature id, e.g. hospital.vouchers.redeem
data[].grants[].idstring (uuid)
data[].grants[].namestring
data[].grants[].orgIdstring (uuid)
data[].grants[].riskLevel"LOW" | "MEDIUM" | "HIGH" | "CRITICAL"
data[].groupCountinteger
data[].idstring (uuid)
data[].namestring
data[].orgIdstring (uuid)
successtrue

When it fails

A failed call returns isError: true with the API's message as text.

400

The request was malformed or failed a guard.

403

Authenticated, but the caller holds none of the required permissions.

What the model is shown

This is the tool exactly as the server lists it in tools/list. The description starts with the REST call it makes.

json
{
  "name": "get_org_admin_by_orgid_roles",
  "description": "GET /api/org-admin/{orgId}/roles — With the caller's own token; requires `admin.roles.view` in the organization.",
  "inputSchema": {
    "type": "object",
    "properties": {
      "orgId": {
        "type": "string"
      }
    },
    "required": [
      "orgId"
    ]
  },
  "annotations": {
    "readOnlyHint": true,
    "openWorldHint": false
  }
}