@autional/api-identity
v0.4.1
Published
Autional Identity API — auto-generated TypeScript client from identity-service
Readme
@autional/api-identity
Autional Identity API — auto-generated TypeScript client from identity-service (252 functions).
Auto-generated by
python sdk/scripts/generate-api-packages.py. Do not edit by hand.
Functions
| Function | Method | Path | Description |
|----------|--------|------|-------------|
| getAdminAbacPolicies(client, params?) | GET | /admin/abac-policies | 查询ABAC策略列表 |
| postAdminAbacPolicies(client, data: CreateABACPolicyRequest) | POST | /admin/abac-policies | 创建ABAC策略 |
| deleteAdminAbacPoliciesByAbacPolicies(client, policyId: string) | DELETE | /admin/abac-policies/{policy_id} | 删除ABAC策略 |
| getAdminAbacPoliciesByAbacPolicies(client, policyId: string) | GET | /admin/abac-policies/{policy_id} | 获取ABAC策略详情 |
| putAdminAbacPoliciesByAbacPolicies(client, policyId: string, data: UpdateABACPolicyRequest) | PUT | /admin/abac-policies/{policy_id} | 更新ABAC策略 |
| getAdminAgents(client, params?) | GET | /admin/agents | List Agents |
| postAdminAgents(client, data: CreateAgentRequest) | POST | /admin/agents | Create Agent |
| deleteAdminAgentsByAgents(client, agentId: string) | DELETE | /admin/agents/{agent_id} | Revoke Agent |
| getAdminAgentsByAgents(client, agentId: string) | GET | /admin/agents/{agent_id} | Get Agent |
| putAdminAgentsByAgents(client, agentId: string, data: UpdateAgentRequest) | PUT | /admin/agents/{agent_id} | Update Agent |
| getAdminAgentsActivityByAgents(client, agentId: string) | GET | /admin/agents/{agent_id}/activity | Get Agent Activity |
| getAdminAgentsCredentialsByAgents(client, agentId: string) | GET | /admin/agents/{agent_id}/credentials | List Agent Credentials |
| postAdminAgentsCredentialsByAgents(client, agentId: string, data: CreateAgentCredentialRequest) | POST | /admin/agents/{agent_id}/credentials | Create Agent Credential |
| deleteAdminAgentsCredentialsByAgentsByCredentials(client, agentId: string, credId: string) | DELETE | /admin/agents/{agent_id}/credentials/{cred_id} | Revoke Agent Credential |
| getAdminAgentsCredentialsByAgentsByCredentials(client, agentId: string, credId: string) | GET | /admin/agents/{agent_id}/credentials/{cred_id} | Get Agent Credential |
| postAdminAgentsCredentialsRotateByAgentsByCredentials(client, agentId: string, credId: string) | POST | /admin/agents/{agent_id}/credentials/{cred_id}/rotate | Rotate Agent Credential |
| getAdminAgentsPermissionsByAgents(client, agentId: string) | GET | /admin/agents/{agent_id}/permissions | Get Agent Permissions |
| getAdminAuthApiKeys(client, params?) | GET | /admin/auth/api-keys | 管理员查询 API Key 列表 |
| getAdminAuthApiKeysAnomalies(client) | GET | /admin/auth/api-keys/anomalies | 安全异常检测 |
| postAdminAuthApiKeysBatchRevoke(client, data: BatchRevokeRequest) | POST | /admin/auth/api-keys/batch-revoke | 批量吊销 API Key |
| postAdminAuthApiKeysCleanupAuditLogs(client, params?) | POST | /admin/auth/api-keys/cleanup-audit-logs | 清理旧审计日志 |
| getAdminAuthApiKeysExpiring(client, params?) | GET | /admin/auth/api-keys/expiring | 获取即将过期的 API Key |
| getAdminAuthApiKeysStats(client) | GET | /admin/auth/api-keys/stats | 管理员 API Key 统计 |
| deleteAdminAuthApiKeysForceByApiKeys(client, apiKeyId: string) | DELETE | /admin/auth/api-keys/{api_key_id}/force | 管理员强制吊销 API Key |
| getAdminConsents(client, params?) | GET | /admin/consents | 儿童同意记录列表 |
| getAdminIdentityProviders(client, params?) | GET | /admin/identity-providers | 列出身份提供商 |
| postAdminIdentityProviders(client, data: CreateIDPRequest) | POST | /admin/identity-providers | 创建身份提供商 |
| postAdminIdentityProvidersImportOidcDiscovery(client, data: ImportOIDCDiscoveryRequest) | POST | /admin/identity-providers/import-oidc-discovery | 导入OIDC Discovery |
| postAdminIdentityProvidersImportSamlMetadata(client, data: ImportSAMLMetadataRequest) | POST | /admin/identity-providers/import-saml-metadata | 导入SAML Metadata |
| deleteAdminIdentityProvidersByIdentityProviders(client, providerId: string) | DELETE | /admin/identity-providers/{provider_id} | 删除身份提供商 |
| getAdminIdentityProvidersByIdentityProviders(client, providerId: string) | GET | /admin/identity-providers/{provider_id} | 获取身份提供商详情 |
| putAdminIdentityProvidersByIdentityProviders(client, providerId: string, data: UpdateIDPRequest) | PUT | /admin/identity-providers/{provider_id} | 更新身份提供商 |
| postAdminIdentityProvidersActivateByIdentityProviders(client, providerId: string) | POST | /admin/identity-providers/{provider_id}/activate | 启用身份提供商 |
| getAdminIdentityProvidersAttributeMappingByIdentityProviders(client, providerId: string) | GET | /admin/identity-providers/{provider_id}/attribute-mapping | 获取属性映射 |
| putAdminIdentityProvidersAttributeMappingByIdentityProviders(client, providerId: string, data: UpdateAttributeMappingRequest) | PUT | /admin/identity-providers/{provider_id}/attribute-mapping | 更新属性映射 |
| getAdminIdentityProvidersCertificatesByIdentityProviders(client, providerId: string, params?) | GET | /admin/identity-providers/{provider_id}/certificates | 列出证书 |
| postAdminIdentityProvidersCertificatesByIdentityProviders(client, providerId: string, data: CreateCertificateRequest) | POST | /admin/identity-providers/{provider_id}/certificates | 上传证书 |
| deleteAdminIdentityProvidersCertificatesByIdentityProvidersByCertificates(client, providerId: string, certId: string) | DELETE | /admin/identity-providers/{provider_id}/certificates/{cert_id} | 删除证书 |
| postAdminIdentityProvidersCertificatesRotateByIdentityProvidersByCertificates(client, providerId: string, certId: string, data: RotateCertificateRequest) | POST | /admin/identity-providers/{provider_id}/certificates/{cert_id}/rotate | 证书轮转 |
| postAdminIdentityProvidersDeactivateByIdentityProviders(client, providerId: string) | POST | /admin/identity-providers/{provider_id}/deactivate | 停用身份提供商 |
| getAdminIdentityProvidersJitConfigByIdentityProviders(client, providerId: string) | GET | /admin/identity-providers/{provider_id}/jit-config | 获取JIT配置 |
| putAdminIdentityProvidersJitConfigByIdentityProviders(client, providerId: string, data: UpdateJITConfigRequest) | PUT | /admin/identity-providers/{provider_id}/jit-config | 更新JIT配置 |
| getAdminIdentityProvidersStatsByIdentityProviders(client, providerId: string) | GET | /admin/identity-providers/{provider_id}/stats | 获取提供商统计 |
| postAdminIdentityProvidersTestByIdentityProviders(client, providerId: string) | POST | /admin/identity-providers/{provider_id}/test | 测试身份提供商连接 |
| getAdminIdentityProvidersUsersByIdentityProviders(client, providerId: string, params?) | GET | /admin/identity-providers/{provider_id}/users | 获取提供商关联用户 |
| postAdminImpersonate(client, data: AdminImpersonateRequest) | POST | /admin/impersonate | 管理员模拟用户登录 |
| getAdminIots(client, params?) | GET | /admin/iots | List Devices |
| postAdminIots(client, data: CreateDeviceRequest) | POST | /admin/iots | Create Device |
| deleteAdminIotsByIots(client, iotId: string) | DELETE | /admin/iots/{iot_id} | Revoke Device |
| getAdminIotsByIots(client, iotId: string) | GET | /admin/iots/{iot_id} | Get Device |
| getAdminLdapHealth(client) | GET | /admin/ldap/health | LDAP directory health check |
| postAdminLdapTestConnection(client, data: LdapTestConnectionRequest) | POST | /admin/ldap/test-connection | Test LDAP directory connection |
| getAdminLdapGroupRoleMappingByLdap(client, name: string) | GET | /admin/ldap/{name}/group-role-mapping | Get LDAP group-role mapping |
| putAdminLdapGroupRoleMappingByLdap(client, name: string, data: LdapGroupRoleMappingRequest) | PUT | /admin/ldap/{name}/group-role-mapping | Update LDAP group-role mapping |
| getAdminMakerChecker(client, params?) | GET | /admin/maker-checker | 列出双人复核记录 |
| deleteAdminMakerCheckerByMakerChecker(client, recordId: string) | DELETE | /admin/maker-checker/{record_id} | 删除双人复核记录 |
| getAdminPoliciesNhi(client) | GET | /admin/policies/nhi | 获取NHI策略 |
| putAdminPoliciesNhi(client, data: NHIPolicyRequest) | PUT | /admin/policies/nhi | 更新NHI策略 |
| getAdminRobots(client, params?) | GET | /admin/robots | List Robots |
| postAdminRobots(client, data: CreateRobotRequest) | POST | /admin/robots | Create Robot |
| deleteAdminRobotsByRobots(client, robotId: string) | DELETE | /admin/robots/{robot_id} | Delete Robot |
| getAdminRobotsByRobots(client, robotId: string) | GET | /admin/robots/{robot_id} | Get Robot |
| putAdminRobotsByRobots(client, robotId: string, data: UpdateRobotRequest) | PUT | /admin/robots/{robot_id} | Update Robot |
| postAdminRobotsCommissionByRobots(client, robotId: string) | POST | /admin/robots/{robot_id}/commission | Commission Robot |
| postAdminRobotsDecommissionByRobots(client, robotId: string) | POST | /admin/robots/{robot_id}/decommission | Decommission Robot |
| postAdminRobotsIntentByRobots(client, robotId: string, data: IssueIntentTokenRequest) | POST | /admin/robots/{robot_id}/intent | Issue Intent Token |
| postAdminRobotsIntentRevokeByRobots(client, robotId: string, data: RevokeIntentTokenRequest) | POST | /admin/robots/{robot_id}/intent/revoke | Revoke Intent Token |
| getAdminRoleActivations(client, params?) | GET | /admin/role-activations | 查询角色激活记录 |
| postAdminRoleActivationsRevokeByRoleActivations(client, roleActivationId: string, data: RevokeActivationRequest) | POST | /admin/role-activations/{role_activation_id}/revoke | 撤销角色激活 |
| getAdminSecurityAuthConfig(client) | GET | /admin/security/auth-config | 获取认证配置 |
| putAdminSecurityAuthConfig(client, data: UpdateAuthConfigRequest) | PUT | /admin/security/auth-config | 更新认证配置 |
| getAdminSecurityPasswordPolicy(client) | GET | /admin/security/password-policy | 获取密码策略 |
| putAdminSecurityPasswordPolicy(client, data: UpdatePasswordPolicyRequest) | PUT | /admin/security/password-policy | 更新密码策略 |
| getAdminSecurityPasswordStats(client) | GET | /admin/security/password-stats | 获取密码统计 |
| getAdminSecurityRiskConfig(client) | GET | /admin/security/risk-config | 获取风险配置 |
| putAdminSecurityRiskConfig(client, data: RiskConfigRequest) | PUT | /admin/security/risk-config | 更新风险配置 |
| postAdminSecurityRiskConfigReset(client) | POST | /admin/security/risk-config/reset | 重置风险配置 |
| getAdminSecurityRiskDashboard(client) | GET | /admin/security/risk-dashboard | 风险仪表盘 |
| getAdminSecurityRiskEvents(client, params?) | GET | /admin/security/risk-events | 风险事件列表 |
| getAdminSecurityRiskEventsAggregation(client, params?) | GET | /admin/security/risk-events/aggregation | 风险事件聚合 |
| getAdminUsers(client, params?) | GET | /admin/users | 查询用户列表 |
| postAdminUsers(client, data: HTTPUserCreateRequest) | POST | /admin/users | 创建用户 |
| postAdminUsersBatch(client, data: BatchCreateUserRequest) | POST | /admin/users/batch | 批量创建用户 |
| postAdminUsersBatchStatus(client, data: BatchUpdateUserStatusRequest) | POST | /admin/users/batch/status | 批量更新用户状态 |
| postAdminUsersMerge(client, data: MergeUsersRequest) | POST | /admin/users/merge | 合并用户 |
| deleteAdminUsersByUsers(client, userId: string, params?) | DELETE | /admin/users/{user_id} | 删除用户 |
| getAdminUsersByUsers(client, userId: string) | GET | /admin/users/{user_id} | 获取用户详情 |
| putAdminUsersByUsers(client, userId: string, data: UserUpdateRequest) | PUT | /admin/users/{user_id} | 更新用户信息 |
| postAdminUsersAccountUnlocksByUsers(client, userId: string, data: UnlockAccountRequest) | POST | /admin/users/{user_id}/account-unlocks | 解锁账户 |
| postAdminUsersChildrenConsentDenyByUsers(client, userId: string) | POST | /admin/users/{user_id}/children-consent/deny | 拒绝儿童同意 |
| postAdminUsersChildrenConsentVerifyByUsers(client, userId: string) | POST | /admin/users/{user_id}/children-consent/verify | 验证儿童同意 |
| getAdminUsersDevicesByUsers(client, userId: string) | GET | /admin/users/{user_id}/devices | 管理员查询用户设备列表 |
| getAdminUsersIdentitiesByUsers(client, userId: string) | GET | /admin/users/{user_id}/identities | 获取用户身份列表 |
| postAdminUsersIdentitiesByUsers(client, userId: string, data: AddIdentityRequest) | POST | /admin/users/{user_id}/identities | 添加用户身份 |
| deleteAdminUsersIdentitiesByUsersByIdentities(client, userId: string, identityId: string) | DELETE | /admin/users/{user_id}/identities/{identity_id} | 移除用户身份 |
| putAdminUsersIdentitiesSetPrimaryByUsersByIdentities(client, userId: string, identityId: string) | PUT | /admin/users/{user_id}/identities/{identity_id}/set-primary | 设置主身份 |
| postAdminUsersIdentitiesVerificationsByUsersByIdentities(client, userId: string, identityId: string) | POST | /admin/users/{user_id}/identities/{identity_id}/verifications | 验证用户身份 |
| postAdminUsersImpersonateByUsers(client, userId: string, data: ImpersonateRequest) | POST | /admin/users/{user_id}/impersonate | 管理员模拟用户 |
| getAdminUsersLoginHistoriesByUsers(client, userId: string, params?) | GET | /admin/users/{user_id}/login-histories | 获取登录历史 |
| getAdminUsersOauthConnectionsByUsers(client, userId: string) | GET | /admin/users/{user_id}/oauth-connections | 管理员查看用户OAuth连接 |
| getAdminUsersPasskeysByUsers(client, userId: string) | GET | /admin/users/{user_id}/passkeys | 管理员查询用户Passkey凭证 |
| deleteAdminUsersPasskeysByUsersByPasskeys(client, userId: string, credentialId: string) | DELETE | /admin/users/{user_id}/passkeys/{credential_id} | 管理员撤销用户Passkey凭证 |
| putAdminUsersPasswordByUsers(client, userId: string, data: HTTPChangePasswordRequest) | PUT | /admin/users/{user_id}/password | 修改密码 |
| postAdminUsersPasswordResetsByUsers(client, userId: string, data: HTTPResetPasswordRequest) | POST | /admin/users/{user_id}/password-resets | 重置密码 |
| getAdminUsersPasswordStatusByUsers(client, userId: string) | GET | /admin/users/{user_id}/password-status | 获取用户密码状态 |
| getAdminUsersSecurityStatusByUsers(client, userId: string) | GET | /admin/users/{user_id}/security-status | 获取安全状态 |
| putAdminUsersStatusByUsers(client, userId: string, data: UpdateUserStatusRequest) | PUT | /admin/users/{user_id}/status | 更新用户状态 |
| postAuthAnonymous(client, data: AnonymousSigninRequest) | POST | /auth/anonymous | 匿名认证 |
| getAuthApiKeys(client, params?) | GET | /auth/api-keys | 查询 API Key 列表 |
| postAuthApiKeys(client, data: CreateApiKeyRequest) | POST | /auth/api-keys | 创建 API Key |
| deleteAuthApiKeysByApiKeys(client, apiKeyId: string) | DELETE | /auth/api-keys/{api_key_id} | 吊销 API Key |
| getAuthApiKeysByApiKeys(client, apiKeyId: string) | GET | /auth/api-keys/{api_key_id} | 获取 API Key 详情 |
| getAuthApiKeysAuditLogsByApiKeys(client, apiKeyId: string, params?) | GET | /auth/api-keys/{api_key_id}/audit-logs | 获取 API Key 审计日志 |
| postAuthApiKeysIpRestrictionsByApiKeys(client, apiKeyId: string, data: AddIPRestrictionRequest) | POST | /auth/api-keys/{api_key_id}/ip-restrictions | 添加 IP 限制 |
| deleteAuthApiKeysIpRestrictionsByApiKeysByIpRestrictions(client, apiKeyId: string, restrictionId: string) | DELETE | /auth/api-keys/{api_key_id}/ip-restrictions/{restriction_id} | 删除 IP 限制 |
| postAuthApiKeysRotateByApiKeys(client, apiKeyId: string) | POST | /auth/api-keys/{api_key_id}/rotate | 轮换 API Key |
| putAuthApiKeysScopesByApiKeys(client, apiKeyId: string, data: UpdateApiKeyScopesRequest) | PUT | /auth/api-keys/{api_key_id}/scopes | 更新 API Key 权限范围 |
| putAuthApiKeysStatusByApiKeys(client, apiKeyId: string, data: UpdateApiKeyStatusRequest) | PUT | /auth/api-keys/{api_key_id}/status | 启用/禁用 API Key |
| getAuthApiKeysUsageByApiKeys(client, apiKeyId: string) | GET | /auth/api-keys/{api_key_id}/usage | 获取 API Key 使用统计 |
| getAuthApiKeysUsageStatsByApiKeys(client, apiKeyId: string) | GET | /auth/api-keys/{api_key_id}/usage-stats | 获取 API Key 使用统计 |
| getAuthCaptchaChallenge(client, params?) | GET | /auth/captcha/challenge | 获取CAPTCHA挑战 |
| postAuthCheckPermission(client, data: CheckPermissionRequest) | POST | /auth/check-permission | 检查用户权限 |
| postAuthCheckRole(client, data: CheckRoleRequest) | POST | /auth/check-role | 检查用户角色 |
| postAuthForgotPassword(client, data: ForgotPasswordRequest) | POST | /auth/forgot-password | 忘记密码 |
| postAuthGenerateTicket(client, data: GenerateTicketInput) | POST | /auth/generate-ticket | 生成一次性票据 |
| postAuthIdTokenSignin(client, data: Record<string, unknown>) | POST | /auth/id-token/signin | ID Token登录(未启用) |
| postAuthLdapLogin(client, data: LdapLoginRequest) | POST | /auth/ldap/login | LDAP directory authentication |
| postAuthLogin(client, data: LoginRequest) | POST | /auth/login | 用户登录 |
| postAuthLoginEmailCode(client, data: LoginByEmailCodeRequest) | POST | /auth/login/email-code | 邮箱验证码登录 |
| postAuthLoginPhoneCode(client, data: LoginByPhoneCodeRequest) | POST | /auth/login/phone-code | 手机验证码登录 |
| postAuthLogout(client) | POST | /auth/logout | 退出登录 |
| getAuthMagicLinkCallback(client, params?) | GET | /auth/magic-link/callback | 魔法链接回调 (GET→POST 双步跳转) |
| postAuthMagicLinkCallback(client, params?) | POST | /auth/magic-link/callback | 魔法链接回调 (GET→POST 双步跳转) |
| postAuthMagicLinkRequest(client, data: RequestMagicLinkRequest) | POST | /auth/magic-link/request | 请求发送魔法链接 |
| deleteAuthMe(client, data: DeactivateAccountRequest) | DELETE | /auth/me | 停用当前账户 |
| getAuthMe(client) | GET | /auth/me | 获取当前登录用户信息 |
| putAuthMe(client, data: UpdateUserAuthRequest) | PUT | /auth/me | 更新当前用户信息 |
| getAuthMeAuditLogs(client, params?) | GET | /auth/me/audit-logs | 获取我的审计日志 |
| getAuthMeAuthenticatorBackup(client) | GET | /auth/me/authenticator/backup | - |
| postAuthMeAuthenticatorBackup(client, data: AuthenticatorBackupUploadRequest) | POST | /auth/me/authenticator/backup | - |
| deleteAuthMeAuthenticatorBackupByBackup(client, backupId: string) | DELETE | /auth/me/authenticator/backup/{backup_id} | - |
| getAuthMeAuthenticatorDevices(client) | GET | /auth/me/authenticator/devices | - |
| deleteAuthMeAuthenticatorDevicesByDevices(client, deviceId: string) | DELETE | /auth/me/authenticator/devices/{device_id} | 移除认证器设备 |
| getAuthMeChildrenConsent(client) | GET | /auth/me/children-consent | 获取儿童隐私同意状态 |
| deleteAuthMeConsent(client, params?) | DELETE | /auth/me/consent | 撤销用户同意 |
| postAuthMeConsent(client, data: ConsentRequest) | POST | /auth/me/consent | 记录用户同意 |
| getAuthMeConsentHistory(client) | GET | /auth/me/consent-history | 获取同意历史记录 |
| postAuthMeDeleteAccount(client, data: DeleteAccountRequest) | POST | /auth/me/delete-account | 永久删除账户 (GDPR 被遗忘权/账户删除) |
| getAuthMeDevices(client) | GET | /auth/me/devices | 获取我的设备列表 |
| deleteAuthMeDevicesByDevices(client, deviceId: string) | DELETE | /auth/me/devices/{device_id} | 移除设备 |
| putAuthMeDevicesTrustByDevices(client, deviceId: string, data: SelfTrustDeviceRequest) | PUT | /auth/me/devices/{device_id}/trust | 信任/取消信任设备 |
| getAuthMeEmailVerificationStatus(client) | GET | /auth/me/email-verification-status | 检查邮箱验证状态 |
| postAuthMeEmailChange(client, data: ChangeEmailRequest) | POST | /auth/me/email/change | 变更邮箱地址 |
| postAuthMeEmailChangeCancel(client) | POST | /auth/me/email/change/cancel | 取消邮箱变更 |
| postAuthMeEmailVerify(client, data: VerifyChangeRequest) | POST | /auth/me/email/verify | 验证邮箱变更 |
| postAuthMeExportData(client) | POST | /auth/me/export-data | 导出我的数据 (GDPR DSAR) |
| getAuthMeMemberships(client) | GET | /auth/me/memberships | 获取我的租户成员状态 |
| putAuthMePassword(client, data: HTTPChangePasswordRequest) | PUT | /auth/me/password | 修改当前用户密码 |
| postAuthMePasswordStrength(client, data: SelfServicePasswordStrengthRequest) | POST | /auth/me/password-strength | 检查密码强度 |
| getAuthMePermissions(client) | GET | /auth/me/permissions | 获取当前用户权限 |
| getAuthMePhoneVerificationStatus(client) | GET | /auth/me/phone-verification-status | 检查手机号验证状态 |
| postAuthMePhoneChange(client, data: ChangePhoneRequest) | POST | /auth/me/phone/change | 变更手机号 |
| postAuthMePhoneChangeCancel(client) | POST | /auth/me/phone/change/cancel | 取消手机号变更 |
| postAuthMePhoneVerify(client, data: VerifyChangeRequest) | POST | /auth/me/phone/verify | 验证手机号变更 |
| postAuthMeReauthenticate(client, data: ReAuthenticateRequest) | POST | /auth/me/reauthenticate | 重新认证(step-up) |
| getAuthMeRecoveryContacts(client) | GET | /auth/me/recovery-contacts | 获取恢复联系人列表 |
| postAuthMeRecoveryContacts(client, data: AddRecoveryContactRequest) | POST | /auth/me/recovery-contacts | 添加恢复联系人 |
| deleteAuthMeRecoveryContactsByRecoveryContacts(client, contactId: string) | DELETE | /auth/me/recovery-contacts/{contact_id} | 移除恢复联系人 |
| postAuthMeRecoveryContactsVerifyByRecoveryContacts(client, contactId: string, data: VerifyRecoveryContactRequest) | POST | /auth/me/recovery-contacts/{contact_id}/verify | 验证恢复联系人 |
| getAuthMeRoleActivations(client) | GET | /auth/me/role-activations | 查询我的角色激活 |
| postAuthMeRoleActivations(client, data: RequestActivationRequest) | POST | /auth/me/role-activations | 请求角色激活 |
| getAuthMeRoleActivationsAvailableRoles(client) | GET | /auth/me/role-activations/available-roles | 查询可申请的角色 |
| getAuthMeSamlLinks(client) | GET | /auth/me/saml-links | 获取SAML关联账户列表 |
| deleteAuthMeSamlLinksBySamlLinks(client, linkId: string) | DELETE | /auth/me/saml-links/{link_id} | 解绑SAML关联账户 |
| getAuthMeSecurityEvents(client, params?) | GET | /auth/me/security-events | 获取安全事件列表 |
| postAuthMeSecurityEventsDismissBySecurityEvents(client, eventId: string, data: SecurityEventDismissRequest) | POST | /auth/me/security-events/{event_id}/dismiss | 关闭安全事件提醒 |
| deleteAuthMeSessions(client) | DELETE | /auth/me/sessions | 登出所有会话 |
| getAuthMeSessions(client, params?) | GET | /auth/me/sessions | 获取我的会话列表 |
| deleteAuthMeSessionsBySessions(client, sessionId: string) | DELETE | /auth/me/sessions/{session_id} | 登出指定会话 |
| postAuthMeStopImpersonation(client) | POST | /auth/me/stop-impersonation | 结束模拟会话 |
| postAuthMeSwitchTenant(client, data: SwitchTenantRequest) | POST | /auth/me/switch-tenant | 切换当前租户 |
| getAuthMeTenants(client) | GET | /auth/me/tenants | 获取当前用户租户 |
| getAuthMeVerificationByVerification(client, trackingId: string) | GET | /auth/me/verification/{tracking_id} | 查询验证跟踪状态 |
| getAuthMeWebauthnCredentials(client) | GET | /auth/me/webauthn-credentials | 获取已注册的Passkey列表 |
| deleteAuthMeWebauthnCredentialsByWebauthnCredentials(client, credentialId: string) | DELETE | /auth/me/webauthn-credentials/{credential_id} | 删除Passkey |
| postAuthMfaSendCode(client, data: SendMFAChallengeCodeRequest) | POST | /auth/mfa/send-code | 发送MFA挑战验证码 |
| postAuthMfaVerifyChallenge(client, data: VerifyMFAChallengeRequest) | POST | /auth/mfa/verify-challenge | 验证MFA挑战 |
| getAuthOauthAccounts(client) | GET | /auth/oauth/accounts | 获取用户OAuth账号列表 |
| postAuthOauthBind(client, data: BindOAuthRequest) | POST | /auth/oauth/bind | 绑定OAuth账号 |
| getAuthOauthProviders(client) | GET | /auth/oauth/providers | 获取OAuth提供商列表 |
| getAuthOauthProvidersHealth(client) | GET | /auth/oauth/providers/health | 获取OAuth提供者健康状态 |
| postAuthOauthUnbind(client, data: UnbindOAuthRequest) | POST | /auth/oauth/unbind | 解绑OAuth账号 |
| getAuthOauthByOauth(client, provider: string) | GET | /auth/oauth/{provider} | 发起OAuth登录 |
| getAuthOauthCallbackByOauth(client, provider: string, params?) | GET | /auth/oauth/{provider}/callback | OAuth回调 |
| postAuthOidcBackchannelLogout(client, data: BackchannelLogoutRequest) | POST | /auth/oidc/backchannel-logout | OIDC后通道登出 |
| postAuthOidcLogout(client, params?) | POST | /auth/oidc/logout | RP发起登出 |
| getAuthOidcSessionIframe(client) | GET | /auth/oidc/session-iframe | OIDC会话状态iframe |
| postAuthQrLoginCancel(client, data: QrLoginCancelRequest) | POST | /auth/qr-login/cancel | 取消二维码登录 |
| postAuthQrLoginConfirm(client, data: QrLoginConfirmRequest) | POST | /auth/qr-login/confirm | 确认二维码登录 |
| postAuthQrLoginInitiate(client, data: QrLoginInitiateRequest) | POST | /auth/qr-login/initiate | 发起二维码登录 |
| postAuthQrLoginScan(client, data: QrLoginScanRequest) | POST | /auth/qr-login/scan | 扫描二维码登录 |
| getAuthQrLoginStatus(client, params?) | GET | /auth/qr-login/status | 查询二维码登录状态 |
| postAuthReAuthenticate(client, data: ReAuthenticateRequest) | POST | /auth/re-authenticate | 重新认证(step-up) |
| postAuthRecoverAccount(client, data: RecoverAccountRequest) | POST | /auth/recover-account | 通过恢复联系人初始化账户恢复 |
| postAuthRecoverAccountReset(client, data: RecoverAccountResetRequest) | POST | /auth/recover-account/reset | 通过恢复码重置密码 |
| postAuthRecoveryComplete(client, data: CompleteAccountRecoveryRequest) | POST | /auth/recovery/complete | 完成账户恢复 |
| postAuthRecoveryRequest(client, data: RequestAccountRecoveryRequest) | POST | /auth/recovery/request | 发起账户恢复 |
| postAuthRecoveryVerify(client, data: VerifyAccountRecoveryRequest) | POST | /auth/recovery/verify | 验证账户恢复码 |
| postAuthRefresh(client, data: RefreshTokenRequest) | POST | /auth/refresh | 刷新访问令牌 |
| postAuthRegister(client, data: RegisterRequest) | POST | /auth/register | 用户注册 |
| getAuthRegisterCheckEmail(client, data: CheckEmailRequest, params?) | GET | /auth/register/check-email | 检查邮箱是否可用 |
| postAuthRegisterCheckEmail(client, data: CheckEmailRequest, params?) | POST | /auth/register/check-email | 检查邮箱是否可用 |
| getAuthRegisterCheckUsername(client, data: CheckUsernameRequest, params?) | GET | /auth/register/check-username | 检查用户名是否可用 |
| postAuthRegisterCheckUsername(client, data: CheckUsernameRequest, params?) | POST | /auth/register/check-username | 检查用户名是否可用 |
| postAuthRegisterEmailCode(client, data: RegisterByEmailCodeRequest) | POST | /auth/register/email-code | 邮箱验证码注册 |
| postAuthRegisterInvitation(client, data: RegisterByInvitationRequest) | POST | /auth/register/invitation | 邀请注册 |
| postAuthRegisterOauth(client, data: RegisterByOAuthRequest) | POST | /auth/register/oauth | OAuth补充注册 |
| postAuthRegisterPhoneCode(client, data: RegisterByPhoneCodeRequest) | POST | /auth/register/phone-code | 手机验证码注册 |
| postAuthRegisterReapply(client, data: ReapplyRegistrationRequest) | POST | /auth/register/reapply | 重新申请注册 |
| postAuthResendSmsCode(client, data: ResendSMSCodeRequest) | POST | /auth/resend-sms-code | 重新发送短信验证码 |
| postAuthResendVerificationEmail(client, data: ResendVerificationEmailRequest) | POST | /auth/resend-verification-email | 重新发送邮箱验证邮件 |
| postAuthResetPassword(client, data: ResetPasswordRequest) | POST | /auth/reset-password | 重置密码 |
| postAuthSendSmsCode(client, data: SendSMSCodeRequest) | POST | /auth/send-sms-code | 发送短信验证码 |
| postAuthSendVerificationEmail(client, data: SendVerificationEmailRequest) | POST | /auth/send-verification-email | 发送邮箱验证邮件 |
| postAuthTicketSignin(client, data: TicketSigninRequest) | POST | /auth/ticket/signin | 票据签名登录 |
| postAuthVerifyEmail(client, data: VerifyEmailRequest) | POST | /auth/verify-email | 验证邮箱地址 |
| postAuthVerifyPhone(client, data: VerifyPhoneRequest) | POST | /auth/verify-phone | 验证手机号 |
| postAuthVerifyResetCode(client, data: VerifyResetCodeRequest) | POST | /auth/verify-reset-code | 验证重置验证码 |
| postAuthWeb3Verify(client, data: Web3VerifyRequest) | POST | /auth/web3/verify | 验证Web3钱包签名 |
| postAuthWebauthnAuthenticateBegin(client, data: PasskeyAuthBeginRequest) | POST | /auth/webauthn/authenticate/begin | 开始Passkey公开认证 |
| postAuthWebauthnAuthenticateComplete(client, data: PasskeyAuthenticateCompleteRequest) | POST | /auth/webauthn/authenticate/complete | 完成Passkey公开认证 |
| postAuthWebauthnLoginBegin(client, data: BeginLoginRequest) | POST | /auth/webauthn/login/begin | 开始Passkey登录 |
| postAuthWebauthnLoginComplete(client, data: CompleteLoginRequest) | POST | /auth/webauthn/login/complete | 完成Passkey登录 |
| postAuthWebauthnRegisterBegin(client, data: BeginRegistrationRequest) | POST | /auth/webauthn/register/begin | 开始Passkey注册 |
| postAuthWebauthnRegisterComplete(client, data: CompleteRegistrationRequest) | POST | /auth/webauthn/register/complete | 完成Passkey注册 |
| deleteDevices(client, params?) | DELETE | /devices | 移除所有设备 |
| getDevices(client) | GET | /devices | 获取用户设备列表 |
| deleteDevicesByDevices(client, deviceId: string) | DELETE | /devices/{device_id} | 移除设备 |
| putDevicesTrustByDevices(client, deviceId: string, data: TrustDeviceRequest) | PUT | /devices/{device_id}/trust | 信任/取消信任设备 |
| getIots(client, params?) | GET | /iots | List User Devices |
| postIotsPair(client, data: PairDeviceRequest) | POST | /iots/pair | Pair Device |
| deleteIotsByIots(client, iotId: string) | DELETE | /iots/{iot_id} | Unpair Device |
| getIotsFamilyAccessByIots(client, iotId: string) | GET | /iots/{iot_id}/family-access | List Family Members |
| postIotsFamilyAccessByIots(client, iotId: string, data: AddFamilyMemberRequest) | POST | /iots/{iot_id}/family-access | Add Family Member |
| deleteIotsFamilyAccessByIotsByFamilyAccess(client, iotId: string, memberId: string) | DELETE | /iots/{iot_id}/family-access/{member_id} | Remove Family Member |
| postIotsTransferByIots(client, iotId: string, data: TransferDeviceRequest) | POST | /iots/{iot_id}/transfer | Transfer Device |
| getPublicAuthConfigByDomainByByDomain(client, domain: string) | GET | /public/auth-config/by-domain/{domain} | 根据域名获取租户认证配置(公开) |
| getPublicAuthConfigBySlugByBySlug(client, slug: string) | GET | /public/auth-config/by-slug/{slug} | 根据租户标识获取认证配置(公开) |
| getPublicAuthConfigByAuthConfig(client, tenantId: string) | GET | /public/auth-config/{tenant_id} | 获取租户认证配置(公开) |
| getPublicKeyExchange(client) | GET | /public/key-exchange | ECDH 密钥交换 |
| postPublicPasswordStrength(client, data: CheckPublicPasswordStrengthRequest) | POST | /public/password-strength | 检查密码强度(公开) |
| getPublicTenantsDiscover(client) | GET | /public/tenants/discover | 发现公开可加入的租户 |
Install
npm install @autional/core @autional/api-identityQuick Start
import { Autional, browserPlatform } from '@autional/core';
import { getDevices } from '@autional/api-identity';
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 getDevices(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.
