AuthenticationClient (Authing Java SDK 3.0.3 API)

java.lang.Object
- cn.authing.sdk.java.client.BaseClient
- - cn.authing.sdk.java.client.AuthenticationClient

public class AuthenticationClient
extends BaseClient

作者:: ZKB

构造器概要

构造器
构造器和说明

AuthenticationClient(AuthenticationClientOptions options)

构造器
构造器和说明
`AuthenticationClient(AuthenticationClientOptions options)`

方法概要

所有方法实例方法具体方法
限定符和类型	方法和说明
`CommonResponseDto`	`bindEmail(BindEmailDto reqDto)`
`CommonResponseDto`	`bindPhone(BindPhoneDto reqDto)`
`String`	`buildAuthorizeUrl(IOidcParams params)` 拼接 OIDC、OAuth 2.0、SAML、CAS 协议授权链接
`String`	`buildLogoutUrl(BuildLogoutUrlParams params)` 之前版本 buildLogoutUrl 的补充，由于 buildLogoutUrl 函数名已经被占用，故命名为 buildLogoutUrlNew
`CommonResponseDto`	`changeQrCodeStatus(ChangeQRCodeStatusDto reqDto)`
`CheckQRCodeStatusRespDto`	`checkQrCodeStatus(CheckQrcodeStatusDto reqDto)`
`DecryptWechatMiniProgramDataRespDto`	`decryptWechatMiniProgramData(DecryptWechatMiniProgramDataDto reqDto)`
`IsSuccessRespDto`	`deleteAccount(DeleteAccounDto reqDto)`
`EnrollFactorRespDto`	`enrollFactor(EnrollFactorDto reqDto)`
`LoginTokenRespDto`	`exchangeTokenSetWithQrCodeTicket(ExchangeTokenSetWithQRcodeTicketDto reqDto)`
`GeneQRCodeRespDto`	`geneQrCode(GenerateQrcodeDto reqDto)`
`GenerateBindExtIdpLinkRespDto`	`generateLinkExtIdpUrl(GenerateLinkExtidpUrlDto reqDto)`
`GetAccessibleAppsRespDto`	`getAccessibleApps()`
`GetAccessTokenByClientCredentialsRespDto`	`getAccessTokenByClientCredentials(String scope, ClientCredentialInput options)` Client Credentials 模式获取 Access Token
`OIDCTokenResponse`	`getAccessTokenByCode(String code)`
`GetAlipayAuthInfoRespDto`	`getAlipayAuthInfo(GetAlipayAuthinfoDto reqDto)`
`GetExtIdpsRespDto`	`getApplicationEnabledExtIdps()`
`AuthorizedResourcePaginatedRespDto`	`getAuthorizedResources(GetMyAuthorizedResourcesDto reqDto)`
`String`	`getCodeChallengeDigest(CodeChallengeDigestParam options)` 生成 PKCE 校验码摘要值
`GetCountryListRespDto`	`getCountryList()`
`UserDepartmentPaginatedRespDto`	`getDepartmentList(GetMyDepartmentListDto reqDto)`
`GetFactorRespDto`	`getFactor(GetFactorDto reqDto)`
`GroupListRespDto`	`getGroupList()`
`GetIdentitiesRespDto`	`getIdentities()`
`GetLoggedInAppsRespDto`	`getLoggedInApps()`
`GetLoginHistoryRespDto`	`getLoginHistory(GetMyLoginHistoryDto reqDto)`
`GetNewAccessTokenByRefreshTokenRespDto`	`getNewAccessTokenByRefreshToken(String refreshToken)` 使用 Refresh token 获取新的 Access token
`UserSingleRespDto`	`getProfile(GetProfileDto reqDto)`
`RoleListRespDto`	`getRoleList(GetMyRoleListDto reqDto)`
`GetSecurityInfoRespDto`	`getSecurityLevel()`
`SystemInfoResp`	`getSystemInfo()`
`GetTenantListRespDto`	`getTenantList()`
`UserInfo`	`getUserInfoByAccessToken(String accessToken)` accessToken 换取用户信息
`Map<String,Object>`	`getUserInfoMapByAccessToken(String accessToken)` accessToken 换取用户信息，用户可以自取自定义的扩展字段
`GetWechatAccessTokenRespDto`	`getWechatMpAccessToken(GetWechatAccessTokenDto reqDto)`
`AccessToken`	`introspectAccessTokenOffline(String token)`
`IntrospectTokenRespDto`	`introspectToken(String token)` 检查 Access token 或 Refresh token 的状态
`ListEnrolledFactorsRespDto`	`listEnrolledFactors()`
`ListFactorsToEnrollRespDto`	`listFactorsToEnroll()`
`PreCheckCodeRespDto`	`preCheckCode(PreCheckCodeDto reqDto)`
`ResetFactorRespDto`	`resetFactor(ResetFactorDto reqDto)`
`IsSuccessRespDto`	`resetPassword(ResetPasswordDto reqDto)`
`boolean`	`revokeToken(String token)` 撤回 Access token 或 Refresh token
`SendEmailRespDto`	`sendEmail(SendEmailDto reqDto)`
`SendEnrollFactorRequestRespDto`	`sendEnrollFactorRequest(SendEnrollFactorRequestDto reqDto)`
`SendSMSRespDto`	`sendSms(SendSMSDto reqDto)`
`void`	`setAccessToken(String accessToken)`
`LoginTokenRespDto`	`signInByAccountPassword(String acconnt, String password, SignInOptionsDto options)` 使用账号（手机号/邮箱/用户名） + 密码登录
`LoginTokenRespDto`	`signInByAD(String sAMAccountName, String password, SignInOptionsDto options)` 使用 AD 账号密码登录
`LoginTokenRespDto`	`signInByCredentials(SigninByCredentialsDto reqDto)`
`LoginTokenRespDto`	`signInByEmailPassCode(String email, String passCode, SignInOptionsDto options)` 使用邮箱 + 验证码登录
`LoginTokenRespDto`	`signInByEmailPassword(String email, String password, SignInOptionsDto options)` 使用邮箱 + 密码登录
`LoginTokenRespDto`	`signInByLDAP(String sAMAccountName, String password, SignInOptionsDto options)` 使用 LDAP 账号密码登录
`LoginTokenRespDto`	`signInByMobile(SigninByMobileDto reqDto)`
`LoginTokenRespDto`	`signInByPhonePassCode(String phone, String passCode, String phoneCountryCode, SignInOptionsDto options)` 使用手机号 + 验证码登录
`LoginTokenRespDto`	`signInByPhonePassword(String phone, String password, SignInOptionsDto options)` 使用手机号 + 密码登录
`LoginTokenRespDto`	`signInByUsernamePassword(String username, String password, SignInOptionsDto options)` 使用用户名 + 密码登录
`UserSingleRespDto`	`signUp(SignUpDto reqDto)`
`UserSingleRespDto`	`signUpByEmailPassCode(String email, String passCode, SignUpProfileDto profile, SignUpOptionsDto options)` 使用邮箱 + 验证码注册
`UserSingleRespDto`	`signUpByEmailPassword(String email, String password, SignUpProfileDto profile, SignUpOptionsDto options)` 使用邮箱 + 密码注册
`UserSingleRespDto`	`signUpByPhonePassCode(String phone, String passCode, String phoneCountryCode, SignUpProfileDto profile, SignUpOptionsDto options)` 使用手机号 + 验证码注册
`UserSingleRespDto`	`signUpByUsernamePassword(String username, String password, SignUpProfileDto profile, SignUpOptionsDto options)` 使用用户名 + 密码注册
`CommonResponseDto`	`unbindEmail(UnbindEmailDto reqDto)`
`CommonResponseDto`	`unbindPhone(UnbindPhoneDto reqDto)`
`CommonResponseDto`	`unlinkExtIdp(UnlinkExtIdpDto reqDto)`
`CommonResponseDto`	`updateEmail(UpdateEmailDto reqDto)`
`CommonResponseDto`	`updatePassword(UpdatePasswordDto reqDto)`
`CommonResponseDto`	`updatePhone(UpdatePhoneDto reqDto)`
`UserSingleRespDto`	`updateProfile(UpdateUserProfileDto reqDto)`
`ValidateTicketV1Response`	`validateTicketV1(String ticket, String service)` 检验 CAS 1.0 Ticket 合法性
`String`	`validateTicketV2(String ticket, String service, String format)` 通过远端服务验证票据合法性
`ValidateTokenRespDto`	`validateToken(ValidateTokenParams params)` 效验Token合法性
`VerifyDeleteAccountRequestRespDto`	`verifyDeleteAccountRequest(VerifyDeleteAccountRequestDto reqDto)`
`PasswordResetVerifyResp`	`verifyResetPasswordRequest(VerifyResetPasswordRequestDto reqDto)`
`VerifyUpdateEmailRequestRespDto`	`verifyUpdateEmailRequest(VerifyUpdateEmailRequestDto reqDto)`
`VerifyUpdatePhoneRequestRespDto`	`verifyUpdatePhoneRequest(VerifyUpdatePhoneRequestDto reqDto)`

从类继承的方法 cn.authing.sdk.java.client.BaseClient
deserialize, request, serialize

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

构造器详细资料

AuthenticationClient

public AuthenticationClient(AuthenticationClientOptions options)
                     throws IOException,
                            ParseException

抛出:: IOException; ParseException

方法详细资料

setAccessToken

public void setAccessToken(String accessToken)

introspectAccessTokenOffline

public AccessToken introspectAccessTokenOffline(String token)
                                         throws Exception

抛出:: Exception

getAccessTokenByCode

public OIDCTokenResponse getAccessTokenByCode(String code)
                                       throws Exception

抛出:: Exception

validateTicketV1

public ValidateTicketV1Response validateTicketV1(String ticket,
                                                 String service)

检验 CAS 1.0 Ticket 合法性

validateTicketV2

public String validateTicketV2(String ticket,
                               String service,
                               String format)
                        throws Exception

通过远端服务验证票据合法性

抛出:: Exception

getCodeChallengeDigest

public String getCodeChallengeDigest(CodeChallengeDigestParam options)
                              throws Exception

生成 PKCE 校验码摘要值

抛出:: Exception

buildLogoutUrl
```
public String buildLogoutUrl(BuildLogoutUrlParams params)
                      throws Exception
```
之前版本 buildLogoutUrl 的补充，由于 buildLogoutUrl 函数名已经被占用，故命名为 buildLogoutUrlNew

参数:

params -

返回:

抛出:

Exception

getAccessTokenByClientCredentials

public GetAccessTokenByClientCredentialsRespDto getAccessTokenByClientCredentials(String scope,
                                                                                  ClientCredentialInput options)
                                                                           throws Exception

Client Credentials 模式获取 Access Token

抛出:: Exception

getUserInfoByAccessToken

public UserInfo getUserInfoByAccessToken(String accessToken)

accessToken 换取用户信息

getUserInfoMapByAccessToken
```
public Map<String,Object> getUserInfoMapByAccessToken(String accessToken)
```
accessToken 换取用户信息，用户可以自取自定义的扩展字段

buildAuthorizeUrl
```
public String buildAuthorizeUrl(IOidcParams params)
```
拼接 OIDC、OAuth 2.0、SAML、CAS 协议授权链接

getNewAccessTokenByRefreshToken

public GetNewAccessTokenByRefreshTokenRespDto getNewAccessTokenByRefreshToken(String refreshToken)

使用 Refresh token 获取新的 Access token

introspectToken

public IntrospectTokenRespDto introspectToken(String token)

检查 Access token 或 Refresh token 的状态

validateToken

public ValidateTokenRespDto validateToken(ValidateTokenParams params)

效验Token合法性

revokeToken
```
public boolean revokeToken(String token)
```
撤回 Access token 或 Refresh token

signInByUsernamePassword
```
public LoginTokenRespDto signInByUsernamePassword(String username,
                                                  String password,
                                                  SignInOptionsDto options)
```
使用用户名 + 密码登录

参数:

username - 用户名

password - 用户密码，默认不加密。Authing 所有 API 均通过 HTTPS 协议对密码进行安全传输，可以在一定程度上保证安全性。如果你还需要更高级别的安全性，我们还支持 `RSA256` 和国密 `SM2` 的密码加密方式。详情见可选参数 `options.passwordEncryptType`。

options - 认证可选参数

返回:

signInByEmailPassword
```
public LoginTokenRespDto signInByEmailPassword(String email,
                                               String password,
                                               SignInOptionsDto options)
```
使用邮箱 + 密码登录

参数:

email - 邮箱

password - 用户密码，默认不加密。Authing 所有 API 均通过 HTTPS 协议对密码进行安全传输，可以在一定程度上保证安全性。如果你还需要更高级别的安全性，我们还支持 `RSA256` 和国密 `SM2` 的密码加密方式。详情见可选参数 `options.passwordEncryptType`。

options - 认证可选参数

返回:

signInByPhonePassword
```
public LoginTokenRespDto signInByPhonePassword(String phone,
                                               String password,
                                               SignInOptionsDto options)
```
使用手机号 + 密码登录

参数:

phone - 手机号

password - 用户密码，默认不加密。Authing 所有 API 均通过 HTTPS 协议对密码进行安全传输，可以在一定程度上保证安全性。如果你还需要更高级别的安全性，我们还支持 `RSA256` 和国密 `SM2` 的密码加密方式。详情见可选参数 `options.passwordEncryptType`。

options - 认证可选参数

返回:

signInByAccountPassword
```
public LoginTokenRespDto signInByAccountPassword(String acconnt,
                                                 String password,
                                                 SignInOptionsDto options)
```
使用账号（手机号/邮箱/用户名） + 密码登录

参数:

acconnt - 账号（手机号/邮箱/用户名）

password - 用户密码，默认不加密。Authing 所有 API 均通过 HTTPS 协议对密码进行安全传输，可以在一定程度上保证安全性。如果你还需要更高级别的安全性，我们还支持 `RSA256` 和国密 `SM2` 的密码加密方式。详情见可选参数 `options.passwordEncryptType`。

options - 认证可选参数

返回:

signInByPhonePassCode

public LoginTokenRespDto signInByPhonePassCode(String phone,
                                               String passCode,
                                               String phoneCountryCode,
                                               SignInOptionsDto options)

使用手机号 + 验证码登录

参数:: phone - 手机号; phoneCountryCode - 手机区号; passCode - 验证码; options - 认证可选参数
返回:

signInByEmailPassCode

public LoginTokenRespDto signInByEmailPassCode(String email,
                                               String passCode,
                                               SignInOptionsDto options)

使用邮箱 + 验证码登录

参数:: email - 邮箱; passCode - 验证码; options - 认证可选参数
返回:

signInByLDAP
```
public LoginTokenRespDto signInByLDAP(String sAMAccountName,
                                      String password,
                                      SignInOptionsDto options)
```
使用 LDAP 账号密码登录

参数:

sAMAccountName - LDAP 用户目录中账号的 sAMAccountName

password - 用户密码，默认不加密。Authing 所有 API 均通过 HTTPS 协议对密码进行安全传输，可以在一定程度上保证安全性。如果你还需要更高级别的安全性，我们还支持 `RSA256` 和国密 `SM2` 的密码加密方式。详情见可选参数 `options.passwordEncryptType`。

options - 认证可选参数

返回:

signInByAD
```
public LoginTokenRespDto signInByAD(String sAMAccountName,
                                    String password,
                                    SignInOptionsDto options)
```
使用 AD 账号密码登录

参数:

sAMAccountName - LDAP 用户目录中账号的 sAMAccountName

password - 用户密码，默认不加密。Authing 所有 API 均通过 HTTPS 协议对密码进行安全传输，可以在一定程度上保证安全性。如果你还需要更高级别的安全性，我们还支持 `RSA256` 和国密 `SM2` 的密码加密方式。详情见可选参数 `options.passwordEncryptType`。

options - 认证可选参数

返回:

signUpByUsernamePassword
```
public UserSingleRespDto signUpByUsernamePassword(String username,
                                                  String password,
                                                  SignUpProfileDto profile,
                                                  SignUpOptionsDto options)
```
使用用户名 + 密码注册

参数:

username - 用户名

password - 用户密码，默认不加密。Authing 所有 API 均通过 HTTPS 协议对密码进行安全传输，可以在一定程度上保证安全性。如果你还需要更高级别的安全性，我们还支持 `RSA256` 和国密 `SM2` 的密码加密方式。详情见可选参数 `options.passwordEncryptType`。

profile - 注册时额外设置的用户资料，可选

options - 注册可选参数

返回:

signUpByEmailPassword
```
public UserSingleRespDto signUpByEmailPassword(String email,
                                               String password,
                                               SignUpProfileDto profile,
                                               SignUpOptionsDto options)
```
使用邮箱 + 密码注册

参数:

email - 邮箱

password - 用户密码，默认不加密。Authing 所有 API 均通过 HTTPS 协议对密码进行安全传输，可以在一定程度上保证安全性。如果你还需要更高级别的安全性，我们还支持 `RSA256` 和国密 `SM2` 的密码加密方式。详情见可选参数 `options.passwordEncryptType`。

profile - 注册时额外设置的用户资料，可选

options - 注册可选参数

返回:

signUpByEmailPassCode

public UserSingleRespDto signUpByEmailPassCode(String email,
                                               String passCode,
                                               SignUpProfileDto profile,
                                               SignUpOptionsDto options)

使用邮箱 + 验证码注册

参数:: email - 邮箱; passCode - 验证码; profile - 注册时额外设置的用户资料，可选; options - 注册可选参数
返回:

signUpByPhonePassCode

public UserSingleRespDto signUpByPhonePassCode(String phone,
                                               String passCode,
                                               String phoneCountryCode,
                                               SignUpProfileDto profile,
                                               SignUpOptionsDto options)

使用手机号 + 验证码注册

参数:: phone - 手机号; phoneCountryCode - 手机区号; passCode - 验证码; profile - 注册时额外设置的用户资料，可选; options - 注册可选参数
返回:

signInByCredentials

public LoginTokenRespDto signInByCredentials(SigninByCredentialsDto reqDto)

signInByMobile

public LoginTokenRespDto signInByMobile(SigninByMobileDto reqDto)

getAlipayAuthInfo

public GetAlipayAuthInfoRespDto getAlipayAuthInfo(GetAlipayAuthinfoDto reqDto)

geneQrCode

public GeneQRCodeRespDto geneQrCode(GenerateQrcodeDto reqDto)

checkQrCodeStatus

public CheckQRCodeStatusRespDto checkQrCodeStatus(CheckQrcodeStatusDto reqDto)

exchangeTokenSetWithQrCodeTicket

public LoginTokenRespDto exchangeTokenSetWithQrCodeTicket(ExchangeTokenSetWithQRcodeTicketDto reqDto)

changeQrCodeStatus

public CommonResponseDto changeQrCodeStatus(ChangeQRCodeStatusDto reqDto)

sendSms

public SendSMSRespDto sendSms(SendSMSDto reqDto)

sendEmail

public SendEmailRespDto sendEmail(SendEmailDto reqDto)

getProfile

public UserSingleRespDto getProfile(GetProfileDto reqDto)

updateProfile

public UserSingleRespDto updateProfile(UpdateUserProfileDto reqDto)

bindEmail

public CommonResponseDto bindEmail(BindEmailDto reqDto)

unbindEmail

public CommonResponseDto unbindEmail(UnbindEmailDto reqDto)

bindPhone

public CommonResponseDto bindPhone(BindPhoneDto reqDto)

unbindPhone

public CommonResponseDto unbindPhone(UnbindPhoneDto reqDto)

getSecurityLevel

public GetSecurityInfoRespDto getSecurityLevel()

updatePassword

public CommonResponseDto updatePassword(UpdatePasswordDto reqDto)

verifyUpdateEmailRequest

public VerifyUpdateEmailRequestRespDto verifyUpdateEmailRequest(VerifyUpdateEmailRequestDto reqDto)

updateEmail

public CommonResponseDto updateEmail(UpdateEmailDto reqDto)

verifyUpdatePhoneRequest

public VerifyUpdatePhoneRequestRespDto verifyUpdatePhoneRequest(VerifyUpdatePhoneRequestDto reqDto)

updatePhone

public CommonResponseDto updatePhone(UpdatePhoneDto reqDto)

verifyResetPasswordRequest

public PasswordResetVerifyResp verifyResetPasswordRequest(VerifyResetPasswordRequestDto reqDto)

resetPassword

public IsSuccessRespDto resetPassword(ResetPasswordDto reqDto)

verifyDeleteAccountRequest

public VerifyDeleteAccountRequestRespDto verifyDeleteAccountRequest(VerifyDeleteAccountRequestDto reqDto)

deleteAccount

public IsSuccessRespDto deleteAccount(DeleteAccounDto reqDto)

getSystemInfo
```
public SystemInfoResp getSystemInfo()
```

getCountryList

public GetCountryListRespDto getCountryList()

preCheckCode

public PreCheckCodeRespDto preCheckCode(PreCheckCodeDto reqDto)

sendEnrollFactorRequest

public SendEnrollFactorRequestRespDto sendEnrollFactorRequest(SendEnrollFactorRequestDto reqDto)

enrollFactor

public EnrollFactorRespDto enrollFactor(EnrollFactorDto reqDto)

resetFactor

public ResetFactorRespDto resetFactor(ResetFactorDto reqDto)

listEnrolledFactors

public ListEnrolledFactorsRespDto listEnrolledFactors()

getFactor

public GetFactorRespDto getFactor(GetFactorDto reqDto)

listFactorsToEnroll

public ListFactorsToEnrollRespDto listFactorsToEnroll()

generateLinkExtIdpUrl

public GenerateBindExtIdpLinkRespDto generateLinkExtIdpUrl(GenerateLinkExtidpUrlDto reqDto)

unlinkExtIdp

public CommonResponseDto unlinkExtIdp(UnlinkExtIdpDto reqDto)

getIdentities

public GetIdentitiesRespDto getIdentities()

getApplicationEnabledExtIdps

public GetExtIdpsRespDto getApplicationEnabledExtIdps()

signUp

public UserSingleRespDto signUp(SignUpDto reqDto)

decryptWechatMiniProgramData

public DecryptWechatMiniProgramDataRespDto decryptWechatMiniProgramData(DecryptWechatMiniProgramDataDto reqDto)

getWechatMpAccessToken

public GetWechatAccessTokenRespDto getWechatMpAccessToken(GetWechatAccessTokenDto reqDto)

getLoginHistory

public GetLoginHistoryRespDto getLoginHistory(GetMyLoginHistoryDto reqDto)

getLoggedInApps

public GetLoggedInAppsRespDto getLoggedInApps()

getAccessibleApps

public GetAccessibleAppsRespDto getAccessibleApps()

getTenantList

public GetTenantListRespDto getTenantList()

getRoleList

public RoleListRespDto getRoleList(GetMyRoleListDto reqDto)

getGroupList

public GroupListRespDto getGroupList()

getDepartmentList

public UserDepartmentPaginatedRespDto getDepartmentList(GetMyDepartmentListDto reqDto)

getAuthorizedResources

public AuthorizedResourcePaginatedRespDto getAuthorizedResources(GetMyAuthorizedResourcesDto reqDto)

类 AuthenticationClient

构造器概要