@autional/api-oauth
v0.6.0
Published
Autional Oauth API — auto-generated TypeScript client from oauth-service
Downloads
536
Readme
@autional/api-oauth
Autional Oauth API — auto-generated TypeScript client from oauth-service (50 functions).
Auto-generated by
python sdk/scripts/generate-api-packages.py. Do not edit by hand.
Functions
| Function | Method | Path | Description |
|----------|--------|------|-------------|
| getAdminOauthClients(client, params?) | GET | /admin/oauth/clients | 列出 OAuth 客户端 |
| postAdminOauthClients(client, data: CreateClientRequest) | POST | /admin/oauth/clients | 创建 OAuth 客户端 |
| getAdminOauthClientsByApplicationByByApplication(client, appId: string) | GET | /admin/oauth/clients/by-application/{app_id} | 按 Application 查询 OAuth 客户端 |
| getAdminOauthClientsPortalStats(client) | GET | /admin/oauth/clients/portal-stats | Portal 访问统计 |
| deleteAdminOauthClientsByClients(client, clientId: string) | DELETE | /admin/oauth/clients/{client_id} | 删除 OAuth 客户端 |
| getAdminOauthClientsByClients(client, clientId: string) | GET | /admin/oauth/clients/{client_id} | 获取 OAuth 客户端详情 |
| putAdminOauthClientsByClients(client, clientId: string, data: UpdateClientRequest) | PUT | /admin/oauth/clients/{client_id} | 更新 OAuth 客户端配置 |
| getAdminOauthClientsAuditLogsByClients(client, clientId: string, params?) | GET | /admin/oauth/clients/{client_id}/audit-logs | 获取 OAuth 客户端审计日志 |
| postAdminOauthClientsCloneByClients(client, clientId: string) | POST | /admin/oauth/clients/{client_id}/clone | 克隆 OAuth 客户端 |
| postAdminOauthClientsRotateSecretByClients(client, clientId: string) | POST | /admin/oauth/clients/{client_id}/rotate-secret | 轮换 OAuth 客户端密钥 |
| getAdminOauthClientsSecretsByClients(client, clientId: string) | GET | /admin/oauth/clients/{client_id}/secrets | 列出 OAuth 客户端所有密钥 |
| postAdminOauthClientsSecretsByClients(client, clientId: string) | POST | /admin/oauth/clients/{client_id}/secrets | 创建 OAuth 客户端密钥 |
| deleteAdminOauthClientsSecretsByClientsBySecrets(client, clientId: string, secretId: string) | DELETE | /admin/oauth/clients/{client_id}/secrets/{secret_id} | 删除 OAuth 客户端密钥 |
| putAdminOauthClientsSecretsDeactivateByClientsBySecrets(client, clientId: string, secretId: string) | PUT | /admin/oauth/clients/{client_id}/secrets/{secret_id}/deactivate | 停用 OAuth 客户端密钥 |
| getAdminOauthClientsStatsByClients(client, clientId: string) | GET | /admin/oauth/clients/{client_id}/stats | 获取 OAuth 客户端统计数据 |
| deleteAdminOauthClientsTokensByClients(client, clientId: string, params?) | DELETE | /admin/oauth/clients/{client_id}/tokens | 撤销 OAuth 客户端所有令牌 |
| getAdminOauthClientsTokensByClients(client, clientId: string, params?) | GET | /admin/oauth/clients/{client_id}/tokens | 列出 OAuth 客户端活跃令牌 |
| getAdminOauthDevices(client, params?) | GET | /admin/oauth/devices | 列出设备授权会话 |
| deleteAdminOauthDevicesByDevices(client, deviceCode: string) | DELETE | /admin/oauth/devices/{device_code} | 撤销设备授权 |
| getAdminOauthProviders(client) | GET | /admin/oauth/providers | 列出OAuth提供商 |
| postAdminOauthProviders(client, data: AdminCreateProviderRequest) | POST | /admin/oauth/providers | 创建OAuth提供商 |
| deleteAdminOauthProvidersByProviders(client, name: string) | DELETE | /admin/oauth/providers/{name} | 删除OAuth提供商 |
| putAdminOauthProvidersByProviders(client, name: string, data: AdminUpdateProviderRequest) | PUT | /admin/oauth/providers/{name} | 更新OAuth提供商 |
| putAdminOauthProvidersToggleByProviders(client, name: string, data: AdminToggleProviderRequest) | PUT | /admin/oauth/providers/{name}/toggle | 启停OAuth提供商 |
| deleteAdminOauthTokensUserByUser(client, userId: string) | DELETE | /admin/oauth/tokens/user/{user_id} | 批量撤销用户令牌 |
| getOauthAuthorize(client, params?) | GET | /oauth/authorize | OAuth 2.0 授权端点 |
| postOauthAuthorize(client, data: Record<string, unknown>) | POST | /oauth/authorize | OAuth 2.0 授权端点(POST) |
| postOauthBindInitiate(client, data: BindInitiateRequest) | POST | /oauth/bind/initiate | 发起 OAuth 账号绑定 |
| getOauthClientByClient(client, clientId: string) | GET | /oauth/client/{client_id} | 获取客户端公开信息 |
| getOauthConnectionsByConnections(client, userId: string) | GET | /oauth/connections/{user_id} | 获取 OAuth 连接列表 |
| getOauthConsentCheck(client, params?) | GET | /oauth/consent/check | 检查用户授权状态 |
| getOauthConsents(client) | GET | /oauth/consents | 获取授权同意列表 |
| deleteOauthConsentsByConsents(client, id: string) | DELETE | /oauth/consents/{id} | 撤销授权同意 |
| postOauthDeviceAuthorize(client, data: DeviceAuthorizationRequest) | POST | /oauth/device/authorize | 设备授权请求 |
| postOauthDeviceVerify(client, data: DeviceAuthorizationVerifyRequest) | POST | /oauth/device/verify | 设备授权验证(用户侧) |
| getOauthDpopNonce(client) | GET | /oauth/dpop/nonce | 获取 DPoP Nonce |
| getOauthLogout(client, params?) | GET | /oauth/logout | RP-Initiated Logout |
| postOauthLogout(client, params?) | POST | /oauth/logout | RP-Initiated Logout |
| getOauthProviders(client) | GET | /oauth/providers | 获取 OAuth 提供商列表 |
| postOauthPushedAuthorization(client, data: PushedAuthorizationRequest) | POST | /oauth/pushed-authorization | 推送授权请求(PAR) |
| postOauthRegister(client, data: ClientRegistrationRequest) | POST | /oauth/register | 动态客户端注册 |
| deleteOauthRegisterByRegister(client, clientId: string) | DELETE | /oauth/register/{client_id} | 删除客户端注册 |
| getOauthRegisterByRegister(client, clientId: string) | GET | /oauth/register/{client_id} | 读取客户端注册 |
| putOauthRegisterByRegister(client, clientId: string, data: ClientRegistrationUpdateRequest) | PUT | /oauth/register/{client_id} | 更新客户端注册 |
| getOauthRiskAssessment(client, params?) | GET | /oauth/risk-assessment | 获取OAuth客户端风险评估 |
| deleteOauthUnbindByUnbind(client, connectionId: string) | DELETE | /oauth/unbind/{connection_id} | 解绑 OAuth 账号 |
| getOauthUserinfo(client) | GET | /oauth/userinfo | 获取用户信息 |
| getOauthAuthorizeByOauth(client, provider: string, params?) | GET | /oauth/{provider}/authorize | 获取 OAuth 授权 URL |
| getOauthBindCallbackByOauth(client, provider: string, params?) | GET | /oauth/{provider}/bind/callback | OAuth 账号绑定回调 |
| getOauthCallbackByOauth(client, provider: string, params?) | GET | /oauth/{provider}/callback | OAuth 授权回调 |
Install
npm install @autional/core @autional/api-oauthQuick Start
import { Autional, browserPlatform } from '@autional/core';
import { getOauthConsents } from '@autional/api-oauth';
const autional = new Autional({
appId: 'my-app',
issuer: 'https://auth.example.com', // your Autional server URL
platform: browserPlatform,
});
await autional.initialize();
// 返回值已由 ApiClient 解包为载荷(不是 { code, data, message } 信封)
const result = await getOauthConsents(autional.api);
console.log(result);Conventions
- Every function takes the
ApiClientas its first argument (autional.api). - Field names convert automatically:
camelCaseat the call site,snake_caseon the wire. - Return values are unwrapped payloads, not
{ code, data, message }envelopes.
See the root SDK README for tokens, refresh, and OAuth flows.
