Passport 文档

Developer Handbook API References

共享错误码

HTTP

/

GET/health健康检查

GET/metrics指标暴露

/api/v1

auth

auth/linked-accounts

GET/api/v1/auth/linked-accounts列出我的三方绑定

POST/api/v1/auth/linked-accounts绑定一个三方身份

DELETE/api/v1/auth/linked-accounts/:linkId解绑一个三方身份

auth/sessions

GET/api/v1/auth/sessions列出我的全部会话

POST/api/v1/auth/sessions/revoke-all吊销除当前外的全部会话

DELETE/api/v1/auth/sessions/:sessionId吊销指定会话

types

InterfaceSessionDTO

InterfaceAttemptStateDTO

InterfaceLoginResultDTO

InterfaceLinkedAccountDTO

GET/api/v1/auth/attempt查看登录尝试状态

POST/api/v1/auth/attempt/reset作废当前登录尝试并重新开始

POST/api/v1/auth/login/otp手机号 / 邮箱 + OTP 登录

POST/api/v1/auth/login/password手机号 / 邮箱 / 用户名 + 密码登录

POST/api/v1/auth/login/third-partyGoogle / Apple / GitHub 三方登录

POST/api/v1/auth/logout注销当前会话

POST/api/v1/auth/mfa/verify登录中的 MFA 校验

POST/api/v1/auth/refresh刷新会话令牌

POST/api/v1/auth/register手机号 / 邮箱 + OTP 验证注册账号

GET/api/v1/auth/session查看当前会话信息

captcha

GET/api/v1/captcha/challenge签发一个图形验证码挑战

POST/api/v1/captcha/verify校验验证码答案

mfa

GET/api/v1/mfa/factors列出我的 MFA 因素

POST/api/v1/mfa/factors创建一个 MFA 因素

DELETE/api/v1/mfa/factors/:factorId删除一个 MFA 因素

POST/api/v1/mfa/factors/:factorId/confirm确认 MFA 因素生效

otp

POST/api/v1/otp/send发送验证码

POST/api/v1/otp/verify校验验证码

me

me/addresses

GET/api/v1/me/addresses列出我的收货地址

POST/api/v1/me/addresses新增一个收货地址

PATCH/api/v1/me/addresses/:addressId更新一个收货地址

DELETE/api/v1/me/addresses/:addressId删除一个收货地址

me/authorizations

GET/api/v1/me/authorizations列出我的三方授权

DELETE/api/v1/me/authorizations/:grantId撤销一个三方授权

me/contacts

GET/api/v1/me/contacts列出我的联系方式

POST/api/v1/me/contacts绑定一个联系方式

DELETE/api/v1/me/contacts/:contactId解绑一个联系方式

me/payment-methods

GET/api/v1/me/payment-methods列出我的支付方式

POST/api/v1/me/payment-methods绑定一个支付方式

DELETE/api/v1/me/payment-methods/:methodId删除一个支付方式

POST/api/v1/me/payment-methods/:methodId/default设为默认支付方式

types

InterfaceUserProfileDTO

InterfaceContactDTO

InterfaceAddressDTO

InterfacePaymentMethodDTO

InterfaceAuthorizationDTO

GET/api/v1/me查看我的资料

PATCH/api/v1/me更新我的资料

GET/api/v1/me/logs查询我的日志

GET/api/v1/me/orders查询我的订单

POST/api/v1/me/password设置 / 修改我的密码

GET/api/v1/me/permissions查看我的权限清单

GET/api/v1/me/subscriptions查询我的订阅

orgs

orgs/invitations

POST/api/v1/orgs/invitations/:token/accept接受组织邀请

GET/api/v1/orgs/:orgId/invitations列出组织邀请

POST/api/v1/orgs/:orgId/invitations发起组织邀请

orgs/members

GET/api/v1/orgs/:orgId/members列出组织成员

DELETE/api/v1/orgs/:orgId/members/:userId移除组织成员

orgs/roles

POST/api/v1/orgs/:orgId/members/:userId/roles为成员授予组织角色

DELETE/api/v1/orgs/:orgId/members/:userId/roles/:roleId撤销成员的组织角色

GET/api/v1/orgs/:orgId/roles列出组织角色

POST/api/v1/orgs/:orgId/roles创建组织角色

PATCH/api/v1/orgs/:orgId/roles/:roleId更新角色

DELETE/api/v1/orgs/:orgId/roles/:roleId删除角色

PUT/api/v1/orgs/:orgId/roles/:roleId/permissions整体设置角色权限

orgs/teams

orgs/teams/members

POST/api/v1/orgs/:orgId/teams/:teamId/members/:userId添加团队成员

DELETE/api/v1/orgs/:orgId/teams/:teamId/members/:userId移除团队成员

GET/api/v1/orgs/:orgId/teams列出组织团队

POST/api/v1/orgs/:orgId/teams创建团队

PATCH/api/v1/orgs/:orgId/teams/:teamId更新团队

DELETE/api/v1/orgs/:orgId/teams/:teamId删除团队

types

InterfaceOrgDTO

InterfaceMemberDTO

InterfaceTeamDTO

InterfaceInvitationDTO

InterfaceRoleDTO

GET/api/v1/orgs列出我所在的组织

POST/api/v1/orgs创建组织

GET/api/v1/orgs/:orgId查看组织详情

PATCH/api/v1/orgs/:orgId更新组织

DELETE/api/v1/orgs/:orgId注销组织

dev

dev/apps

GET/api/v1/dev/apps列出我的应用

POST/api/v1/dev/apps注册应用

GET/api/v1/dev/apps/:appId查看应用详情

PATCH/api/v1/dev/apps/:appId更新应用

DELETE/api/v1/dev/apps/:appId删除应用

GET/api/v1/dev/apps/:appId/grants查看应用的用户授权记录

PUT/api/v1/dev/apps/:appId/scopes变更应用申请的 scope

POST/api/v1/dev/apps/:appId/secrets/rotate轮换应用密钥

GET/api/v1/dev/scopes列出开放平台 scope 目录

orders

POST/api/v1/orders创建订单（HTTP 镜像）

GET/api/v1/orders/:orderId查看订单详情

POST/api/v1/orders/:orderId/cancel取消订单

POST/api/v1/orders/:orderId/pay支付订单

subscriptions

POST/api/v1/subscriptions创建订阅（HTTP 镜像）

GET/api/v1/subscriptions/:subscriptionId查看订阅详情

POST/api/v1/subscriptions/:subscriptionId/cancel取消订阅

admin

admin/apps

GET/api/v1/admin/apps检索应用

POST/api/v1/admin/apps/:appId/approve批准应用

POST/api/v1/admin/apps/:appId/ban封禁应用

POST/api/v1/admin/apps/:appId/secrets/reset重置应用密钥

admin/attempt-config

GET/api/v1/admin/attempt-config查看登录评分配置

PUT/api/v1/admin/attempt-config更新登录评分配置

admin/audit-logs

GET/api/v1/admin/audit-logs检索审计日志

GET/api/v1/admin/audit-logs/export导出审计日志

admin/orders

GET/api/v1/admin/orders检索订单

POST/api/v1/admin/orders/:orderId/refund订单退款

admin/roles

GET/api/v1/admin/roles列出管理角色

POST/api/v1/admin/roles创建管理角色

PATCH/api/v1/admin/roles/:roleId更新管理角色

DELETE/api/v1/admin/roles/:roleId删除管理角色

admin/subscriptions

GET/api/v1/admin/subscriptions检索订阅

POST/api/v1/admin/subscriptions/:subscriptionId/cancel管理侧取消订阅

POST/api/v1/admin/subscriptions/:subscriptionId/extend延长订阅

admin/users

GET/api/v1/admin/users检索用户

GET/api/v1/admin/users/:userId查看用户详情

GET/api/v1/admin/users/:userId/attempts查看用户登录尝试历史

POST/api/v1/admin/users/:userId/force-offline强制下线

POST/api/v1/admin/users/:userId/freeze冻结用户

POST/api/v1/admin/users/:userId/reset-credentials重置用户凭据

POST/api/v1/admin/users/:userId/roles授予管理角色

DELETE/api/v1/admin/users/:userId/roles/:roleId撤销管理角色

POST/api/v1/admin/users/:userId/unfreeze解冻用户

GET/api/v1/admin/me查看当前管理员信息

NATS

attempt

attempt.config

NATSattempt.config.get读取评分配置

attempt.history

NATSattempt.history.query检索用户尝试历史

attempt.ticket

NATSattempt.ticket.abandon作废尝试工单

NATSattempt.ticket.consume消费尝试工单

NATSattempt.ticket.inspect查看尝试状态

NATSattempt.record记录因素结果并获取尝试工单

audit

audit.event

NATSaudit.event.published审计事件发布（JetStream 事件）

audit.log

NATSaudit.log.export导出审计日志

NATSaudit.log.query检索审计日志

NATSaudit.log.summary审计日志汇总

captcha

captcha.challenge

NATScaptcha.challenge.create签发图形验证码挑战

NATScaptcha.challenge.verify校验验证码答案

captcha.ticket

NATScaptcha.ticket.consume消费已验证工单

identity

identity.session

NATSidentity.session.create签发会话

NATSidentity.session.list列出用户会话

NATSidentity.session.revoke吊销会话

NATSidentity.session.revoke-all吊销用户全部会话

NATSidentity.session.validate内省校验会话

identity.user

NATSidentity.user.check检查标识符是否可用

NATSidentity.user.link-third-party绑定三方身份

NATSidentity.user.register注册账号

NATSidentity.user.set-password设置或修改密码

NATSidentity.user.set-status设置账号状态

NATSidentity.user.unlink-third-party解绑三方身份

NATSidentity.user.verify-password校验用户密码

oauth

oauth.app

NATSoauth.app.create注册应用

NATSoauth.app.get读取应用详情

NATSoauth.app.list列出应用

NATSoauth.app.remove删除应用

NATSoauth.app.scopes-apply变更应用申请的 scope

NATSoauth.app.secrets-rotate轮换应用密钥

NATSoauth.app.update更新应用

oauth.authorize

NATSoauth.authorize.validate校验授权请求并签发授权码

oauth.grant

NATSoauth.grant.list列出用户授权记录

NATSoauth.grant.revoke撤销用户授权

oauth.jwks

NATSoauth.jwks.get读取 JWKS 公钥集

oauth.scope

NATSoauth.scope.list列出 scope 目录

oauth.token

NATSoauth.token.introspect内省访问令牌

NATSoauth.token.issue换发访问令牌

NATSoauth.token.revoke吊销访问令牌

organization

organization.invitation

NATSorganization.invitation.accept接受邀请加入组织

NATSorganization.invitation.create发起组织邀请

NATSorganization.invitation.list列出组织邀请

organization.member

NATSorganization.member.list列出组织成员

NATSorganization.member.remove移除组织成员

organization.org

NATSorganization.org.create创建组织

NATSorganization.org.get读取组织详情

NATSorganization.org.list列出用户的组织

NATSorganization.org.remove注销组织

NATSorganization.org.update更新组织

organization.team

organization.team.member

NATSorganization.team.member.add添加团队成员

NATSorganization.team.member.remove移除团队成员

NATSorganization.team.create创建团队

NATSorganization.team.list列出组织团队

NATSorganization.team.remove删除团队

NATSorganization.team.update更新团队

otp

otp.admin

NATSotp.admin.reset管理侧重置 OTP / MFA

otp.code

NATSotp.code.request请求发送 OTP

NATSotp.code.verify校验 OTP

otp.mfa

NATSotp.mfa.factor-bind创建 MFA 因素

NATSotp.mfa.factor-list列出用户 MFA 因素

NATSotp.mfa.factor-remove删除 MFA 因素

NATSotp.mfa.verify校验 MFA 码

otp.send

NATSotp.send.requestedOTP 投递任务（JetStream 事件）

otp.ticket

NATSotp.ticket.consume消费已验证工单

payment

payment.method

NATSpayment.method.add绑定支付方式

NATSpayment.method.list列出用户支付方式

NATSpayment.method.remove删除支付方式

NATSpayment.method.set-default设为默认支付方式

payment.order

payment.order.reconcile

NATSpayment.order.reconcile.diff订单对账差异（JetStream 事件）

NATSpayment.order.cancel取消订单

NATSpayment.order.create创建收款订单

NATSpayment.order.get读取订单

NATSpayment.order.paid支付完成通知（JetStream 事件）

NATSpayment.order.pay执行订单支付

NATSpayment.order.refund订单退款

payment.subscription

payment.subscription.renewal

NATSpayment.subscription.renewal.due订阅续订到期（JetStream 事件）

NATSpayment.subscription.cancel取消订阅

NATSpayment.subscription.create创建订阅

NATSpayment.subscription.extend延长订阅

NATSpayment.subscription.get读取订阅

payment.ticket

NATSpayment.ticket.consume消费支付确认工单

permission

permission.definition

NATSpermission.definition.list列出权限定义目录

permission.grant

NATSpermission.grant.assign授予成员角色

NATSpermission.grant.revoke撤销成员角色

permission.role

NATSpermission.role.create创建角色

NATSpermission.role.list列出角色

NATSpermission.role.remove删除角色

NATSpermission.role.update更新角色

permission.subject

NATSpermission.subject.list-permissions列出主体权限清单

NATSpermission.check鉴权裁决

profile

profile.address

NATSprofile.address.create创建地址

NATSprofile.address.delete删除地址

NATSprofile.address.list列出用户地址

NATSprofile.address.update更新地址

profile.contact

NATSprofile.contact.bind绑定联系方式

NATSprofile.contact.list列出用户联系方式

NATSprofile.contact.unbind解绑联系方式

profile.user

NATSprofile.user.get读取用户展示资料

NATSprofile.user.update更新用户展示资料

otp.send

OTP 投递任务（JetStream 事件流，otp_worker 消费执行短信 / 邮件投递）。

NATSotp.send.requested - OTP 投递任务（JetStream 事件）

otp.mfa.verify - 校验 MFA 码 otp.send.requested - OTP 投递任务（JetStream 事件）

© 2026 Passport 构建于 2026-10-15 00:28:10 UTC+08:00

esc