context 对象
context 对象中保存了当前认证流程的上下文,包括认证手段、身份提供方,以及请求 IP, 地址等。
属性
属性名 | 类型 | 说明 |
protocol | string | 认证协议。具体说明见下文。 |
connection | string | 身份提供方。具体说明见下文。 |
ldapConfiguration | object | ldap 配置,在为 ldap 认证的情况下带有。具体说明见下文。 |
samlConfiguration | object | saml 配置,在为 saml 认证的情况下带有。具体说明见下文。 |
oidcConfiguration | object | OIDC 应用配置,在为 OIDC 认证的情况下带有。具体说明见下文。 |
data | object | GraphQL POST 请求数据。如在注册前 Pipeline 中,开发者可以获取邮箱、手机号、注册方式等信息。详细字段请见下文。 |
headers | object | 原始请求头信息。 |
userPool | object | 用户池详细信息。处于安全考虑,这里不包含 secret 和 token。具体说明见下文。 |
ip | string | 请求者 IP。 |
geo | object | 包含了请求者的地址信息以及经纬度坐标。具体说明见下文。 |
protocol
认证协议。
可能值 | 说明 |
basic | 普通认证模式,基于用户名密码、手机号验证码。 |
social | 社会化登录认证默认,当使用 Authing 集成的社会化登录手段登录时为此值。 |
ldap | 使用 LDAP 进行认证。有关如何接入 LDAP 请见 配置 LDAP 服务。 |
saml | 使用 SAML 进行认证。有关如何接入 SAML 请见 接入 SAML。 |
oidc | 使用 OIDC 协议认证。有关如何接入 OIDC 请见使用 OIDC 授权。 |
connection
身份提供方。
可能值 | 说明 |
authing | 如使用用户名密码、手机号验证码,基于 Authing 的数据库进行验证。 |
ldap:<LDAP服务ID> | 使用 lDAP 协议进行登录。 一个 Authing LDAP 服务对应一个 Authing 用户目录或第三方用户目录,详情请见 配置 LDAP服务 和 使用 Authing 的 LDAP 用户目录。 |
saml:<SAML Idp 服务 ID> | 使用 SAML 协议进行登录。有关如何接入 SAML 请见 接入 SAML。 |
oidc:<OIDC 应用 ID> | 使用 OIDC 协议认证。有关如何接入 OIDC 请见 使用 OIDC 授权。 |
social:github | 使用 GitHub 登录。详情见接入 GitHub 登录。 |
social:wechat-pc | 微信 PC 扫码登录。详情见接入微信 PC 扫码登录。 |
social:wechat-miniprogram | 使用微信小程序登录。详情见接入微信小程序登录。 |
social:wechat-app | 使用微信移动应用登录。详情见接入移动端 APP 微信登录。 |
social:app2wxapp | 在移动应用 App 中拉起小程序登录。详情见接入移动端 APP 拉起小程序登录。 |
social:wechat-officialaccount-web | 使用微信公众号网页授权登录。详情见接入微信公众号网页授权登录。 |
social:qq-web | 使用 QQ 网页版登录。详情见接入 QQ 登录。 |
social:weibo-web | 使用微博网页版登录。详情见接入微博登录。 |
social:dingtalk-web | 使用钉钉网页版登录。详情见接入钉钉登录。 |
social:alipay-mobile | 使用支付宝 APP 登录。详情见接入移动 APP 支付宝登录。 |
social:wechatwork-web | 企业微信网页授权登录。详情见企业微信网页授权登录。 |
social:wechatwork-qrconnect | 企业微信扫码登录。详情见企业微信扫码登录。 |
data 对象
注册前、注册后 Pipeline 中 data 对象部分请求字段如下:详情请见 Authing GraphQL 调试器 用户鉴权 - 注册接口。
email, phone, unionid 等字段不一定同时存在,使用前请先判断其是否存在!如
字段名 | 类型 | 说明 |
userInfo | object | 用户注册所填的数据,如邮箱、手机号、浏览器 UA 等。 |
userInfo.registerInClient | string | 注册用户池 |
userInfo.registerMethod | string | 注册方式。若开发者自己使用 SDK 开发使用此接口,最好提供注册方式。如未提供,Authing 将从其他是否提供 |
userInfo.unionid | string | 社会化登录的 unionid。 |
userInfo.email | string | 邮箱。 |
userInfo.phone | string | 手机号。 |
userInfo.photo | string | 用户头像。 |
认证后 Pipeline 中 data 对象部分请求字段如下:详情请见 Authing GraphQL 调试器 用户鉴权 - 登录接口。
这些字段不一定全部存在,使用前请先判断是否存在!
字段名 | 类型 | 说明 |
registerInClient | string | 用户池 ID |
phone | string | 手机号 |
phoneCode | string | 手机号验证码 |
unionid | string | 社会化登录 unionid |
openid | string | 社会化登录 openid |
string | 邮箱 | |
lastIP | string | 登录 IP |
browser | string | 浏览器 |
userPool 对象
字段名 | 类型 | 说明 |
_id | string | 用户池 ID |
name | string | 用户池名称 |
logo | string | 用户池图标 |
registerDisabled | boolean | 是否关闭注册 |
userPoolTypeList | array | 用户池类型列表。每个类型内容如下: |
geo 属性
示例数据:
oidcConfiguration
_id: OIDC 应用 ID。
clientId: 用户池 ID。
redirect_uris: 回调链接列表。
token_endpoint_auth_method: 换取 token 认证模式。
grant_types: 授权模式。
id_token_signed_response_alg: id_token 签名算法。
authorization_code_expire: authorization_code 有效时间,单位为秒。
Last updated