文档

异常码

本文为您介绍接口异常码。

1、OAuth 异常码

{
    "error": "invalid_grant",
    "error_description": "Invalid authorization code: 202207211236389yghDWdB",
    "error_uri": "http://xxxxx/api/bff/v1.2/developer/ciam/oauth/token/provider",
    "requestId": "1658384361768$ca725dc4-182f-7562-17d2-53e6acf6a3ac"
}

错误码

含义

invalid_request

请求中不存在必须参数,或者存在未指定的参数或值不是正确的格式。

invalid_client

对应授权的应用不存在或者状态异常

invalid_grant

所提供的授权类型(例如,授权码、资源所有者凭据)或刷新令牌无效、过期、被撤销、与授权请求中使用的重定向 URI 不匹配,或者授权码已失效等异常

invalid_scope

请求的范围无效、未知或格式不正确

invalid_token

token 无效

unauthorized_client

客户端未被授权访问该请求

unauthorized_user

用户未被授权访问该请求

unsupported_grant_type

授权服务器不支持的授权类型

unsupported_response_type

授权服务器不支持的响应类型

access_denied

授权服务器拒绝了当前请求,可能是 token 无效

redirect_uri_mismatch

redirect_uri 不匹配

login_failed

用户ID或密码错误。

user_deleted

用户已经失效

server_error

授权服务器内部错误

2、CIAM 异常码

{
    "success": false,
    "code": "Operation.Failure",
    "message": "Operation.Failure.Mini.Program.Silent.Login",
    "requestId": "1656572265429$49b433a9-219a-910a-0323-2af4f1f1a9ce",
    "data": null
}

错误码 code

说明

错误码(code)用于标记当前异常的类型

异常码(code)

含义

Service.Internal.Error

CIAM 服务内部错误

Operation.Success

操作成功

Operation.Failure

操作失败

Resource.NotFound

资源不存在

Params.Blank

参数为空

Params.Illegal

参数无效

Operation.Denied

操作禁止(未授权或者未认证)

Remote.Error

调用第三方服务发生异常

Social.Login.Error

针对社交登录发生异常

Unsupported.Media.Type

请求方法的媒体类型不正确(POST、GET、PUT、DELETE等)

错误信息 message

说明

错误信息(message)用于标记当前异常的具体内容

系统公共异常

异常信息(message)

含义

Server.Access.Denied.Token.Expire

用户访问被拦截,Token 过期

Operation.Failure.RemoteServerCommonError

操作失败,依赖的其它服务返回异常

Operation.Failure.ResourceAlreadyExist

操作失败,资源已存在

Operation.Failure.UnknownError

操作失败,未知错误

Operation.Failure.Unsupported

操作失败,不支持的操作

Operation.Failure.ServerIntener.Error

操作失败,服务内部失败

Operation.Failure.Service.Internal.Error

服务内部错误

Server.Access.Denied

用户访问被拦截,无权限。

Operation.Failure.IP.Access.Invalid

当前 IP 不可访问

业务异常

异常信息(message)

含义

Operation.Failure.AuthenticateInformation.Disable

认证源未启用

Operation.Failure.AuthenticateInformation.Not.Found

认证源不存在

Operation.Failure.Captcha.Error

图形验证码不匹配

Operation.Failure.Captcha.Invalid

图形验证码失效或者不存在

Operation.Failure.Change.User.Type

切换用户类型发生错误

Operation.Failure.Email.Code.Error

短信或者邮箱验证码错误

Operation.Failure.Email.Code.Not.Find

短信或邮箱验证码找不到,请重新发送

Operation.Failure.Email.Code.Too.Frequency

验证码验证频率太高,请重新发送

Operation.Failure.Email.Not.Exist

二次认证失败,邮箱不存在

Operation.Failure.Email.Not.Same

提交的邮箱和发送验证码的邮箱不一致

Operation.Failure.FId.Not.Found

操作失败,fId 错误或者流程已过期

Operation.Failure.File.Size.Exceeds.Limit

上传文件时,文件大小超过限制

Operation.Failure.Gesture.Error

用户输入的手势轨迹错误

Operation.Failure.Gesture.Sign.Error

用户输入的手势轨迹错误

Operation.Failure.Invalid.AccessToken

access_token 无效

Operation.Failure.Invalid.IdToken

id_token 无效

Operation.Failure.Mini.Program.Phone

无法获取微信小程序中的手机号信息,可能是小程序端未传 encryptedData,或者 encryptedData 无效

Operation.Failure.Mini.Program.Silent.Login

小程序静默登录失败

Operation.Failure.Mini.Program.Userinfo

无法获取微信小程序中的用户信息,可能是小程序端未传 encryptedData,或者 encryptedData 无效

Operation.Failure.Oauth.Client.Not.Available

client_id 错误,或者所属的应用状态不可用

Operation.Failure.Password.Has.Initialized

密码已经被初始化过,不允许重复初始化

Operation.Failure.PhoneNumber.Not.Same

提交的手机号和发送验证码的手机号不一致

Operation.Failure.Public.Key.Not.Exist

id_token 公钥不存在

Operation.Failure.Send.Email.Fail

发送邮件失败

Operation.Failure.Send.Email.Too.Frequency

发送邮件的次数过多

Operation.Failure.Send.SMS.Fail

发送短信失败

Operation.Failure.Send.SMS.Too.Frequency

发送短信的次数过多

Operation.Failure.SMS.Code.Error

短信或者邮箱验证码错误,需要重新输入

Operation.Failure.SMS.Code.Not.Find

短信或邮箱验证码找不到,需要重新发送

Operation.Failure.SMS.Code.Too.Frequency

验证码验证频率太高,需要重新发送

Operation.Failure.Social.Code.Expired

社会化登录失败,第三方的 code 已经失效

Operation.Failure.Social.Login

社会化登录失败

Operation.Failure.Social.User.Auth.Error

第三方用户授权(获取)失败

Operation.Failure.Social.User.Not.Bind

社交登录时用户无绑定关系

Operation.Failure.SSO.Cannot.Get.Code

无法获取单点登录的 code

Operation.Failure.Unsupported.2fa.Type

不支持的二次认证操作

Operation.Failure.Unsupported.Dict.InUse

不支持修改或删除扩展属性,扩展属性正在使用

Operation.Failure.Unsupported.File.Type

上传文件时,文件类型不支持

Operation.Failure.Unsupported.Ignore.Complete

不支持跳过账号补充流程

Operation.Failure.Unsupported.Social.Platform

不支持的第三方社交平台

Operation.Failure.Unsupported.UserType.InUse

不支持修改或删除用户类型,用户类型正在使用

Operation.Failure.Update.Device.Status

设备管理 修改设备状态失败

Operation.Failure.User.Archived

用户已经被逻辑删除

Operation.Failure.User.Disabled

用户已经被禁用

Operation.Failure.User.Email.Equal.Original

修改邮箱时,新邮箱和旧邮箱一致

Operation.Failure.User.Locked

用户已经被锁定

Operation.Failure.User.Locked.And.Password.Error

账号密码错误次数太多,账号被锁定

Operation.Failure.User.Not.Bind.Gesture

用户没绑定过手势

Operation.Failure.User.Not.Exist

用户不存在

Operation.Failure.User.Password.Error

用户密码不正确

Operation.Failure.User.PhoneNumber.Equal.Original

修改手机号时,新手机号和旧手机号一致

Operation.Failure.Username.Or.Password.Error

账号或密码错误

Operation.Params.Illegal.DeviceId

设备管理,设备ID不存在

Params.Blank.ApplicationExternalId

安全认证失败,缺少 externalId

Params.Blank.Authentication.Id

认证源 ID 为空

Params.Blank.CaptchaCode

图形验证码唯一标识为空

Params.Blank.CaptchaText

图形验证码为空

Params.Blank.Code

验证码为空

Params.Blank.Device.DeviceId

设备管理,设备ID为空

Params.Blank.Dictionary.Uuid

扩展字段UUID为空

Params.Blank.Dictionary.Value.Uuid

扩展字段值UUID为空

Params.Blank.FId

fId 为空

Params.Blank.Gesture.Sign

手势登录异常,手势码为空

Params.Blank.Idaas.AppId

缺少 idaasAppId

Params.Blank.IdToken

id_token 为空

Params.Blank.Mini.Program.LoginCode

微信小程序登录时的临时登录凭证code为空

Params.Blank.Mini.Program.Phone

微信小程序 SSO 缺少 phoneNumberCode 或者 phoneNumberEncryptedData 或者 phoneNumberIv

Params.Blank.Mini.Program.Userinfo

微信小程序登录缺少 encryptedData 或者 iv

Params.Blank.MobileExtendParamsJson

生物识别缺少参数

Params.Blank.MobileExtendParamsJsonSign

生物识别缺少参数

Params.Blank.Social.Callback.Code

第三方登录时,第三方回调的 code 为空

Params.Blank.Type

发送验证码时,type 不能为空,可选 SMS、EMAIL

Params.Blank.Upload.File

上传文件时,文件为空或者文件名为空

Params.Blank.User.Address

用户的详细地址不能为空

Params.Blank.User.Birthday

用户的生日不能为空

Params.Blank.User.City

用户的城市不能为空

Params.Blank.User.Country

用户的国家不能为空

Params.Blank.User.DisplayName

用户的显示名称不能为空

Params.Blank.User.Email

邮箱不能为空

Params.Blank.User.EnDisplayName

用户的英文显示名称不能为空

Params.Blank.User.Extension.AttrValue

扩展属性的值不能为空

Params.Blank.User.ExternalId

外部id不能为空

Params.Blank.User.Gender

用户的性别不能为空

Params.Blank.User.Password

密码不能为空

Params.Blank.User.Phone.Number

手机号不能为空

Params.Blank.User.Province

用户的省份不能为空

Params.Blank.User.Region

用户的地区不能为空

Params.Blank.User.Street

用户的街道不能为空

Params.Blank.User.Username

用户的用户名不能为空

Params.Blank.User.Uuid

用户的uuid不能为空

Params.Blank.UserType.Code

userTypeCode不能为空

Params.Blank.UserType.Name

userTypeName不能为空

Params.Blank.UserType.Uuid

userTypeUuid不能为空

Params.Exist.SocialUser.SocialId

SocialId已存在

Params.Exist.User.Email

邮箱已存在

Params.Exist.User.ExternalId

外部id已存在

Params.Exist.User.Phone.Number

手机号已存在

Params.Exist.User.Username

用户的用户名已存在

Params.Exist.UserType

userType已经存在

Params.Exist.UserType.Code

userTypeCode已经存在

Params.Exist.UserType.Name

userTypeName已经存在

Params.Illegal.Consent

登录时传递的条款信息不正确

Params.Illegal.Dictionary.Uuid

无效的扩展字段 UUID

Params.Illegal.Dictionary.Value

扩展字段报错

Params.Illegal.Dictionary.Value.Uuid

无效的扩展字段值的UUID

Params.Illegal.Group.ExternalId

业务错误,无效的组外部ID。

Params.Illegal.Group.Name

业务错误,无效的组名称。

Params.Illegal.Group.Uuid

业务错误,无效的组唯一标识。

Params.Illegal.Type

发送验证码时,传递的 type 不支持

Params.Illegal.User.DisplayName

显示名称不合法

Params.Illegal.User.Email

邮箱不合法

Params.Illegal.User.Extension.AttrValue

用户补充的扩展属性不在待补充的范围

Params.Illegal.User.Password

不符合密码策略

Params.Illegal.User.Password.Policy

密码不符合策略规则

Params.Illegal.User.Password.Same.Old

修改密码时,新密码和旧密码一致

Params.Illegal.User.Phone.Number

手机号已存在

Params.Illegal.User.Username

用户的用户名已存在

Params.Illegal.User.Username.Policy

用户名不符合策略规则

Params.Illegal.User.UserType

根据 userType 查询用户时,userType 不存在

Params.Illegal.User.Uuid

用户的 UUID 无效,不存在

Params.Illegal.Username.Equal.Phone

用户名不可为手机号

Params.Blank.CaptchaText

图形验证码为空

Params.Blank.CaptchaCode

图形验证码校验码code为空

Operation.Failure.Captcha.Invalid

图形验证码无效

Operation.Failure.Captcha.Error

图形验证码验证失败

Params.Blank.OauthClient.ClientId

client_id 为空

Params.Blank.OauthClient.GrantType

grant_type 为空

Params.Blank.OauthClient.GrantSecret

client_secret 为空

Params.Blank.AuthenticateInformation.EnterpriseAuthId

认证源ID为空

Params.Illegal.OauthClient.ClientId

非法的 client_id

Params.Illegal.OauthClient.ClientSecret

非法的 client_secret

Params.Illegal.OauthClient.GrantType

非法的 grant_type

Params.Illegal.AuthenticateInformation.EnterpriseAuthId

认证源ID非法

  • 本页导读 (0)
文档反馈