cn.authing.core

类 Authing

cn.authing.core.Authing

public class Authing

Authing 客户端类

构造器详细资料

Authing

public Authing(@NotNull
               java.lang.String userPoolId,
               @Nullable
               java.lang.String secret)

Authing 客户端类

Authing

public Authing(@NotNull
               java.lang.String clientId)

方法详细资料

getHost

@NotNull
public java.lang.String getHost()

setHost

public void setHost(@NotNull
                    java.lang.String p)

getPublicKey

@NotNull
public java.lang.String getPublicKey()

setPublicKey

public void setPublicKey(@NotNull
                         java.lang.String p)

getAccessToken

@Nullable
public java.lang.String getAccessToken()

每次发出请求时会附加在请求头的 AccessToken

访问某些需要权限的接口则必须设置此变量

setAccessToken

public void setAccessToken(@Nullable
                           java.lang.String p)

每次发出请求时会附加在请求头的 AccessToken

访问某些需要权限的接口则必须设置此变量

loginBySecret

@NotNull
public Call<cn.authing.core.types.LoginBySecretResponse> loginBySecret()

通过初始化时传入的 Secret 登录

仅用户池管理员可用

返回:

AccessToken

loginByUsername

@NotNull
public Call<cn.authing.core.types.LoginByUsernameResponse> loginByUsername(@NotNull
                                                                                    LoginByUsernameParam param)

通过用户名和密码登录

loginByEmail

@NotNull
public Call<cn.authing.core.types.LoginByEmailResponse> loginByEmail(@NotNull
                                                                              LoginByEmailParam param)

通过邮箱密码登录

loginByPhoneCode

@NotNull
public Call<cn.authing.core.types.LoginByPhoneCodeResponse> loginByPhoneCode(@NotNull
                                                                                      LoginByPhoneCodeParam param)

通过手机号和验证码登录

loginByPhonePassword

@NotNull
public Call<cn.authing.core.types.LoginByPhonePasswordResponse> loginByPhonePassword(@NotNull
                                                                                              LoginByPhonePasswordParam param)

通过手机号和密码登录

loginByAd

@NotNull
public Call<cn.authing.core.types.LoginByAdResponse> loginByAd(@NotNull
                                                                        LoginByAdParam param)

通过 AD 登录

loginByLdap

@NotNull
public Call<cn.authing.core.types.LoginByLdapResponse> loginByLdap(@NotNull
                                                                            LoginByLdapParam param)

通过 LDAP 登录

register

@NotNull
public Call<cn.authing.core.types.RegisterResponse> register(@NotNull
                                                                      RegisterParam param)

注册

refreshToken

@NotNull
public Call<cn.authing.core.types.RefreshTokenResponse> refreshToken(@NotNull
                                                                              RefreshTokenParam param)

刷新用户 Token

user

@NotNull
public Call<cn.authing.core.types.UserResponse> user(@NotNull
                                                              UserParam param)

查询用户信息

updateUser

@NotNull
public Call<cn.authing.core.types.UpdateUserResponse> updateUser(@NotNull
                                                                          UpdateUserParam param)

更新用户信息

用户池管理员可以通过此接口直接更新用户手机号

updatePhone

@NotNull
public Call<cn.authing.core.types.UpdatePhoneResponse> updatePhone(@NotNull
                                                                            UpdatePhoneParam param)

更新用户手机号

普通用户需要在登录后使用，管理员请调用 updateUser 接口

checkLoginStatus

@NotNull
public Call<cn.authing.core.types.CheckLoginStatusResponse> checkLoginStatus(@NotNull
                                                                                      CheckLoginStatusParam param)

通过 Token 检查用户登录状态

resetPassword

@NotNull
public Call<cn.authing.core.types.ResetPasswordResponse> resetPassword(@NotNull
                                                                                ResetPasswordParam param)

重置密码

需要先发送重置密码邮件来得到验证码

unbindEmail

@NotNull
public Call<cn.authing.core.types.UnbindEmailResponse> unbindEmail(@NotNull
                                                                            UnbindEmailParam param)

解绑定邮箱

需要已经绑定了其他登录方式

readOauthList

@NotNull
public Call<cn.authing.core.types.ReadOauthListResponse> readOauthList(@NotNull
                                                                                ReadOauthListParam param)

读取用户 OAuth 授权列表

sendVerifyEmail

@NotNull
public Call<cn.authing.core.types.SendVerifyEmailResponse> sendVerifyEmail(@NotNull
                                                                                    SendVerifyEmailParam param)

发送验证邮件，邮件内包含认证链接

sendPhoneVerifyCode

@NotNull
public Call<cn.authing.core.types.SendPhoneVerifyCodeResponse> sendPhoneVerifyCode(@NotNull
                                                                                            java.lang.String phone)

发送手机验证码

sendResetPasswordEmail

@NotNull
public Call<cn.authing.core.types.SendResetPasswordEmailResponse> sendResetPasswordEmail(@NotNull
                                                                                                  SendResetPasswordEmailParam param)

发送重置密码邮件，邮件内包含验证码

verifyResetPasswordCode

@NotNull
public Call<cn.authing.core.types.VerifyResetPasswordVerifyCodeResponse> verifyResetPasswordCode(@NotNull
                                                                                                          VerifyResetPasswordVerifyCodeParam param)

验证重置密码邮件

userPatch

@NotNull
public Call<cn.authing.core.types.UserPatchResponse> userPatch(@NotNull
                                                                        UserPatchParam param)

通过 ID 列表批量获取用户信息

多个 ID 以英文逗号分隔，如：id1,id2,id3

users

@NotNull
public Call<cn.authing.core.types.UsersResponse> users(@NotNull
                                                                UsersParam param)

通过分页批量获取用户池中的用户信息

removeUsers

@NotNull
public Call<cn.authing.core.types.RemoveUsersResponse> removeUsers(@NotNull
                                                                            RemoveUsersParam param)

通过 ID 列表批量删除用户

多个 ID 以英文逗号分隔，如：id1,id2,id3