1. Development Integration
  2. /
  3. SDK
  4. /
  5. Java
  6. /

  7. User authentication module

  8. /

  9. User information

  10. /
  11. Bind email

Bind Email

Update time: 2025-07-23 07:34:21
Edit

This document is automatically generated based on https://github.com/authing/authing-docs-factory based on https://api-explorer.genauth.ai V3 API, and is consistent with API parameters and return results. If the document description is incorrect, please refer to V3 API.

If the user has not bound an email yet, this interface can be used for the user to self-bind an email. If the user has already bound an email and wants to modify the email, please use the Modify Email interface. You need to call the Send Email interface to send the email verification code first.

Method Name

AuthenticationClient.bindEmail

Request Parameters

NameType
Is it required
Default Value
Description
Example Value
passCodestringYes-Email verification code. An email verification code can only be used once and has a certain validity period.123456
emailstringYes-Email, not case sensitive.test@example.com

Sample Code

package test.authentication;

import cn.authing.sdk.java.client.AuthenticationClient;
import cn.authing.sdk.java.dto.BindEmailDto;
import cn.authing.sdk.java.dto.CommonResponseDto;
import cn.authing.sdk.java.model.AuthenticationClientOptions;
import cn.authing.sdk.java.util.JsonUtils;

public class BindEmailTest {
    // Need to be replaced with your GenAuth App ID
    private static final String APP_ID = "AUTHING_APP_ID";
    // Need to be replaced with your GenAuth App Secret
    private static final String APP_SECRET = "AUTHING_APP_SECRET";
    // Need to be replaced with your GenAuth App Host
    private static final String APP_HOST = "AUTHING_APP_HOST";
    // Need to be replaced with your GenAuth Access Token
    private static final String ACCESS_TOKEN = "AUTHING_ACCESS_TOKEN";

    public static void main(String[] args) throws Throwable {
        AuthenticationClientOptions clientOptions = new AuthenticationClientOptions();
        clientOptions.setAppId(APP_ID);
        clientOptions.setAppSecret(APP_SECRET);
        clientOptions.setAppHost(APP_HOST);
        clientOptions.setAccessToken(ACCESS_TOKEN);

        AuthenticationClient client = new AuthenticationClient(clientOptions);

        BindEmailDto reqDto = new BindEmailDto();
        reqDto.setEmail("123@qq.com");
        reqDto.setPassCode("123");
        CommonResponseDto response = client.bindEmail(reqDto);
        System.out.println(JsonUtils.serialize(response));
    }
}

Request Response

Type: CommonResponseDto

NameTypeDescription
statusCodenumberBusiness status code. You can use this status code to determine whether the operation is successful. 200 means success.
messagestringDescription
apiCodenumberSegmented error code, through which the specific error type can be obtained (not returned for successful requests). For a detailed list of error codes, see: API Code List (opens new window)
requestIdstringRequest ID. Returned when the request fails.

Example Results：

{
  "statusCode": 200,
  "message": "Operation successful",
  "requestId": "934108e5-9fbf-4d24-8da1-c330328abd6c"
}

Data Structure