¶ Certified core module
This module contains registration, resetting the phone number mailbox, modifying account information, etc., is requested by your end user (End user), suitable for use in the case where you need to verify user identity.
// Initialize using AppId and appHost
AuthenticationClient authentication = new AuthenticationClient(APP_ID, APP_HOST);
¶ Use email registration
authenticationClient.registerByEmail(param)
Use the email registration, the mailbox is not case sensitive and the only userpool is unique. This interface does not require the user to verify the mailbox, and the emailVerified field will be false after the user registration. If you want the user who does not verify the mailbox cannot be logged in,you can open setting - security information in the userpoolUsers who have not verified mailboxes from logging in option:
¶ parameter
param<RegisterByEmailInput>param.email<String> emailparam.password<String> passwordparam.profile<RegisterProfileInput> user informationparam.forceLogin<Boolean> Whether to take a complete login, it will trigger the Pipeline function before and after login and the login event Webhook, and the number of cumulative logins of the user will add 1. Default is false.param.clientIp<String> The client is real IP. If you call this interface in the server, you must set this parameter as the real IP of the end user.param.context<String> Request context, set herecontextyou can get pipeline context.
¶ Example
String email = "test@example.com";
String password = "123456";
User user = authenticationClient.registerByEmail(new RegisterByEmailInput(email, password)).execute();
¶ Register using username
authenticationClient.registerByUsername(param)
User name is registered, the username is case sensitive and the only user pool.
¶ parameter
param<RegisterByUsernameInput>param.username<String> usernameparam.password<String> passwordparam.profile<RegisterProfileInput> user informationparam.forceLogin<Boolean> Whether to take a complete login, it will trigger the Pipeline function before and after login and the login event Webhook, and the number of cumulative logins of the user will add 1. Default is false.param.clientIp<String> The client is real IP. If you call this interface in the server, you must set this parameter as the real IP of the end user.param.context<String> Request context, set herecontextyou can get pipeline context.
¶ Example
String username = "test";
String password = "123456";
User user = authenticationClient.registerByUsername(new RegisterByUsernameInput(username, password)).execute();
¶ Use mobile phone number registration
authenticationClient.registerByPhoneCode(param)
Use your mobile phone number to register, you can set the initial password of the account at the same time. See the interface to send a text message.sendSmsCode
¶ parameter
param<RegisterByPhoneCodeInput>param.code<String> SMS verification codeparam.phone<String> phoneparam.password<String> Initial passwordparam.profile<RegisterProfileInput> user informationparam.forceLogin<Boolean> Whether to take a complete login, it will trigger the Pipeline function before and after login and the login event Webhook, and the number of cumulative logins of the user will add 1. Default is false.param.clientIp<String> The client is real IP. If you call this interface in the server, you must set this parameter as the real IP of the end user.param.context<String> Request context, set herecontextyou can get pipeline context.
¶ Example
String phone = "phone number";
String code = "1234";
String password = "123456";
RegisterByPhoneCodeInput param = new RegisterByPhoneCodeInput(phone, code).withPassword(password);
User user = authenticationClient.registerByPhoneCode(param).execute();
¶ Use the email login
authenticationClient.loginByEmail(param)
Use the email to log in, the interface does not limit the unprecedented mailbox by default, if you want the user who does not authenticate the mailbox, you can use pipeline to intercept this kind of request.
If your user pool is configured with login failure detection, the user will be required to enter graphic verification code (2000) when logging in multiple times in IP.
¶ parameter
param<LoginByEmailInput>param.email<String> emailparam.password<String> passwordparam.autoRegister<Boolean> Whether it is automatically registered. If the user does not exist, an account is automatically created according to the login book.param.captchaCode<String> Captchaparam.clientIp<String> The client is real IP. If you call this interface in the server, you must set this parameter as the real IP of the end user.param.autoRegister<Boolean> Whether it is automatically registered. If the user does not exist, an account is automatically created according to the login book.param.captchaCode<String> Captchaparam.clientIp<String> The client is real IP. If you call this interface in the server, you must set this parameter as the real IP of the end user.param.context<String> Request context, set herecontextyou can get pipeline context .
¶ Example
String email = "test@example.com";
String password = "123456";
User user = authenticationClient.loginByEmail(new LoginByEmailInput(email, password)).execute();
¶ Use the username to log in
authenticationClient.loginByUsername(param)
Use the username to log in. If your user pool is opened login failed detection，When the login is logged in, the user will be required to enter graphic verification code (error code 2000)。
¶ parameter
param<LoginByUsernameInput>param.username<String> usernameparam.password<String> passwordparam.autoRegister<Boolean> Whether it is automatically registered. If the user does not exist, an account is automatically created according to the login book.param.captchaCode<String> Captchaparam.clientIp<String> The client is real IP. If you call this interface in the server, you must set this parameter as the real IP of the end user.param.context<String> Request context, set herecontextyou can get pipeline context.
¶ Example
String username = "username";
String password = "123456";
User user = authenticationClient.loginByUsername(new LoginByUsernameInput(username, password)).execute();
¶ Use the mobile phone number verification code to log in
authenticationClient.loginByPhoneCode(param)
Use the mobile phone number verification code to log in. You need to use it first sendSmsCodesends a SMS verification code.
¶ parameter
param<LoginByPhoneCodeInput>param.phone<String> phone number;param.code<String> SMS verification code, you can pass sendSmsCode Method sends a SMS verification code;param.clientIp<String> The client is real IP. If you call this interface in the server, you must set this parameter as the real IP of the end user.param.context<String> Request context, set herecontextyou can get pipeline context.
¶ Example
String phone = "phone number";
String code = "1234";
User user = authenticationClient.loginByPhoneCode(new LoginByPhoneCodeInput(phone, code)).execute();
¶ Use the mobile phone number password to log in
authenticationClient.loginByPhonePassword(param)
If the user is bound to the phone number and set the password, you can log in to the phone number + password. If your userpool opens Login Failed Detection, when logging in the same IP multiple times, the user will be required to enter graphical verification code (error code is 2000).
¶ parameter
param<LoginByPhonePasswordInput>param.phone<String> phoneparam.password<String> passwordparam.captchaCode<String> Captchaparam.clientIp<String> The client is real IP. If you call this interface in the server, you must set this parameter as the real IP of the end user.param.context<String> Request context, set herecontextyou can get pipeline context.
¶ Example
String phone = "phone number";
String password = "123456";
User user = authenticationClient.loginByPhonePassword(new LoginByPhonePasswordInput(phone, password)).execute();
¶ Sub-account login
authenticationClient.loginBySubAccount(param)
If the user enables the sub-account login, you can use the sub-account to log in. If your user pool is opened login failed detection, When logins in the same IP will require the user to enter the graphic verification code (error code 2000).
¶ parameter
param<LoginBySubAccountParam>param.account<String> Child accountparam.password<String> passwordparam.captchaCode<String> Captchaparam.clientIp<String> The client is real IP. If you call this interface in the server, you must set this parameter as the real IP of the end user.
¶ Example
String account = "account number";
String password = "123456";
User user = authenticationClient.loginByPhonePassword(new LoginByPhonePasswordInput(account, password)).execute();
¶ Log in with an LDAP username
authenticationClient.loginByLdap(param)
Login with an account password using the LDAP identity source. If this account is logged in, it will import its user information into the user directory of the user pool; after logging in again, the user information of this account will be updated based on the latest account information obtained. Click here to view the Connection LDAP Original document.
¶ parameter
param<LoginByLdapParam>param.username<String> usernameparam.password<string> password
¶ Example
String username = "test";
String password = "test";
LoginByLdapParam loginByLdapParam = new LoginByLdapParam(username, password);
User user = authenticationClient.loginByLdap(loginByLdapParam).execute();
¶ Login with an AD username
authenticationClient.loginByAd(username, password)
Log in with an account using the AD domain. If this account is logged in, it will import its user information into the user directory of the user pool; after logging in again, the user information of this account will be updated based on the latest account information obtained. Click here to view Connection Active Directory Original Source.
¶ parameter
username<String> usernamepassword<String> password
¶ Example
String username = "test";
String password = "test";
User user = authenticationClient.loginByAd(username, password).execute();
¶ Get the user information of current login
authenticationClient.getCurrentUser()
Get the user information of the current login user, you need AuthenticationClient that is currently logged in to get it. You can set the login status of AuthenticationClient in two ways:
- After calling the login interface (such as password login, mobile phone number verification code login, social login), AuthenticationClient caches users id_token, to remember the login status;
- By user id_token initialization AuthenticationClient。
¶ Example
User user = authenticationClient.getCurrentUser().execute();
¶ Determine if you login
authenticationClient.checkLoggedIn()
Determine if you login
- After calling the login interface (such as password login, mobile phone number verification code login, social login), AuthenticationClient caches users. id_token, to remember the login status;
- By user id_token initialization AuthenticationClient。
- Determine if the user's login status has been cached.
¶ Example
Boolean b = authenticationClient.checkLoggedIn();
¶ sign out
authenticationClient.logout()
Used for users to quit login
- Empty the user's session session information under the current application;
- Use the user's current
id_tokenmarked as failed, use thisid_tokenCall Authing interface cannot get relevant data.
¶ Example
authenticationClient.logout().execute();
¶ Get custom data lists for current users
authenticationClient.listUdv()
Get the current user's custom data list requires users to log in first
¶ Example
authenticationClient.listUdv().execute();
¶ Add user custom data
authenticationClient.listUdv()
Adding a user-defined data requires a user to log in first?
¶ Example
authenticationClient.setUdv("key", "value").execute();
¶ Get list of data data in users
authenticationClient.listOrgs()
Get the list of organizations where the user is located is required to log in first
¶ Example
authenticationClient.listOrgs().execute();
¶ sending text verify code
authenticationClient.sendSmsCode(phone)
Send SMS verification code, currently only support domestic mobile phone number; this interface has interface frequency limitations, please do not request frequent frequent.
¶ parameter
phone<String>
¶ Example
String phone = "phone number";
authenticationClient.sendSmsCode(phone).execute();
¶ send email
authenticationClient.sendEmail(email, scene)
Actively send mail to users, currently supported 4 types of messages contain: reset password mail, verify mailbox email, modify mailbox verification code mail, MFA verification email. At the same time you canCustom email template and configuration third party mail service provider。
¶ parameter
email<String> emailscene<EmailScene> Send a scene, optional value is RESET_PASSWORD（send a reset password mail, including the verification code）、VERIFY_EMAIL（send verification mailbox）、CHANGE_EMAIL（send modification mailbox mail, including the verification code）RESET_PASSWORD: Send a reset password message, including the verification code;VERIFY_EMAIL: Send a message to verify the mailbox;CHANGE_EMAIL: Send a modified mailbox message, including the verification code;MFA_VERIFY: Send MFA verification email.
¶ Example
authenticationClient.sendEmail("test@example.com", EmailScene.RESET_PASSWORD).execute();
¶ Get custom data
authenticationClient.getUdfValue()
Get all custom data for the user. You need to be in the user poolDefine user-defined data meta information。
¶ Example
Map resu = authenticationClient.getUdfValue().execute();
¶ Set custom data
authenticationClient.setUdfValue(data)
Set the user's custom field. You need to be in the userpoolDefine user-defined data meta information, and the type of incoming value must match the defined type. If the setting fails, an exception will be thrown, you need to capture an exception.
¶ parameter
dataMap<String, String> Enter data, type as an object, please see the example for details.
¶ Example
Map<String, String> p = new HashMap();
p.put("dnum", "234");
List<UserDefinedData> result = this.authenticationClient.setUdfValue(p).execute();
¶ Delete custom data
authenticationClient.removeUdfValue(key)
Delete custom data.
¶ parameter
key<String> Custom field key .
¶ Example
List<UserDefinedData> result = this.authenticationClient.removeUdfValue("URF_KEY").execute();
¶ Detect Token login status
authenticationClient.checkLoginStatus()
¶ parameter
¶ Example
JwtTokenStatus status = authenticationClient.checkLoginStatus().execute();
¶ Sample data
- Successful example
{
"code": 200,
"message": "logged",
"status": true,
"exp": 1620732833,
"iat": 1619523233
}
- Failed example
{
"code": 2206,
"message": "Login information has expired",
"status": false,
"exp": null,
"iat": null
}
¶ Reset password via SMS verification code
authenticationClient.resetPasswordByPhoneCode(phone, code, newPassword)
Reset your password by SMS verification code, you can send SMS verification code by sendSmsCode method.
¶ parameter
phone<String> phonecode<String> Verification codenewPassword<String> New password
¶ Example
String phone = "phone number";
String code = "1234";
String password = "123456";
authenticationClient.resetPasswordByPhoneCode(phone, code, password).execute();
¶ Reset password via mail verification code
authenticationClient.resetPasswordByEmailCode(email, code, newPassword)
eset password by email verification code, you need to call sendEmail interface to send a reset password message（the scene value
RESET_PASSWORD）.
¶ parameter
email<String> Emailcode<String> Verification codenewPassword<String> New password
¶ Example
String email = "test@example.com";
String code = "1234";
String password = "123456";
authenticationClient.resetPasswordByEmailCode(email, code, password).execute();
¶ Modify user profile
authenticationClient.updateProfile(updates)
Modify user information, this interface cannot be used to modify the mobile phone number, email, password, if you need to call updatePhone、updateEmail、updatePassword.
¶ parameter
updates<UpdateUserInput> Modified user profileupdates.username<String> usernameupdates.nickname<String> nicknameupdates.photo<String> Avatarupdates.company<String> companyupdates.browser<String> browserupdates.device<String> deviceupdates.lastIP<String> Recently logged in IPupdates.name<String> Nameupdates.givenName<String> Given Nameupdates.familyName<String> Family Nameupdates.formatted<String> Addressupdates.middleName<String> Middle Nameupdates.profile<String> Profile Urlupdates.preferredUsername<String> Preferred Nameupdates.website<String> websiteupdates.gender<String> gender, M（Man）means male, F（Female）means famale, U（Unknown）means unknown.updates.birthdate<String> birthdateupdates.zoneinfo<String> Time zoneupdates.locale<String> Languageupdates.address<String> addressupdates.streetAddress<String> Street addressupdates.locality<String>updates.region<String> regionupdates.postalCode<String> postal codeupdates.city<String> cityupdates.province<String> provinceupdates.country<String> country
¶ Example
User user = authenticationClient.updateProfile(new UpdateUserInput().withNickname("nickname")).execute();
¶ Update user password
authenticationClient.updatePassword(newPassword, oldPassword)
Update user password
¶ parameter
newPassword<String> new passwordoldPassword<String> Old password, if the user does not set a password, you can not fill.
¶ Example
String oldPassword = "111111";
String newPassword = "123456";
User user = authenticationClient.updatePassword(newPassword, oldPassword).execute();
¶ Binding mobile phone number
authenticationClient.bindPhone(phone, phoneCode)
The user is bound to bind the mobile phone number, if you need to modify your mobile phone number, please use it updatePhone. If the phone number has been bound, it will be bound to fail. Send verification code, please use sendSmsCode.
Terminal users can alsoBind mobile phone number in personal center buffet：
¶ parameter
phone<String>phoneCode<String>
¶ Example
User user = authenticationClient.bindPhone("phone number", "1234").execute();
¶ Solution to the mobile number
authenticationClient.unbindPhone()
The user solves the mobile phone number. If the user does not bind other login mode (mailbox, social login account), it will not be able to decompose the mobile phone number, will prompt the error.
End users can also in the personal center self-service mobile phone number：
¶ Example
User user = authenticationClient.unbindPhone().execute();
¶ Update user mobile phone number
authenticationClient.updatePhone(phone, phoneCode, oldPhone, oldPhoneCode)
Update the user mobile phone number. As with the modification of the mailbox, by default, if the user is currently bound to the mobile phone number, you need to verify the original mobile phone number (current account binding mobile phone number) and the current mailbox (the mobile phone number to be bound). User A currently binding mobile phone number is 15888888888, want to modify to 1589999999, then you need to verify the two mobile phone numbers at the same time. Developers can also choose to "verify the original mobile number", you can turn of setting - security information in Authing console.
Users bind the mobile phone number for the first time, please use thebindPhone interface.
¶ parameter
phone<String> New mobile phone numberphoneCode<String> New mobile phone number verification codeoldPhone<String> Old mobile phone numberoldPhoneCode<String> Old mobile phone number verification code
¶ Example
User user = authenticationClient.updatePhone("phone number", "1234").execute();
¶ Binding mailbox
authenticationClient.bindEmail(email, emailCode)
Used for the user's first binding mailbox, you need to verify the mailbox verification code. If you need to modify the mailbox, please use itupdateEmail. If the mailbox has been bound, it will bind failed. Send an email verification code, please use sendEmail. Terminal users can alsoBinding mailbox in personal center buffet：
¶ parameter
email<String> EMailemailCode<String>Mail verification code, can passsendEmail method is obtained,EmailScene is CHANGE_EMAIL。
¶ Example
User user = authenticationClient.bindEmail("demo@authing.cn", "1234").execute();
¶ Menned mailbox
authenticationClient.unbindEmail()
The user solves the mobile phone number. If the user does not bind other login mode (mobile phone number, social login account), it will not be able to decompose the mailbox, will prompt the error.
End users can also in personal center self-help mailbox：
¶ Example
User user = authenticationClient.unbindEmail().execute();
¶ Update user mailbox
authenticationClient.updateEmail(email, emailCode, oldEmail, oldEmailCode)
AuthenticationClient().updateEmail(email, emailCode, oldEmail, oldEmailCode)If the user has bind the mailbox, by default, you need to verify the original mailbox (current account binding mailbox) and the current mailbox (the mailbox to be bound).User A The currently bound mailbox is 123456@qq.com, want to modify to 1234567@qq.com, then you need to verify these two mailboxes. Developers can also choose to "verify the original mailbox", you can turn off setting - Security Information in Authing console.
Users bind the mailbox for the first time please use bindEmail.
¶ parameter
email<String> new mail boxemailCode<String> New mailbox verification codeoldEmail<String> Old mailboxoldEmailCode<String> Old mailbox verification code
¶ Example
String newEmail = "new@example.com";
String emailCode = "1234"
User user = authenticationClient.updateEmail(newEmail, emailCode).execute();
¶ Bind social account
authenticationClient.linkAccount(primaryUserToken, secondaryUserToken)
Bind a social account (such as WeChat account, Github account) to a primary account (mobile number, email account).
¶ parameter
primaryUserToken<String> main account TokensecondaryUserToken<String> Social account Token
¶ Example
String primaryUserToken = "test";
String secondaryUserToken = "test";
authenticationClient.linkAccount(primaryUserToken, secondaryUserToken).execute();
¶ Solidning the social account
authenticationClient.unLinkAccount(options)
The primary account is tied to the socialized login account.
¶ parameter
options.primaryUserToken<String> Main account userid_token；options.provider<ProviderType> You can View all social login types supported here。
¶ Example
authenticationClient.unLinkAccount(
new UnLinkAccountParam("primaryUserToken", ProviderType.QQ)
)
¶ return value
{
"code": 200,
"data": true,
"message": "Binding success"
}
¶ Check password strength
authenticationClient.checkPasswordStrength(password)
Check password strength, click here to view details。
Determine if the password meets the password strength requirements. Authing middle code intensity level is divided into the following:
- Any non-empty string;
- At least 6 characters;
- At least 6 characters, and must contain two types in English, numbers and symbols;
- At least 6 characters, and the password must contain English, numbers and symbols.
¶ parameter
password<String> password
¶ Example
String password = "test";
CheckPasswordStrengthResult result = authenticationClient.checkPasswordStrength(password).execute();
¶ Calculate password security level
authenticationClient.computedPasswordSecurityLevel(password)
Calculate the password security level.
¶ parameter
password: The password (clear text format) that needs to be calculated must beStringtype;
¶ Example
PasswordSecurityLevel securityLevel = authenticationClient.computedPasswordSecurityLevel(
'xxxxxxxx'
)
¶ Get user account security level
authenticationClient.getSecurityLevel()
Get user account security level
¶ Example
SecurityLevel result = authenticationClient.getSecurityLevel().execute();
Assert.assertNotNull(result !=null);
¶ Get applications that current users can access
authenticationClient.listApplications(options)
Get the application that the current user can access.
¶ parameter
options<object>, Optionaloptions.page<number> Page serial number, default is1.options.limit<number> The number of times returned per page, the default is10
¶ Example
Pagination<ApplicationPublicDetail> resData = authenticationClient.listApplications({
page: 1,
limit: 10,
})
¶ Get all the list of users authorized to be authorized
authenticationClient.listAuthorizedResources(namespace)
Gets all resources authorized by users, and users are authorized to include resources that are inherited from roles, packets, and organizational institutions.
¶ parameter
namespace<String> Code of permission grouping, please seeUse rights group management privilege resources.
¶ Example
PaginatedAuthorizedResources res = authenticationClient.listAuthorizedResources(namespace).execute();
¶ Generate a PKCE check code
authenticationClient.listAuthorizedResources(namespace)
Generate a PKCE check code, the length must be greater than or equal to 43
¶ Example
String res = authenticationClient.generateCodeChallenge();
¶ Generate a PKCE check code summary value
authenticationClient.getCodeChallengeDigest(param)
Generate a PKCE check code summary value
¶ parameter
param<CodeChallengeDigestParam> PKCE check code, summary algorithm parametersparam.codeChallenge<String> The code_challenge original value of the abstract value is generated, and a random string having a length greater than or equal to 43.param.method<String> You can use the summary algorithm used when calculating code_challenge can be used for plain, S256. plain indicates that no algorithm is returned, S256 represents the use of SHA256 to calculate the code_challenge summary.
¶ Example
PaginatedAuthorizedResources res = authenticationClient.getCodeChallengeDigest(new CodeChallengeDigestParam("codeChallenge","S256")).execute();
¶ Judging whether the current user has a role
authenticationClient.hasRole(roleCode, namespace)
Judging whether the current user has a role
¶ parameter
roleCode<String> Role Codenamespace<String> Code of permission group, please see Use rights group management privilege resources.
¶ Example
Boolean res = authenticationClient.hasRole("roleCode", "default").execute();
¶ Determine if the user exists
authenticationClient.isUserExists(username, email, phone, externalId)
Determine if the user exists
¶ parameter
username<String> usernameemail<String> User mailboxphone<String> User mobile phone numberexternalId<String> Outside user Id
¶ Example
Boolean res = authenticationClient.isUserExists("username", "email", "phone", "externalId").execute();
¶ Get all user departments
authenticationClient.listDepartments()
Get all user departments
¶ Example
PaginatedDepartments res = authenticationClient.listDepartments().execute();
¶ Reset password through the first login Token
authenticationClient.resetPasswordByFirstLoginToken(token, password)
Reset password through the first login Token
¶ parameter
token<String> First login Tokenpassword<String> Reset password
¶ Example
Boolean res = authenticationClient.resetPasswordByFirstLoginToken("token", "password").execute();
¶ Force with temporary Token to change password by password
authenticationClient.resetPasswordByForceResetToken(token, oldPassword, newPassword)
Force with temporary Token to change password by password
¶ parameter
token<String> Temporary login TokenoldPassword<String> Cryptography before modifynewPassword<String> Reset password
¶ Example
Boolean res = authenticationClient.resetPasswordByForceResetToken("token", "password").execute();
¶ Detect whether the password is legal
authenticationClient.isPasswordValid(token, oldPassword, newPassword)
Detect whether the password is legal
¶ parameter
password<String> Checked password
¶ Example
CommonMessage res = authenticationClient.isPasswordValid("password").execute();
¶ SSO Detecting
authenticationClient.trackSession()
SSO Detecting
¶ Example
CommonMessage res = authenticationClient.trackSession().execute();
¶ Test CAS 1.0 Ticket legality
authenticationClient.validateTicketV1(ticket, service)
Test CAS 1.0 Ticket legality
¶ parameter
ticket<String> After the CAS certification is successful, Authing issued Ticket.service<String> CAS callback address
¶ Example
ValidateTicketV1Response res = authenticationClient.validateTicketV1("ticket", "service").execute();
¶ Verify ticket through remote service
authenticationClient.validateTicketV2(ticket, service)
Verify ticket through remote service
¶ parameter
ticket<String> After the CAS certification is successful, Authing issued Ticket.service<String> CAS callback addressformat<String> Return to the message formulation, support XML | JSON.
¶ Example
Sting res = authenticationClient.validateTicketV2("ticket", "service", "JSON").execute();