lumoauth / api-client
Generated LumoAuth API client (raw HTTP client + typed models). Use for full raw API coverage; ergonomic wrapper next.
Requires
- php: ^8.1
- ext-curl: *
- ext-json: *
- ext-mbstring: *
- guzzlehttp/guzzle: ^7.3
- guzzlehttp/psr7: ^1.7 || ^2.0
Requires (Dev)
None
Suggests
None
Provides
None
Conflicts
None
Replaces
None
This package is not auto-updated.
Last update: 2026-10-30 17:01:13 UTC
README
GENERATED CLIENT — raw API coverage. This package is generated from the LumoAuth OpenAPI spec (
api-clients/openapi.json) by thesdk-codegenpipeline. It covers the full REST surface with typed models but no framework sugar. An ergonomic, hand-maintained wrapper is the next step — where one already exists (@lumoauth/client/@lumoauth/backendand friends on npm,lumoauthon PyPI,github.com/lumoauth/lumo-auth-go), prefer it. Do not edit by hand: changes are overwritten on the next regeneration.
LumoAuthApiClient
LumoAuth REST API — authentication, authorization, agent registry,
MCP server authorization, and tenant administration. Multi-tenant:
most paths are scoped under /orgs/{orgId}/api/v1/....
For more information, please visit https://lumoauth.dev.
Installation & Usage
Requirements
PHP 8.1 and later.
Composer
composer require lumoauth/api-client
From a checkout of api-clients/ instead of Packagist, point a path repository at the php/ directory:
{
"repositories": [{ "type": "path", "url": "../api-clients/php" }],
"require": { "lumoauth/api-client": "*" }
}
Manual Installation
Download the files and include autoload.php:
<?php require_once('/path/to/LumoAuthApiClient/vendor/autoload.php');
Getting Started
Please follow the installation procedure and then run the following:
<?php require_once(__DIR__ . '/vendor/autoload.php'); // Configure Bearer (JWT) authorization: AAuthSigned $config = LumoAuth\ApiClient\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN'); $apiInstance = new LumoAuth\ApiClient\Api\AAuthApi( // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. // This is optional, `GuzzleHttp\Client` will be used as default. new GuzzleHttp\Client(), $config ); $orgId = 'orgId_example'; // string try { $apiInstance->authorizeAgent($orgId); } catch (Exception $e) { echo 'Exception when calling AAuthApi->authorizeAgent: ', $e->getMessage(), PHP_EOL; }
API Endpoints
All URIs are relative to https://app.lumoauth.dev
| Class | Method | HTTP request | Description |
|---|---|---|---|
| AAuthApi | authorizeAgent | GET /orgs/{orgId}/api/v1/aauth/agent/auth | Agent Auth Endpoint - redirects to user consent page. |
| AAuthApi | getAgentJwks | GET /orgs/{orgId}/api/v1/aauth/agents/{agentId}/jwks.json | Agent JWKS endpoint |
| AAuthApi | getAgentMetadata | GET /orgs/{orgId}/api/v1/.well-known/aauth-agent | Agent Metadata (Section 8.1) Published at /.well-known/aauth-agent for registered agents. |
| AAuthApi | getAgentMetadataById | GET /orgs/{orgId}/api/v1/aauth/agents/{agentId}/metadata | Individual Agent Metadata |
| AAuthApi | getIssuerJwks | GET /orgs/{orgId}/api/v1/aauth/jwks.json | Auth Server JWKS endpoint for AAuth. |
| AAuthApi | getIssuerMetadata | GET /orgs/{orgId}/api/v1/.well-known/aauth-issuer | Auth Server Metadata (Section 8.2) Published at /.well-known/aauth-issuer for each tenant. |
| AAuthApi | getResourceJwks | GET /orgs/{orgId}/api/v1/aauth/resources/{resourceId}/jwks.json | Resource JWKS endpoint |
| AAuthApi | getResourceMetadata | GET /orgs/{orgId}/api/v1/.well-known/aauth-resource | Resource Metadata (Section 8.3) |
| AAuthApi | getResourceMetadataById | GET /orgs/{orgId}/api/v1/aauth/resources/{resourceId}/metadata | Individual Resource Metadata |
| AAuthApi | issueAgentToken | POST /orgs/{orgId}/api/v1/aauth/agent/token | Agent Token Endpoint |
| AAuthApi | issueDelegateToken | POST /orgs/{orgId}/api/v1/aauth/agent/issue | Issue an agent token to a delegate. |
| AAuthApi | issuePlatformToken | POST /orgs/{orgId}/api/v1/aauth/agent/platform-token | |
| AAuthApi | issueResourceToken | POST /orgs/{orgId}/api/v1/aauth/resource/token | Resource Token Endpoint (Section 6) |
| AAuthApi | revokeAgentToken | POST /orgs/{orgId}/api/v1/aauth/token/revoke | Revoke an auth token or refresh token. |
| AAuthApi | verifyAuthToken | POST /orgs/{orgId}/api/v1/aauth/auth/token/verify | Auth Token Verification endpoint. |
| AAuthApi | verifyResourceToken | POST /orgs/{orgId}/api/v1/aauth/resource/token/verify | Resource Token Verification (for resources to validate their own tokens). |
| AdminAbacApi | abacAttributesCreate | POST /orgs/{orgId}/api/v1/abac/attributes | Create an attribute definition |
| AdminAbacApi | abacAttributesDelete | DELETE /orgs/{orgId}/api/v1/abac/attributes/{id} | Delete an attribute definition |
| AdminAbacApi | abacAttributesGet | GET /orgs/{orgId}/api/v1/abac/attributes/{id} | Get an attribute definition |
| AdminAbacApi | abacAttributesList | GET /orgs/{orgId}/api/v1/abac/attributes | List attribute definitions |
| AdminAbacApi | abacPoliciesCreate | POST /orgs/{orgId}/api/v1/abac/policies | Create an ABAC policy |
| AdminAbacApi | abacPoliciesDelete | DELETE /orgs/{orgId}/api/v1/abac/policies/{id} | Delete an ABAC policy |
| AdminAbacApi | abacPoliciesGet | GET /orgs/{orgId}/api/v1/abac/policies/{id} | Get an ABAC policy |
| AdminAbacApi | abacPoliciesList | GET /orgs/{orgId}/api/v1/abac/policies | List ABAC policies |
| AdminAbacApi | abacPoliciesToggle | POST /orgs/{orgId}/api/v1/abac/policies/{id}/toggle | Toggle a policy between active and inactive |
| AdminAbacApi | patchAbacAttributesUpdate | PATCH /orgs/{orgId}/api/v1/abac/attributes/{id} | Partially update an attribute definition |
| AdminAbacApi | patchAbacPoliciesUpdate | PATCH /orgs/{orgId}/api/v1/abac/policies/{id} | Partially update an ABAC policy |
| AdminAbacApi | putAbacAttributesUpdate | PUT /orgs/{orgId}/api/v1/abac/attributes/{id} | Update an attribute definition |
| AdminAbacApi | putAbacPoliciesUpdate | PUT /orgs/{orgId}/api/v1/abac/policies/{id} | Update an ABAC policy |
| AdminAgentsApi | adminAgentsActivate | POST /orgs/{orgId}/api/v1/admin/agents/{agentId}/activate | Activate an agent |
| AdminAgentsApi | adminAgentsAgentsDisable | POST /orgs/{orgId}/api/v1/admin/agents/{agentId}/disable | Disable agent |
| AdminAgentsApi | adminAgentsAgentsEnable | POST /orgs/{orgId}/api/v1/admin/agents/{agentId}/enable | Enable agent |
| AdminAgentsApi | adminAgentsAgentsRotateKey | POST /orgs/{orgId}/api/v1/admin/agents/{agentId}/rotate-key | Rotate agent API key |
| AdminAgentsApi | adminAgentsCreate | POST /orgs/{orgId}/api/v1/admin/agents | Create a new agent |
| AdminAgentsApi | adminAgentsDeactivate | POST /orgs/{orgId}/api/v1/admin/agents/{agentId}/deactivate | Deactivate an agent |
| AdminAgentsApi | adminAgentsDelete | DELETE /orgs/{orgId}/api/v1/admin/agents/{agentId} | Delete an agent |
| AdminAgentsApi | adminAgentsGenerateToken | POST /orgs/{orgId}/api/v1/admin/agents/{agentId}/token | Generate a token for the agent |
| AdminAgentsApi | adminAgentsGet | GET /orgs/{orgId}/api/v1/admin/agents/{agentId} | Get a single agent by ID or agentId |
| AdminAgentsApi | adminAgentsGetScopes | GET /orgs/{orgId}/api/v1/admin/agents/{agentId}/scopes | Get agent scopes/capabilities |
| AdminAgentsApi | adminAgentsList | GET /orgs/{orgId}/api/v1/admin/agents | List all agents in the tenant |
| AdminAgentsApi | adminAgentsRevokeKey | POST /orgs/{orgId}/api/v1/admin/agents/{agentId}/revoke-key | Revoke agent API key (nullify it so it can no longer authenticate) |
| AdminAgentsApi | adminAgentsRotateCredentials | POST /orgs/{orgId}/api/v1/admin/agents/{agentId}/rotate-credentials | Rotate agent credentials |
| AdminAgentsApi | adminAgentsSetScopes | PUT /orgs/{orgId}/api/v1/admin/agents/{agentId}/scopes | Update agent scopes/capabilities |
| AdminAgentsApi | patchAdminAgentsUpdate | PATCH /orgs/{orgId}/api/v1/admin/agents/{agentId} | Update an existing agent |
| AdminAgentsApi | putAdminAgentsUpdate | PUT /orgs/{orgId}/api/v1/admin/agents/{agentId} | Update an existing agent |
| AdminAuditLogsApi | adminAuditLogsActions | GET /orgs/{orgId}/api/v1/admin/audit-logs/actions | List the distinct audit action types recorded for the tenant |
| AdminAuditLogsApi | adminAuditLogsExport | GET /orgs/{orgId}/api/v1/admin/audit-logs/export | Export audit logs as CSV (default) or JSON |
| AdminAuditLogsApi | adminAuditLogsGet | GET /orgs/{orgId}/api/v1/admin/audit-logs/{logId} | Get an audit log entry |
| AdminAuditLogsApi | adminAuditLogsList | GET /orgs/{orgId}/api/v1/admin/audit-logs | List audit log entries |
| AdminAuditLogsApi | adminAuditLogsRetention | GET /orgs/{orgId}/api/v1/admin/audit-logs/retention | Get audit log retention settings |
| AdminAuditLogsApi | adminAuditLogsStats | GET /orgs/{orgId}/api/v1/admin/audit-logs/stats | Audit log statistics for a period (default: last 30 days) |
| AdminAuditLogsApi | patchAdminAuditLogsRetentionUpdate | PATCH /orgs/{orgId}/api/v1/admin/audit-logs/retention | Update audit log retention settings |
| AdminAuditLogsApi | putAdminAuditLogsRetentionUpdate | PUT /orgs/{orgId}/api/v1/admin/audit-logs/retention | Update audit log retention settings |
| AdminEmailApi | adminEmailTemplatesDelete | DELETE /orgs/{orgId}/api/v1/admin/email-templates/{type} | Remove the custom email template so the built-in default is used |
| AdminEmailApi | adminEmailTemplatesGet | GET /orgs/{orgId}/api/v1/admin/email-templates/{type} | Get an email template (custom or built-in default) |
| AdminEmailApi | adminEmailTemplatesList | GET /orgs/{orgId}/api/v1/admin/email-templates | List every email template type with its current (custom or built-in) template |
| AdminEmailApi | adminEmailTemplatesPreview | POST /orgs/{orgId}/api/v1/admin/email-templates/{type}/preview | Render an email template with sample data |
| AdminEmailApi | adminEmailTemplatesUpsert | PUT /orgs/{orgId}/api/v1/admin/email-templates/{type} | Create or replace the custom email template for a type |
| AdminEmailApi | adminEmailTemplatesVariables | GET /orgs/{orgId}/api/v1/admin/email-templates/{type}/variables | List the placeholders available to an email template type |
| AdminGroupsApi | adminGroupsAddMembers | POST /orgs/{orgId}/api/v1/admin/groups/{groupId}/members | Add member(s) to group |
| AdminGroupsApi | adminGroupsAddRole | POST /orgs/{orgId}/api/v1/admin/groups/{groupId}/roles | Add a single role to a group |
| AdminGroupsApi | adminGroupsCreate | POST /orgs/{orgId}/api/v1/admin/groups | Create a new group |
| AdminGroupsApi | adminGroupsDelete | DELETE /orgs/{orgId}/api/v1/admin/groups/{groupId} | Delete a group |
| AdminGroupsApi | adminGroupsGet | GET /orgs/{orgId}/api/v1/admin/groups/{groupId} | Get a single group by ID or slug |
| AdminGroupsApi | adminGroupsGetMembers | GET /orgs/{orgId}/api/v1/admin/groups/{groupId}/members | Get group members |
| AdminGroupsApi | adminGroupsGroupsGetRoles | GET /orgs/{orgId}/api/v1/admin/groups/{groupId}/roles | Get group roles |
| AdminGroupsApi | adminGroupsList | GET /orgs/{orgId}/api/v1/admin/groups | List all groups in the tenant |
| AdminGroupsApi | adminGroupsRemoveMember | DELETE /orgs/{orgId}/api/v1/admin/groups/{groupId}/members/{userId} | Remove member from group |
| AdminGroupsApi | adminGroupsRemoveRole | DELETE /orgs/{orgId}/api/v1/admin/groups/{groupId}/roles/{roleId} | Remove a role from a group |
| AdminGroupsApi | adminGroupsUpdateRoles | PUT /orgs/{orgId}/api/v1/admin/groups/{groupId}/roles | Update group roles (replaces all existing roles) |
| AdminGroupsApi | patchAdminGroupsUpdate | PATCH /orgs/{orgId}/api/v1/admin/groups/{groupId} | Update an existing group |
| AdminGroupsApi | putAdminGroupsUpdate | PUT /orgs/{orgId}/api/v1/admin/groups/{groupId} | Update an existing group |
| AdminIdentityProvidersApi | adminSocialProvidersAvailable | GET /orgs/{orgId}/api/v1/admin/social-providers/available | List the available social login provider types |
| AdminIdentityProvidersApi | adminSocialProvidersCallbackUrls | GET /orgs/{orgId}/api/v1/admin/social-providers/callback-urls | Get the OAuth callback URL of every configured provider |
| AdminIdentityProvidersApi | adminSocialProvidersCreate | POST /orgs/{orgId}/api/v1/admin/social-providers | Create a social login provider |
| AdminIdentityProvidersApi | adminSocialProvidersDelete | DELETE /orgs/{orgId}/api/v1/admin/social-providers/{providerId} | Delete a social login provider |
| AdminIdentityProvidersApi | adminSocialProvidersDisable | POST /orgs/{orgId}/api/v1/admin/social-providers/{providerId}/disable | Disable a social login provider |
| AdminIdentityProvidersApi | adminSocialProvidersEnable | POST /orgs/{orgId}/api/v1/admin/social-providers/{providerId}/enable | Enable a social login provider |
| AdminIdentityProvidersApi | adminSocialProvidersGet | GET /orgs/{orgId}/api/v1/admin/social-providers/{providerId} | Get a social login provider |
| AdminIdentityProvidersApi | adminSocialProvidersList | GET /orgs/{orgId}/api/v1/admin/social-providers | List social login providers |
| AdminIdentityProvidersApi | adminSocialProvidersTypes | GET /orgs/{orgId}/api/v1/admin/social-providers/types | List the available social login provider types |
| AdminIdentityProvidersApi | patchAdminSocialProvidersUpdate | PATCH /orgs/{orgId}/api/v1/admin/social-providers/{providerId} | Update a social login provider |
| AdminIdentityProvidersApi | putAdminSocialProvidersUpdate | PUT /orgs/{orgId}/api/v1/admin/social-providers/{providerId} | Create or replace a social login provider |
| AdminMcpApi | adminMcpServersCreate | POST /orgs/{orgId}/api/v1/admin/mcp/servers | Register an MCP server |
| AdminMcpApi | adminMcpServersDelete | DELETE /orgs/{orgId}/api/v1/admin/mcp/servers/{serverId} | Delete an MCP server |
| AdminMcpApi | adminMcpServersGet | GET /orgs/{orgId}/api/v1/admin/mcp/servers/{serverId} | Get an MCP server |
| AdminMcpApi | adminMcpServersList | GET /orgs/{orgId}/api/v1/admin/mcp/servers | List MCP servers |
| AdminMfaApi | deleteUserAuthenticator | DELETE /orgs/{orgId}/api/v1/admin/users/{userId}/authenticators/{authenticatorId} | Remove one of a user's authenticators |
| AdminMfaApi | getMfaCoverageReport | GET /orgs/{orgId}/api/v1/admin/reports/mfa-coverage | MFA enrollment coverage |
| AdminMfaApi | getMfaPolicy | GET /orgs/{orgId}/api/v1/admin/policies/mfa | Get the MFA policy |
| AdminMfaApi | issueTemporaryAccessCode | POST /orgs/{orgId}/api/v1/admin/users/{userId}/temporary-access-code | Issue a temporary access code |
| AdminMfaApi | listUserAuthenticators | GET /orgs/{orgId}/api/v1/admin/users/{userId}/authenticators | List a user's authenticators |
| AdminMfaApi | updateMfaPolicy | PUT /orgs/{orgId}/api/v1/admin/policies/mfa | Update the MFA policy |
| AdminOAuthClientsApi | adminClientsCimdCheck | POST /orgs/{orgId}/api/v1/admin/clients/cimd/check | Check a Client ID Metadata Document |
| AdminOAuthClientsApi | createClient | POST /orgs/{orgId}/api/v1/admin/clients | Create an OAuth client |
| AdminOAuthClientsApi | deleteClient | DELETE /orgs/{orgId}/api/v1/admin/clients/{clientId} | Delete an OAuth client |
| AdminOAuthClientsApi | disableClient | POST /orgs/{orgId}/api/v1/admin/clients/{clientId}/disable | Disable an OAuth client |
| AdminOAuthClientsApi | enableClient | POST /orgs/{orgId}/api/v1/admin/clients/{clientId}/enable | Enable an OAuth client |
| AdminOAuthClientsApi | getClient | GET /orgs/{orgId}/api/v1/admin/clients/{clientId} | Get an OAuth client |
| AdminOAuthClientsApi | listClientScopes | GET /orgs/{orgId}/api/v1/admin/clients/{clientId}/scopes | List the scopes granted to an OAuth client |
| AdminOAuthClientsApi | listClients | GET /orgs/{orgId}/api/v1/admin/clients | List OAuth clients |
| AdminOAuthClientsApi | patchClient | PATCH /orgs/{orgId}/api/v1/admin/clients/{clientId} | Update an OAuth client |
| AdminOAuthClientsApi | rotateClientSecret | POST /orgs/{orgId}/api/v1/admin/clients/{clientId}/rotate-secret | Rotate an OAuth client secret |
| AdminOAuthClientsApi | setClientScopes | PUT /orgs/{orgId}/api/v1/admin/clients/{clientId}/scopes | Replace the scopes granted to an OAuth client |
| AdminOAuthClientsApi | updateClient | PUT /orgs/{orgId}/api/v1/admin/clients/{clientId} | Replace an OAuth client |
| AdminOrganizationsApi | adminOrgInvitationsCreate | POST /orgs/{orgId}/api/v1/admin/organizations/{organizationId}/invitations | Invite a user to an organization |
| AdminOrganizationsApi | adminOrgInvitationsList | GET /orgs/{orgId}/api/v1/admin/organizations/{organizationId}/invitations | List organization invitations |
| AdminOrganizationsApi | adminOrgInvitationsResend | POST /orgs/{orgId}/api/v1/admin/organizations/{organizationId}/invitations/{invId}/resend | Resend an invitation |
| AdminOrganizationsApi | adminOrgInvitationsRevoke | DELETE /orgs/{orgId}/api/v1/admin/organizations/{organizationId}/invitations/{invId} | Revoke an invitation |
| AdminOrganizationsApi | adminOrgMembersAdd | POST /orgs/{orgId}/api/v1/admin/organizations/{organizationId}/members | Add a member to an organization |
| AdminOrganizationsApi | adminOrgMembersList | GET /orgs/{orgId}/api/v1/admin/organizations/{organizationId}/members | List organization members |
| AdminOrganizationsApi | adminOrgMembersRemove | DELETE /orgs/{orgId}/api/v1/admin/organizations/{organizationId}/members/{userId} | Remove a member from an organization |
| AdminOrganizationsApi | adminOrgRolesCreate | POST /orgs/{orgId}/api/v1/admin/organizations/{organizationId}/roles | Create an organization role |
| AdminOrganizationsApi | adminOrgRolesDelete | DELETE /orgs/{orgId}/api/v1/admin/organizations/{organizationId}/roles/{roleId} | Delete an organization role |
| AdminOrganizationsApi | adminOrgRolesList | GET /orgs/{orgId}/api/v1/admin/organizations/{organizationId}/roles | List organization roles |
| AdminOrganizationsApi | adminOrganizationsCreate | POST /orgs/{orgId}/api/v1/admin/organizations | Create an organization |
| AdminOrganizationsApi | adminOrganizationsDelete | DELETE /orgs/{orgId}/api/v1/admin/organizations/{organizationId} | Delete an organization |
| AdminOrganizationsApi | adminOrganizationsGet | GET /orgs/{orgId}/api/v1/admin/organizations/{organizationId} | Get an organization |
| AdminOrganizationsApi | adminOrganizationsList | GET /orgs/{orgId}/api/v1/admin/organizations | List organizations |
| AdminOrganizationsApi | patchAdminOrgMembersUpdate | PATCH /orgs/{orgId}/api/v1/admin/organizations/{organizationId}/members/{userId} | Update a member's role or status |
| AdminOrganizationsApi | patchAdminOrgRolesUpdate | PATCH /orgs/{orgId}/api/v1/admin/organizations/{organizationId}/roles/{roleId} | Update an organization role |
| AdminOrganizationsApi | patchAdminOrganizationsUpdate | PATCH /orgs/{orgId}/api/v1/admin/organizations/{organizationId} | Update an organization |
| AdminOrganizationsApi | putAdminOrgMembersUpdate | PUT /orgs/{orgId}/api/v1/admin/organizations/{organizationId}/members/{userId} | Update a member's role or status |
| AdminOrganizationsApi | putAdminOrgRolesUpdate | PUT /orgs/{orgId}/api/v1/admin/organizations/{organizationId}/roles/{roleId} | Update an organization role |
| AdminOrganizationsApi | putAdminOrganizationsUpdate | PUT /orgs/{orgId}/api/v1/admin/organizations/{organizationId} | Update an organization |
| AdminPermissionsApi | adminPermissionsCreate | POST /orgs/{orgId}/api/v1/admin/permissions | Create a custom permission for the tenant |
| AdminPermissionsApi | adminPermissionsDelete | DELETE /orgs/{orgId}/api/v1/admin/permissions/{permissionId} | Delete a custom permission |
| AdminPermissionsApi | adminPermissionsGet | GET /orgs/{orgId}/api/v1/admin/permissions/{permissionId} | Get a single permission |
| AdminPermissionsApi | adminPermissionsList | GET /orgs/{orgId}/api/v1/admin/permissions | List all available permissions for the tenant |
| AdminPermissionsApi | adminPermissionsUpdate | PATCH /orgs/{orgId}/api/v1/admin/permissions/{permissionId} | Update a permission |
| AdminPermissionsApi | adminPermissionsUsage | GET /orgs/{orgId}/api/v1/admin/permissions/{permissionId}/usage | Get permission usage (roles assigned to this permission) |
| AdminPermissionsApi | adminScopesCreate | POST /orgs/{orgId}/api/v1/admin/scopes | Create a custom OAuth scope |
| AdminPermissionsApi | adminScopesDelete | DELETE /orgs/{orgId}/api/v1/admin/scopes/{scopeId} | Delete a custom OAuth scope |
| AdminPermissionsApi | adminScopesList | GET /orgs/{orgId}/api/v1/admin/scopes | List OAuth scopes |
| AdminRolesApi | adminRolesAddPermissions | POST /orgs/{orgId}/api/v1/admin/roles/{roleId}/permissions | Add permission(s) to a role |
| AdminRolesApi | adminRolesAddUser | POST /orgs/{orgId}/api/v1/admin/roles/{roleId}/users | Assign a user to a role |
| AdminRolesApi | adminRolesCreate | POST /orgs/{orgId}/api/v1/admin/roles | Create a new role |
| AdminRolesApi | adminRolesDelete | DELETE /orgs/{orgId}/api/v1/admin/roles/{roleId} | Delete a role |
| AdminRolesApi | adminRolesGet | GET /orgs/{orgId}/api/v1/admin/roles/{roleId} | Get a single role by ID or slug |
| AdminRolesApi | adminRolesGetPermissions | GET /orgs/{orgId}/api/v1/admin/roles/{roleId}/permissions | Get role permissions |
| AdminRolesApi | adminRolesGetUsers | GET /orgs/{orgId}/api/v1/admin/roles/{roleId}/users | Get users assigned to a role |
| AdminRolesApi | adminRolesList | GET /orgs/{orgId}/api/v1/admin/roles | List all roles in the tenant |
| AdminRolesApi | adminRolesRemovePermission | DELETE /orgs/{orgId}/api/v1/admin/roles/{roleId}/permissions/{permissionId} | Remove a permission from a role |
| AdminRolesApi | adminRolesRemoveUser | DELETE /orgs/{orgId}/api/v1/admin/roles/{roleId}/users/{userId} | Remove a user from a role |
| AdminRolesApi | adminRolesUpdatePermissions | PUT /orgs/{orgId}/api/v1/admin/roles/{roleId}/permissions | Update role permissions (replaces all) |
| AdminRolesApi | patchAdminRolesUpdate | PATCH /orgs/{orgId}/api/v1/admin/roles/{roleId} | Update an existing role |
| AdminRolesApi | putAdminRolesUpdate | PUT /orgs/{orgId}/api/v1/admin/roles/{roleId} | Update an existing role |
| AdminSandboxApi | adminSandboxDestroy | POST /orgs/{orgId}/api/v1/admin/sandbox/{sandboxSlug}/destroy | Destroy a sandbox tenant |
| AdminSandboxApi | adminSandboxList | GET /orgs/{orgId}/api/v1/admin/sandbox | List the caller's sandbox tenants |
| AdminSandboxApi | adminSandboxSpawn | POST /orgs/{orgId}/api/v1/admin/sandbox/spawn | Spawn a sandbox tenant |
| AdminSessionsApi | adminClientTokensRevokeAll | DELETE /orgs/{orgId}/api/v1/admin/clients/{clientId}/tokens | Revoke all tokens of a client |
| AdminSessionsApi | adminClientTokensRevokePost | POST /orgs/{orgId}/api/v1/admin/clients/{clientId}/tokens/revoke | Revoke all tokens of a client (POST alias) |
| AdminSessionsApi | adminSessionsCount | GET /orgs/{orgId}/api/v1/admin/sessions/count | Active session count |
| AdminSessionsApi | adminSessionsList | GET /orgs/{orgId}/api/v1/admin/sessions | List active sessions |
| AdminSessionsApi | adminSessionsRevoke | DELETE /orgs/{orgId}/api/v1/admin/sessions/{sessionId} | Revoke a session |
| AdminSessionsApi | adminSessionsRevokeAll | POST /orgs/{orgId}/api/v1/admin/sessions/revoke-all | Revoke every session in the tenant |
| AdminSessionsApi | adminSessionsStats | GET /orgs/{orgId}/api/v1/admin/sessions/stats | Session statistics |
| AdminSessionsApi | adminTokensList | GET /orgs/{orgId}/api/v1/admin/tokens | List access tokens |
| AdminSessionsApi | adminTokensRevoke | DELETE /orgs/{orgId}/api/v1/admin/tokens/{tokenId} | Revoke a token |
| AdminSessionsApi | adminUserSessionsList | GET /orgs/{orgId}/api/v1/admin/users/{userId}/sessions | List a user's active sessions |
| AdminSessionsApi | adminUserSessionsRevokeAll | DELETE /orgs/{orgId}/api/v1/admin/users/{userId}/sessions | Revoke all sessions of a user |
| AdminSessionsApi | adminUserSessionsRevokePost | POST /orgs/{orgId}/api/v1/admin/users/{userId}/sessions/revoke | Revoke all sessions of a user (POST alias) |
| AdminSessionsApi | adminUserTokensRevokeAll | DELETE /orgs/{orgId}/api/v1/admin/users/{userId}/tokens | Revoke all tokens of a user |
| AdminSessionsApi | adminUserTokensRevokePost | POST /orgs/{orgId}/api/v1/admin/users/{userId}/tokens/revoke | Revoke all tokens of a user (POST alias) |
| AdminSettingsApi | adminAnalyticsDashboard | GET /orgs/{orgId}/api/v1/admin/analytics/dashboard | Get dashboard analytics |
| AdminSettingsApi | adminAnalyticsLogins | GET /orgs/{orgId}/api/v1/admin/analytics/logins | Get login analytics |
| AdminSettingsApi | adminAnalyticsUsers | GET /orgs/{orgId}/api/v1/admin/analytics/users | Get user growth analytics |
| AdminSettingsApi | adminOrganizationGet | GET /orgs/{orgId}/api/v1/admin/organization | Get organization (tenant) profile |
| AdminSettingsApi | adminSettingsAll | GET /orgs/{orgId}/api/v1/admin/settings | Get all settings (combined) |
| AdminSettingsApi | adminSettingsAuthGet | GET /orgs/{orgId}/api/v1/admin/settings/auth | Get authentication settings |
| AdminSettingsApi | adminSettingsAuthenticationGet | GET /orgs/{orgId}/api/v1/admin/settings/authentication | Get authentication settings (alias for settings/auth) |
| AdminSettingsApi | adminSettingsBrandingGet | GET /orgs/{orgId}/api/v1/admin/settings/branding | Get branding/login page settings |
| AdminSettingsApi | adminSettingsEmailGet | GET /orgs/{orgId}/api/v1/admin/settings/email | Get email settings |
| AdminSettingsApi | adminSettingsGeneralGet | GET /orgs/{orgId}/api/v1/admin/settings/general | Get general settings |
| AdminSettingsApi | adminSettingsScimGet | GET /orgs/{orgId}/api/v1/admin/settings/scim | Get SCIM settings |
| AdminSettingsApi | adminSettingsSecurityGet | GET /orgs/{orgId}/api/v1/admin/settings/security | Get security settings |
| AdminSettingsApi | adminTenantGet | GET /orgs/{orgId}/api/v1/admin/tenant | Get organization (tenant) profile |
| AdminSettingsApi | patchAdminOrganizationUpdate | PATCH /orgs/{orgId}/api/v1/admin/organization | Update organization (tenant) name and settings |
| AdminSettingsApi | patchAdminSettingsAuthUpdate | PATCH /orgs/{orgId}/api/v1/admin/settings/auth | Update authentication settings |
| AdminSettingsApi | patchAdminSettingsAuthenticationUpdate | PATCH /orgs/{orgId}/api/v1/admin/settings/authentication | Update authentication settings (alias for settings/auth) |
| AdminSettingsApi | patchAdminSettingsBrandingUpdate | PATCH /orgs/{orgId}/api/v1/admin/settings/branding | Update branding/login page settings |
| AdminSettingsApi | patchAdminSettingsEmailUpdate | PATCH /orgs/{orgId}/api/v1/admin/settings/email | Update email settings |
| AdminSettingsApi | patchAdminSettingsGeneralUpdate | PATCH /orgs/{orgId}/api/v1/admin/settings/general | Update general settings |
| AdminSettingsApi | patchAdminSettingsScimUpdate | PATCH /orgs/{orgId}/api/v1/admin/settings/scim | Update SCIM settings |
| AdminSettingsApi | patchAdminSettingsSecurityUpdate | PATCH /orgs/{orgId}/api/v1/admin/settings/security | Update security settings |
| AdminSettingsApi | patchAdminTenantUpdate | PATCH /orgs/{orgId}/api/v1/admin/tenant | Update organization (tenant) name and settings |
| AdminSettingsApi | putAdminOrganizationUpdate | PUT /orgs/{orgId}/api/v1/admin/organization | Update organization (tenant) name and settings |
| AdminSettingsApi | putAdminSettingsAuthUpdate | PUT /orgs/{orgId}/api/v1/admin/settings/auth | Update authentication settings |
| AdminSettingsApi | putAdminSettingsAuthenticationUpdate | PUT /orgs/{orgId}/api/v1/admin/settings/authentication | Update authentication settings (alias for settings/auth) |
| AdminSettingsApi | putAdminSettingsBrandingUpdate | PUT /orgs/{orgId}/api/v1/admin/settings/branding | Update branding/login page settings |
| AdminSettingsApi | putAdminSettingsEmailUpdate | PUT /orgs/{orgId}/api/v1/admin/settings/email | Update email settings |
| AdminSettingsApi | putAdminSettingsGeneralUpdate | PUT /orgs/{orgId}/api/v1/admin/settings/general | Update general settings |
| AdminSettingsApi | putAdminSettingsScimUpdate | PUT /orgs/{orgId}/api/v1/admin/settings/scim | Update SCIM settings |
| AdminSettingsApi | putAdminSettingsSecurityUpdate | PUT /orgs/{orgId}/api/v1/admin/settings/security | Update security settings |
| AdminSettingsApi | putAdminTenantUpdate | PUT /orgs/{orgId}/api/v1/admin/tenant | Update organization (tenant) name and settings |
| AdminUsersApi | addUserGroup | POST /orgs/{orgId}/api/v1/admin/users/{userId}/groups | Add a user to a group |
| AdminUsersApi | addUserPermission | POST /orgs/{orgId}/api/v1/admin/users/{userId}/permissions | Assign a permission to a user |
| AdminUsersApi | addUserRole | POST /orgs/{orgId}/api/v1/admin/users/{userId}/roles | Assign a role to a user |
| AdminUsersApi | adminIdentitiesLegacySamlRelink | POST /orgs/{orgId}/api/v1/admin/identities/legacy-saml | Relink legacy SAML users to an IdP |
| AdminUsersApi | adminIdentitiesLegacySamlReport | GET /orgs/{orgId}/api/v1/admin/identities/legacy-saml | Legacy SAML bindings report |
| AdminUsersApi | adminIdentitiesLink | POST /orgs/{orgId}/api/v1/admin/users/{userId}/identities | Link a SAML or LDAP identity to a user |
| AdminUsersApi | adminIdentitiesList | GET /orgs/{orgId}/api/v1/admin/users/{userId}/identities | List a user's federated identity links |
| AdminUsersApi | adminIdentitiesUnlink | DELETE /orgs/{orgId}/api/v1/admin/users/{userId}/identities/{type} | Unlink a user's SAML, LDAP or social identity |
| AdminUsersApi | blockUser | POST /orgs/{orgId}/api/v1/admin/users/{userId}/block | Block a user |
| AdminUsersApi | createUser | POST /orgs/{orgId}/api/v1/admin/users | Create a user |
| AdminUsersApi | deleteUser | DELETE /orgs/{orgId}/api/v1/admin/users/{userId} | Delete a user |
| AdminUsersApi | getUser | GET /orgs/{orgId}/api/v1/admin/users/{userId} | Get a user |
| AdminUsersApi | listUserGroups | GET /orgs/{orgId}/api/v1/admin/users/{userId}/groups | List a user's groups |
| AdminUsersApi | listUserPermissions | GET /orgs/{orgId}/api/v1/admin/users/{userId}/permissions | List a user's direct permissions |
| AdminUsersApi | listUserRoles | GET /orgs/{orgId}/api/v1/admin/users/{userId}/roles | List a user's roles |
| AdminUsersApi | listUsers | GET /orgs/{orgId}/api/v1/admin/users | List users |
| AdminUsersApi | markUserVerified | POST /orgs/{orgId}/api/v1/admin/users/{userId}/mark-verified | Mark a user's email as verified |
| AdminUsersApi | patchUser | PATCH /orgs/{orgId}/api/v1/admin/users/{userId} | Update a user |
| AdminUsersApi | removeUserGroup | DELETE /orgs/{orgId}/api/v1/admin/users/{userId}/groups/{groupId} | Remove a user from a group |
| AdminUsersApi | removeUserPermission | DELETE /orgs/{orgId}/api/v1/admin/users/{userId}/permissions/{permissionId} | Remove a permission from a user |
| AdminUsersApi | removeUserRole | DELETE /orgs/{orgId}/api/v1/admin/users/{userId}/roles/{roleId} | Remove a role from a user |
| AdminUsersApi | resetUserMfa | POST /orgs/{orgId}/api/v1/admin/users/{userId}/mfa/reset | Reset MFA (removed) |
| AdminUsersApi | sendUserVerificationEmail | POST /orgs/{orgId}/api/v1/admin/users/{userId}/verify-email | Send a verification email |
| AdminUsersApi | setUserPassword | PUT /orgs/{orgId}/api/v1/admin/users/{userId}/password | Set a user's password |
| AdminUsersApi | setUserPasswordPost | POST /orgs/{orgId}/api/v1/admin/users/{userId}/password | Set a user's password |
| AdminUsersApi | triggerUserPasswordReset | POST /orgs/{orgId}/api/v1/admin/users/{userId}/password-reset | Send a password reset email |
| AdminUsersApi | unblockUser | POST /orgs/{orgId}/api/v1/admin/users/{userId}/unblock | Unblock a user |
| AdminUsersApi | updateUser | PUT /orgs/{orgId}/api/v1/admin/users/{userId} | Update a user |
| AdminUsersApi | updateUserGroups | PUT /orgs/{orgId}/api/v1/admin/users/{userId}/groups | Replace a user's groups |
| AdminUsersApi | updateUserRoles | PUT /orgs/{orgId}/api/v1/admin/users/{userId}/roles | Replace a user's roles |
| AdminWebhooksApi | adminWebhooksCreate | POST /orgs/{orgId}/api/v1/admin/webhooks | Create a webhook |
| AdminWebhooksApi | adminWebhooksDelete | DELETE /orgs/{orgId}/api/v1/admin/webhooks/{webhookId} | Delete a webhook |
| AdminWebhooksApi | adminWebhooksDeliveriesList | GET /orgs/{orgId}/api/v1/admin/webhooks/{webhookId}/deliveries | List recent deliveries |
| AdminWebhooksApi | adminWebhooksDeliveryReplay | POST /orgs/{orgId}/api/v1/admin/webhooks/{webhookId}/deliveries/{deliveryId}/replay | Replay a delivery |
| AdminWebhooksApi | adminWebhooksDeliveryShow | GET /orgs/{orgId}/api/v1/admin/webhooks/{webhookId}/deliveries/{deliveryId} | Get a delivery |
| AdminWebhooksApi | adminWebhooksEvents | GET /orgs/{orgId}/api/v1/admin/webhooks/events | List available webhook event types |
| AdminWebhooksApi | adminWebhooksGet | GET /orgs/{orgId}/api/v1/admin/webhooks/{webhookId} | Get a webhook |
| AdminWebhooksApi | adminWebhooksList | GET /orgs/{orgId}/api/v1/admin/webhooks | List webhooks |
| AdminWebhooksApi | adminWebhooksRotateSecret | POST /orgs/{orgId}/api/v1/admin/webhooks/{webhookId}/rotate-secret | Rotate the signing secret |
| AdminWebhooksApi | adminWebhooksTest | POST /orgs/{orgId}/api/v1/admin/webhooks/{webhookId}/test | Send a test delivery |
| AdminWebhooksApi | adminWebhooksTunnelStart | POST /orgs/{orgId}/api/v1/admin/webhooks/tunnel/start | Start a webhook tunnel |
| AdminWebhooksApi | adminWebhooksTunnelStop | POST /orgs/{orgId}/api/v1/admin/webhooks/tunnel/{webhookId}/stop | Stop a webhook tunnel |
| AdminWebhooksApi | adminWebhooksTunnelStream | GET /orgs/{orgId}/api/v1/admin/webhooks/tunnel/{webhookId}/stream | Stream tunnel deliveries (SSE) |
| AdminWebhooksApi | adminWebhooksWebhooksDisable | POST /orgs/{orgId}/api/v1/admin/webhooks/{webhookId}/disable | Disable a webhook |
| AdminWebhooksApi | adminWebhooksWebhooksEnable | POST /orgs/{orgId}/api/v1/admin/webhooks/{webhookId}/enable | Enable a webhook |
| AdminWebhooksApi | patchAdminWebhooksUpdate | PATCH /orgs/{orgId}/api/v1/admin/webhooks/{webhookId} | Partially update a webhook |
| AdminWebhooksApi | putAdminWebhooksUpdate | PUT /orgs/{orgId}/api/v1/admin/webhooks/{webhookId} | Update a webhook |
| AgentsApi | ask | POST /orgs/{orgId}/api/v1/agents/ask | Agent-friendly permission check (Natural Language style) |
| AgentsApi | attest | POST /orgs/{orgId}/api/v1/agents/{agentId}/attest | Workload attestation: exchange a cloud OIDC token for an agent access token |
| AgentsApi | authorizeMcp | POST /orgs/{orgId}/api/v1/agents/me/mcp/authorize | Per-MCP-tool authorization for the authenticated agent (dx B3). |
| AgentsApi | createApproval | POST /orgs/{orgId}/api/v1/agents/me/approvals | |
| AgentsApi | getAgentCard | GET /orgs/{orgId}/api/v1/agents/{agentId}/agent-card | Signed A2A agent card |
| AgentsApi | getApprovalStatus | GET /orgs/{orgId}/api/v1/agents/me/approvals/{token}/status | |
| AgentsApi | getCurrentAgent | GET /orgs/{orgId}/api/v1/agents/me | Get details about the currently authenticated agent |
| AgentsApi | registerAgent | POST /orgs/{orgId}/api/v1/agents/register | Register (or re-register) an agent |
| AgentsApi | verifyAgentCard | POST /orgs/{orgId}/api/v1/agents/agent-card/verify | Verify a signed A2A agent card |
| AuthorizationApi | checkAbac | POST /orgs/{orgId}/api/v1/abac/check | Evaluate an ABAC policy decision for the caller |
| AuthorizationApi | checkAbacBulk | POST /orgs/{orgId}/api/v1/abac/check-bulk | Evaluate up to 100 ABAC checks for the caller in one call |
| AuthorizationApi | checkAllPermissions | POST /api/v1/authz/check-all | Check whether the subject holds all of the permissions |
| AuthorizationApi | checkAnyPermission | POST /api/v1/authz/check-any | Check whether the subject holds any of the permissions |
| AuthorizationApi | checkPermission | POST /api/v1/authz/check | Check one permission |
| AuthorizationApi | checkPermissionsBulk | POST /api/v1/authz/check-bulk | Check up to 100 permissions in one call |
| AuthorizationApi | checkRelation | POST /api/v1/authz/zanzibar/check | Zanzibar relationship check |
| AuthorizationApi | checkRelationScoped | POST /orgs/{orgId}/api/v1/zanzibar/check | Zanzibar relationship check |
| AuthorizationApi | evaluate | POST /api/v1/authz/v1/evaluation | AuthZEN 1.0 access evaluation |
| AuthorizationApi | evaluateBatch | POST /api/v1/authz/v1/evaluations | AuthZEN 1.0 boxcarred access evaluations |
| AuthorizationApi | expandRelation | POST /api/v1/authz/zanzibar/expand | Zanzibar-style userset expansion: every subject that satisfies `object#relation`, as a tree that mirrors the namespace rewrites. |
| AuthorizationApi | expandRelationScoped | POST /orgs/{orgId}/api/v1/zanzibar/expand | Zanzibar Expand: the userset tree of every subject satisfying `object#relation`. Always reveals other subjects, so it requires the oracle privilege (`authz.check` permission or `authz:check` scope). |
| AuthorizationApi | getMyAttributes | GET /orgs/{orgId}/api/v1/abac/my-attributes | The caller's ABAC subject attributes |
| AuthorizationApi | getResourceAttributes | GET /orgs/{orgId}/api/v1/abac/resources/{resourceType}/{resourceId}/attributes | Attributes stored for a resource |
| AuthorizationApi | listAttributeDefinitions | GET /orgs/{orgId}/api/v1/abac/attribute-definitions | Attribute definitions available to the organization |
| AuthorizationApi | listPermissions | GET /api/v1/authz/permissions | List the caller's effective permissions |
| AuthorizationApi | setResourceAttribute | PUT /orgs/{orgId}/api/v1/abac/resources/{resourceType}/{resourceId}/attributes/{attributeSlug} | Set a resource attribute |
| AuthorizationApi | setUserAttribute | PUT /orgs/{orgId}/api/v1/abac/users/{userId}/attributes/{attributeSlug} | Set a user attribute |
| IdentityApi | getMe | GET /orgs/{orgId}/api/v1/me | Who am I |
| JitApi | approveRequest | POST /orgs/{orgId}/api/v1/jit/approve/{requestId} | HITL: Approve a pending JIT request (requires user auth). |
| JitApi | completeTask | POST /orgs/{orgId}/api/v1/jit/task/{taskId}/complete | Complete a task and cleanup resources. |
| JitApi | createTask | POST /orgs/{orgId}/api/v1/jit/task | Create a new ephemeral task/persona for an agent. |
| JitApi | denyRequest | POST /orgs/{orgId}/api/v1/jit/deny/{requestId} | HITL: Deny a pending JIT request (requires user auth). |
| JitApi | evaluateTask | POST /orgs/{orgId}/api/v1/jit/task/{taskId}/evaluate | CAEP: Trigger continuous access evaluation for a task. |
| JitApi | getRequestStatus | GET /orgs/{orgId}/api/v1/jit/request/{requestId}/status | Get the status of a JIT permission request. |
| JitApi | getRequestToken | POST /orgs/{orgId}/api/v1/jit/request/{requestId}/token | Exchange an approved JIT request for a downscoped token. |
| JitApi | listPendingRequests | GET /orgs/{orgId}/api/v1/jit/pending | Get pending HITL requests for the tenant. |
| JitApi | requestPermission | POST /orgs/{orgId}/api/v1/jit/request | Request a JIT permission using RFC 9396 authorization_details. |
| McpApi | getProtectedResourceMetadata | GET /orgs/{orgId}/api/v1/.well-known/oauth-protected-resource/mcp/{serverId} | MCP server protected resource metadata (RFC 9728) |
| McpApi | getProtectedResourceMetadataRoot | GET /orgs/{orgId}/api/v1/.well-known/oauth-protected-resource | Organization-level protected resource metadata (RFC 9728) |
| McpApi | getServer | GET /orgs/{orgId}/api/v1/mcp/servers/{serverId} | REST API: Get a specific MCP server. |
| McpApi | getServerChallenge | GET /orgs/{orgId}/api/v1/mcp/{serverId}/challenge | Simulated MCP server authorization challenge |
| McpApi | listServers | GET /orgs/{orgId}/api/v1/mcp/servers | REST API: List MCP servers for a tenant. |
| McpApi | mcpServerToolAuthorize | POST /orgs/{orgId}/api/v1/mcp/servers/{serverId}/tools/authorize | Per-tool authorization for an MCP server (server credential) |
| McpApi | postServerChallenge | POST /orgs/{orgId}/api/v1/mcp/{serverId}/challenge | Simulated MCP server authorization challenge (POST) |
| MfaApi | createMfaChallenge | POST /orgs/{orgId}/api/v1/mfa/challenges | Start an MFA challenge |
| MfaApi | deleteAuthenticator | DELETE /orgs/{orgId}/api/v1/me/authenticators/{id} | Remove an authenticator |
| MfaApi | enrollAuthenticator | POST /orgs/{orgId}/api/v1/me/authenticators/{type}/enroll | Start enrolling an authenticator |
| MfaApi | generateRecoveryCodes | POST /orgs/{orgId}/api/v1/me/recovery-codes | Generate recovery codes |
| MfaApi | getMfaChallenge | GET /orgs/{orgId}/api/v1/mfa/challenges/{id} | Get challenge status |
| MfaApi | getRecoveryCodeStatus | GET /orgs/{orgId}/api/v1/me/recovery-codes | Recovery-code status |
| MfaApi | listMyAuthenticators | GET /orgs/{orgId}/api/v1/me/authenticators | List my authenticators |
| MfaApi | listTrustedDevices | GET /orgs/{orgId}/api/v1/me/trusted-devices | List trusted devices |
| MfaApi | revokeTrustedDevice | DELETE /orgs/{orgId}/api/v1/me/trusted-devices/{id} | Revoke a trusted device |
| MfaApi | updateAuthenticator | PATCH /orgs/{orgId}/api/v1/me/authenticators/{id} | Rename an authenticator or make it the default |
| MfaApi | verifyAuthenticator | POST /orgs/{orgId}/api/v1/me/authenticators/{id}/verify | Verify a pending authenticator |
| MfaApi | verifyMfaChallenge | POST /orgs/{orgId}/api/v1/mfa/challenges/{id}/verify | Answer a challenge |
| OAuthApi | authorize | GET /orgs/{orgId}/api/v1/oauth/authorize | OAuth 2.1 / OIDC authorization endpoint |
| OAuthApi | backchannelAuthorize | POST /orgs/{orgId}/api/v1/oauth/bc-authorize | CIBA backchannel authentication request |
| OAuthApi | deviceAuthorization | POST /orgs/{orgId}/api/v1/oauth/device_authorization | Device authorization request (RFC 8628) |
| OAuthApi | getClientConfiguration | GET /orgs/{orgId}/api/v1/connect/register/{clientId} | Read a dynamically registered client (RFC 7592 / OIDC DCR §4) |
| OAuthApi | getDeviceVerification | GET /orgs/{orgId}/api/v1/oauth/device | Device verification page (RFC 8628 §3.3) |
| OAuthApi | getOrgSelection | GET /orgs/{orgId}/api/v1/oauth/org-select | Organization selector page |
| OAuthApi | introspect | POST /orgs/{orgId}/api/v1/oauth/introspect | Token introspection (RFC 7662) |
| OAuthApi | par | POST /orgs/{orgId}/api/v1/oauth/par | Pushed authorization request (RFC 9126) |
| OAuthApi | passkeyLogin | GET /orgs/{orgId}/api/v1/oauth/passkey-login | Passkey login entry point |
| OAuthApi | registerClient | POST /orgs/{orgId}/api/v1/connect/register | Dynamic client registration (RFC 7591 / OIDC DCR) |
| OAuthApi | revoke | POST /orgs/{orgId}/api/v1/oauth/revoke | Token revocation (RFC 7009) |
| OAuthApi | socialCallback | GET /orgs/{orgId}/api/v1/oauth/social/{provider}/callback | Social / enterprise identity-provider callback |
| OAuthApi | socialCallbackPost | POST /orgs/{orgId}/api/v1/oauth/social/{provider}/callback | Social / enterprise identity-provider callback (form_post) |
| OAuthApi | socialLogin | GET /orgs/{orgId}/api/v1/oauth/social/{provider} | Start social / enterprise identity-provider login |
| OAuthApi | submitAuthorization | POST /orgs/{orgId}/api/v1/oauth/authorize | OAuth 2.1 / OIDC authorization endpoint (form submission) |
| OAuthApi | submitDeviceVerification | POST /orgs/{orgId}/api/v1/oauth/device | Submit device verification |
| OAuthApi | submitLogin | POST /orgs/{orgId}/api/v1/oauth/login/submit | Hosted login form submission |
| OAuthApi | submitLoginJson | POST /orgs/{orgId}/api/v1/oauth/login/json | Programmatic (JSON) login for the authorization flow |
| OAuthApi | submitOrgSelection | POST /orgs/{orgId}/api/v1/oauth/org-select | Submit organization selection |
| OAuthApi | token | POST /orgs/{orgId}/api/v1/oauth/token | OAuth 2.1 token endpoint |
| OIDCApi | checkSession | GET /orgs/{orgId}/api/v1/oauth/check_session | OP session-check iframe (OIDC Session Management 1.0) |
| OIDCApi | logout | GET /orgs/{orgId}/api/v1/oauth/logout | RP-initiated logout (OIDC RP-Initiated Logout 1.0) |
| OIDCApi | logoutPost | POST /orgs/{orgId}/api/v1/oauth/logout | RP-initiated logout (confirmation submission) |
| OIDCApi | userinfo | GET /orgs/{orgId}/api/v1/oauth/userinfo | OpenID Connect UserInfo endpoint |
| OIDCApi | userinfoPost | POST /orgs/{orgId}/api/v1/oauth/userinfo | OpenID Connect UserInfo endpoint (POST) |
| SsfApi | createStreamConfig | POST /orgs/{orgId}/api/v1/ssf/stream | Create an SSF stream |
| SsfApi | deleteStreamConfig | DELETE /orgs/{orgId}/api/v1/ssf/stream | Delete an SSF stream |
| SsfApi | getStreamConfig | GET /orgs/{orgId}/api/v1/ssf/stream | Read SSF stream configuration(s) |
| SsfApi | verifyStream | POST /orgs/{orgId}/api/v1/ssf/verify | Request a stream verification event |
| TokenVaultApi | getConnectionToken | POST /orgs/{orgId}/api/v1/agents/me/connections/{connectionId}/token | Fetch a live third-party access token for a connection |
| TokenVaultApi | listConnections | GET /orgs/{orgId}/api/v1/agents/me/connections | List the outbound connections this agent may use |
| WellKnownApi | getAuthorizationServerMetadata | GET /orgs/{orgId}/api/v1/.well-known/oauth-authorization-server | OAuth 2.0 authorization server metadata (RFC 8414) |
| WellKnownApi | getJwks | GET /orgs/{orgId}/api/v1/.well-known/jwks.json | JSON Web Key Set (RFC 7517) |
| WellKnownApi | getOpenidConfiguration | GET /orgs/{orgId}/api/v1/.well-known/openid-configuration | OpenID Provider configuration (OIDC Discovery 1.0) |
| WellKnownApi | getSsfConfiguration | GET /orgs/{orgId}/api/v1/.well-known/ssf-configuration | SSF transmitter configuration metadata |
Models
- AbacAttributeDefinition
- AbacAttributesCreateResponse
- AbacAttributesGetResponse
- AbacAttributesListResponse
- AbacPoliciesCreateResponse
- AbacPoliciesGetResponse
- AbacPoliciesListResponse
- AbacPoliciesToggleResponse
- AbacPolicy
- AbacResourceAttribute
- AddUserGroupResponse
- AddUserPermissionResponse
- AddUserRoleResponse
- AdminAgentsActivateResponse
- AdminAgentsAgentsDisableResponse
- AdminAgentsAgentsEnableResponse
- AdminAgentsAgentsRotateKeyResponse
- AdminAgentsCreateRequest
- AdminAgentsCreateResponse
- AdminAgentsDeactivateResponse
- AdminAgentsDeleteResponse
- AdminAgentsGenerateTokenRequest
- AdminAgentsGenerateTokenResponse
- AdminAgentsGenerateTokenResponseData
- AdminAgentsGetResponse
- AdminAgentsGetScopesResponse
- AdminAgentsListResponse
- AdminAgentsRevokeKeyResponse
- AdminAgentsRotateCredentialsResponse
- AdminAgentsSetScopesRequest
- AdminAgentsSetScopesResponse
- AdminAnalyticsDashboardResponse
- AdminAnalyticsDashboardResponseData
- AdminAnalyticsDashboardResponseDataAudit
- AdminAnalyticsDashboardResponseDataAuthentication
- AdminAnalyticsDashboardResponseDataUsers
- AdminAnalyticsLoginsResponse
- AdminAnalyticsLoginsResponseData
- AdminAnalyticsLoginsResponseDataDailyItem
- AdminAnalyticsLoginsResponseDataPeriod
- AdminAnalyticsUsersResponse
- AdminAnalyticsUsersResponseData
- AdminAnalyticsUsersResponseDataByMfaStatusItem
- AdminAnalyticsUsersResponseDataByVerificationStatusItem
- AdminAnalyticsUsersResponseDataDailyRegistrationsItem
- AdminAuditLogsActionsResponse
- AdminAuditLogsExportResponse
- AdminAuditLogsExportResponseMeta
- AdminAuditLogsGetResponse
- AdminAuditLogsListResponse
- AdminAuditLogsRetentionResponse
- AdminAuditLogsRetentionResponseData
- AdminAuditLogsStatsResponse
- AdminAuditLogsStatsResponseData
- AdminAuditLogsStatsResponseDataPeriod
- AdminClientTokensRevokeAllResponse
- AdminClientsCimdCheckRequest
- AdminClientsCimdCheckResponse
- AdminEmailTemplatesListResponse
- AdminEmailTemplatesPreviewResponse
- AdminEmailTemplatesVariablesResponse
- AdminGroupsCreateResponse
- AdminGroupsGetMembersResponse
- AdminGroupsGetMembersResponseDataItem
- AdminGroupsGetResponse
- AdminGroupsGroupsGetRolesResponse
- AdminGroupsGroupsGetRolesResponseDataItem
- AdminGroupsListResponse
- AdminIdentitiesLegacySamlRelinkRequest
- AdminIdentitiesLegacySamlRelinkResponse
- AdminIdentitiesLegacySamlRelinkResponseData
- AdminIdentitiesLegacySamlReportResponse
- AdminIdentitiesLegacySamlReportResponseData
- AdminIdentitiesLegacySamlReportResponseDataUsersItem
- AdminIdentitiesLinkRequest
- AdminIdentitiesListResponse
- AdminIdentitiesListResponseData
- AdminIdentitiesListResponseDataBindingsItem
- AdminMcpServersCreateResponse
- AdminMcpServersGetResponse
- AdminMcpServersListResponse
- AdminMcpServersListResponseMeta
- AdminOrgInvitationsCreateResponse
- AdminOrgInvitationsListResponse
- AdminOrgMembersAddResponse
- AdminOrgMembersListResponse
- AdminOrgRolesCreateResponse
- AdminOrgRolesListResponse
- AdminOrganizationsCreateResponse
- AdminOrganizationsGetResponse
- AdminOrganizationsListResponse
- AdminPermissionsCreateResponse
- AdminPermissionsGetResponse
- AdminPermissionsListResponse
- AdminPermissionsUsageResponse
- AdminPermissionsUsageResponseData
- AdminRolesCreateResponse
- AdminRolesGetPermissionsResponse
- AdminRolesGetPermissionsResponseDataItem
- AdminRolesGetResponse
- AdminRolesGetUsersResponse
- AdminRolesListResponse
- AdminSandboxListResponse
- AdminSandboxSpawnRequest
- AdminSandboxSpawnResponse
- AdminScopesCreateResponse
- AdminScopesListResponse
- AdminScopesListResponseMeta
- AdminSessionsCountResponse
- AdminSessionsCountResponseData
- AdminSessionsListResponse
- AdminSessionsRevokeAllRequest
- AdminSessionsRevokeAllResponse
- AdminSessionsRevokeResponse
- AdminSessionsStatsResponse
- AdminSessionsStatsResponseData
- AdminSettingsAllResponse
- AdminSettingsAllResponseData
- AdminSettingsAllResponseDataGeneral
- AdminSettingsAllResponseDataSecurity
- AdminSettingsAuthenticationGetResponse
- AdminSettingsBrandingGetResponse
- AdminSettingsEmailGetResponse
- AdminSettingsGeneralGetResponse
- AdminSettingsGeneralGetResponseData
- AdminSettingsScimGetResponse
- AdminSettingsSecurityGetResponse
- AdminSocialProvidersAvailableResponse
- AdminSocialProvidersAvailableResponseDataItem
- AdminSocialProvidersCallbackUrlsResponse
- AdminSocialProvidersCreateResponse
- AdminSocialProvidersGetResponse
- AdminSocialProvidersListResponse
- AdminTenantGetResponse
- AdminTokensListResponse
- AdminTokensRevokeResponse
- AdminUserSessionsListResponse
- AdminUserSessionsRevokeAllResponse
- AdminUserSessionsRevokePostResponse
- AdminUserTokensRevokeAllResponse
- AdminUserTokensRevokePostResponse
- AdminWebhooksCreateResponse
- AdminWebhooksCreateResponseData
- AdminWebhooksDeliveriesListResponse
- AdminWebhooksDeliveriesListResponseMeta
- AdminWebhooksDeliveryReplayResponse
- AdminWebhooksDeliveryShowResponse
- AdminWebhooksDeliveryShowResponseData
- AdminWebhooksDeliveryShowResponseData1AttemptsItem
- AdminWebhooksEventsResponse
- AdminWebhooksGetResponse
- AdminWebhooksListResponse
- AdminWebhooksRotateSecretResponse
- AdminWebhooksRotateSecretResponseData
- AdminWebhooksTestResponse
- AdminWebhooksTunnelStartResponse
- AdminWebhooksTunnelStartResponseData
- AdminWebhooksWebhooksDisableResponse
- AdminWebhooksWebhooksEnableResponse
- AgentOutboundConnection
- ApproveRequestRequest
- ApproveRequestResponse
- AskRequest
- AskResponse
- AttestRequest
- AttestResponse
- AttestResponseIdentity
- AuditLogEntry
- AuthZenDecision
- AuthenticationSettings
- AuthenticationSettingsMfaPolicy
- AuthenticationSettingsPasskeys
- AuthenticationSettingsPasswordPolicy
- AuthenticationSettingsPasswordRotationPolicy
- AuthenticationSettingsProgressiveProfiling
- AuthorizationServerMetadata
- AuthorizeMcpRequest
- AuthorizeMcpResponse
- BackchannelAuthorizeResponse
- BlockUserResponse
- BrandingSettings
- CheckAbacBulkResponse
- CheckAbacBulkResponseResultsItem
- CheckAbacResponse
- CheckAbacResponseMatchedPoliciesItem
- CheckAnyPermissionResponse
- CheckPermissionResponse
- CheckPermissionsBulkResponse
- CheckRelationResponse
- CheckRelationScopedResponse
- CimdCheckResult
- CimdCheckResultEffective
- CimdCheckResultShadowClient
- CompleteTaskResponse
- CreateApprovalRequest
- CreateApprovalResponse
- CreateApprovalResponse202
- CreateClientResponse
- CreateClientResponseData
- CreateMfaChallengeRequest
- CreateTaskRequest
- CreateTaskResponse
- CreateUserResponse
- DeleteUserAuthenticatorResponse
- DeleteUserResponse
- DenyRequestRequest
- DenyRequestResponse
- DeviceAuthorizationResponse
- EmailEnrollmentStarted
- EmailTemplate
- EnrollAuthenticator201Response
- EnrollAuthenticatorRequest
- EvaluateBatchResponse
- EvaluateResponseContext
- EvaluateResponseContextReasonAdmin
- ExpandRelationRequest
- ExpandRelationResponse
- ExpandRelationResponseTree
- GenerateRecoveryCodesResponse
- GetAgentCardResponseCapabilities
- GetAgentCardResponseProvider
- GetAgentCardResponseSignaturesItem
- GetAgentCardResponseSkillsItem
- GetApprovalStatusResponse
- GetApprovalStatusResponseApprovedBy
- GetClientResponse
- GetConnectionTokenRequest
- GetConnectionTokenResponse
- GetCurrentAgentResponse
- GetCurrentAgentResponseIdentity
- GetCurrentAgentResponseWorkspace
- GetIssuerMetadataResponse
- GetJwksResponseKeysItem
- GetMeResponse
- GetMfaCoverageReportResponse
- GetMfaPolicyResponse
- GetMyAttributesResponse
- GetMyAttributesResponseAttributes
- GetProtectedResourceMetadataRoot200Response
- GetProtectedResourceMetadataRootResponse1ResourcesItem
- GetRecoveryCodeStatusResponse
- GetRequestStatusResponse
- GetRequestTokenResponse
- GetResourceAttributesResponse
- GetResourceAttributesResponseAttributes
- GetServerChallengeResponse
- GetServerResponse
- GetServerResponseDiscovery
- GetSsfConfigurationResponse
- GetSsfConfigurationResponseAuthorizationSchemesItem
- GetStreamConfig200Response
- GetUserResponse
- Group
- GroupRef
- IntrospectResponse
- IntrospectResponseAud
- IssueAgentTokenRequest
- IssueAgentTokenResponse
- IssueDelegateTokenRequest
- IssueDelegateTokenResponse
- IssuePlatformTokenRequest
- IssuePlatformTokenResponse
- IssueResourceTokenRequest
- IssueResourceTokenResponse
- IssueTemporaryAccessCodeRequest
- IssueTemporaryAccessCodeResponse
- IssueTemporaryAccessCodeResponseData
- JsonWebKeySet
- JwksResponse
- ListAttributeDefinitionsResponse
- ListClientScopesResponse
- ListClientsResponse
- ListConnectionsResponse
- ListConnectionsResponseAgent
- ListMyAuthenticatorsResponse
- ListMyAuthenticatorsResponseRecoveryCodes
- ListPendingRequestsResponse
- ListPermissionsResponse
- ListPermissionsResponseDataItem
- ListPermissionsResponsePermissionsItem
- ListServersResponse
- ListServersResponseDataItem
- ListTrustedDevicesResponse
- ListTrustedDevicesResponseDataItem
- ListUserAuthenticatorsResponse
- ListUsersResponse
- MarkUserVerifiedResponse
- McpServer
- McpServerPosture
- McpServerPostureChecksInner
- McpServerToolAuthorizeRequest
- McpServerToolAuthorizeRequestSubject
- McpServerToolAuthorizeResponse
- MessageResponse
- MfaAuthenticator
- MfaAuthenticatorLastUsedContext
- MfaChallenge
- MfaChallengeAlternativesInner
- MfaChallengeAuthenticator
- MfaCoverageReport
- MfaPolicy
- OAuthAccessToken
- OAuthClient
- OAuthClientSecretIssued
- OAuthScope
- OpenIdConfiguration
- Organization
- OrganizationInvitation
- OrganizationInvitationRole
- OrganizationMember
- OrganizationMemberRole
- OrganizationRole
- PaginationMeta
- ParResponse
- PasskeyEnrollmentStarted
- Permission
- ProtectedResourceList
- ProtectedResourceMetadata
- PushEnrollmentStarted
- PutAbacAttributesUpdateResponse
- PutAbacPoliciesUpdateResponse
- PutAdminAgentsUpdateRequest
- PutAdminAgentsUpdateResponse
- PutAdminOrgMembersUpdateResponse
- PutAdminSettingsAuthenticationUpdateResponse
- PutAdminSettingsBrandingUpdateResponse
- PutAdminSettingsEmailUpdateResponse
- PutAdminSettingsGeneralUpdateResponse
- PutAdminSettingsGeneralUpdateResponseData
- PutAdminSettingsScimUpdateResponse
- PutAdminSettingsSecurityUpdateResponse
- PutAdminTenantUpdateResponse
- PutAdminWebhooksUpdateResponse
- RedactedSecret
- RegisterAgentResponse
- RegisterClientResponse
- RegisteredClientMetadata
- RemoveUserGroupResponse
- RemoveUserPermissionResponse
- RemoveUserRoleResponse
- RequestPermissionRequest
- RequestPermissionResponse
- RevokeAgentTokenRequest
- RevokeAgentTokenResponse
- Role
- RolePermissionsInner
- RoleRef
- RotateClientSecretResponse
- RotateClientSecretResponseData
- SandboxTenant
- ScimSettings
- ScimSettingsInbound
- ScimSettingsInboundProtectedAttributes
- ScimSettingsOutbound
- SendUserVerificationEmailResponse
- SetClientScopesResponse
- SetResourceAttributeResponse
- SetUserAttributeResponse
- SetUserAttributeResponseData
- SetUserPasswordPostResponse
- SignedAgentCard
- SingleServerMetadata
- SmsEnrollmentStarted
- SocialLoginProvider
- SsfStream
- SsfStreamDelivery
- SsfStreamList
- SubmitLoginJsonResponse
- TenantProfile
- TokenResponse
- TotpEnrollmentStarted
- TriggerUserPasswordResetResponse
- UnblockUserResponse
- UpdateAuthenticatorRequest
- UpdateClientResponse
- UpdateMfaPolicyResponse
- UpdateUserGroupsResponse
- UpdateUserResponse
- UpdateUserRolesResponse
- User
- UserRef
- UserSession
- UserinfoResponse
- VerifyAgentCardResponse
- VerifyAgentCardResponseCardSummary
- VerifyAgentCardResponseSigner
- VerifyAuthTokenRequest
- VerifyAuthTokenResponse
- VerifyMfaChallengeRequest
- VerifyResourceTokenRequest
- VerifyResourceTokenResponse
- Webhook
- WebhookDelivery
- WebhookDeliveryDetail
- WebhookSecretIssued
Authorization
Authentication schemes defined for the API:
BearerAuth
- Type: Bearer authentication (JWT)
ApiKeyAuth
- Type: API key
- API key parameter name: X-API-Key
- Location: HTTP header
ClientAuth
- Type: HTTP basic authentication
AAuthSigned
- Type: Bearer authentication (JWT)
Tests
To run the tests, use:
composer install vendor/bin/phpunit
Author
About this package
This PHP package is automatically generated by the OpenAPI Generator project:
- API version:
1.0.0- Package version:
1.2.0 - Generator version:
7.14.0
- Package version:
- Build package:
org.openapitools.codegen.languages.PhpClientCodegen