Skip to content
Authrim

List machine access principals

GET
/api/admin/machine-access/principals
Code sample: Shell / cURL 
curl --request GET \
  --url 'https://auth.example.com/api/admin/machine-access/principals?status=active' \
  --header 'Authorization: Bearer <token>'

List machine principals visible to the current admin, including effective permissions, tenant scopes, and credentials.

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Query Parameters

Section titled “Query Parameters ”
status
string
Allowed values: active disabled deleted

Principal status filter.

principal_type
string

Principal type filter.

page
integer format: int64
>= 1

One-based page number.

limit
integer format: int64
>= 1 <= 100

Maximum number of principals to return.

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Machine principal list.

Media type application/json
object
items
required
Array<object>
object
id
string
clientId
string
displayName
string
description
Any of:
string
principalType
string
Allowed values: setup_tool admin_ui_bff automation ci mcp_server ai_agent internal_service integration
status
string
Allowed values: active disabled deleted
tokenTtlSeconds
integer format: int64
createdAt
integer format: int64
updatedAt
integer format: int64
permissions
Array<string>
tenantScopes
Array<object>
object
scope_mode
required
string
Allowed values: none all allow
tenant_id
Any of:
string
credentials
Array<object>
object
id
string
principalId
string
kid
string
publicJwkJson
string
alg
string
Allowed values: ES256 PS256 RS256
displayName
string
description
Any of:
string
status
string
Allowed values: active rotating revoked expired
notBefore
Any of:
integer format: int64
expiresAt
Any of:
integer format: int64
createdAt
integer format: int64
updatedAt
integer format: int64
page
required
integer format: int64
limit
required
integer format: int64
Example 
{
  "items": [
    {
      "id": "amp_123",
      "clientId": "setup-tool",
      "displayName": "Setup Tool",
      "description": "Automation used by setup.",
      "principalType": "setup_tool",
      "status": "active",
      "tokenTtlSeconds": 600,
      "createdAt": 1770000000000,
      "updatedAt": 1770000000000,
      "permissions": [
        "admin:tenants:read"
      ],
      "tenantScopes": [
        {
          "scopeMode": "allow",
          "tenantId": "tenant_123"
        }
      ],
      "credentials": []
    }
  ],
  "page": 1,
  "limit": 50
}

default

Section titled “default ”

Error response.

Media type application/json
object
error
string
message
string
error_description
string
key
additional properties
Example generated
{
  "error": "example",
  "message": "example",
  "error_description": "example"
}