¶ Get the identity source that the user has logged in

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

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

Use the user ID to get the identity source that the user has logged in. You can choose to specify the user ID type, etc.

¶ Method Name

ManagementClient.getUserLoggedinIdentities

¶ Request Parameters

Name	Type	Is it required	Default Value	Description	Example Value
userId	string	Yes	-	The unique identifier of the user. It can be Yes user ID, user name, email address, mobile phone number, externalId, or ID in the external identity source. For details, see the description of the userIdType field. The default is user id.	`6229ffaxxxxxxxxcade3e3d9`
userIdType	string	No	user_id	User id type, the default value is `user_id`, the optional values are: - `user_id`: GenAuth user ID, such as `6319a1504f3xxxxf214dd5b7` - `phone`: user phone number - `email`: user email - `username`: user name - `external_id`: user ID in the external system, corresponding to the `externalId` field of GenAuth user information - `identity`: user's external identity source information, the format is `<extIdpId>:<userIdInIdp>`, where `<extIdpId>` is the ID of the GenAuth identity source, and `<userIdInIdp>` is the ID of the user in the external identity source. Example Value: `62f20932716fbcc10d966ee5:ou_8bae746eac07cd2564654140d2a9ac61`. - `sync_relation`: The user's external identity source information, in the format of `<provier>:<userIdInIdp>`, where `<provier>` is the synchronization identity source type, such as wechatwork, lark; `<userIdInIdp>` is the user's ID in the external identity source. Example Value: `lark:ou_8bae746eac07cd2564654140d2a9ac61`.	`user_id`

¶ Sample Code

package test.management;

import cn.authing.sdk.java.client.ManagementClient;
import cn.authing.sdk.java.dto.GetUserLoggedInIdentitiesDto;
import cn.authing.sdk.java.dto.UserLoggedInIdentitiesRespDto;
import cn.authing.sdk.java.model.ManagementClientOptions;
import cn.authing.sdk.java.util.JsonUtils;

public class GetUserLoggedinIdentitiesTest {
    // Need to be replaced with your GenAuth Access Key ID
    private static final String ACCESS_KEY_ID = "AUTHING_ACCESS_KEY_ID";
    // Need to be replaced with your GenAuth Access Key Secret
    private static final String ACCESS_KEY_SECRET = "AUTHING_ACCESS_KEY_SECRET";

    public static void main(String[] args) throws Throwable {
        ManagementClientOptions clientOptions = new ManagementClientOptions();
        clientOptions.setAccessKeyId(ACCESS_KEY_ID);
        clientOptions.setAccessKeySecret(ACCESS_KEY_SECRET);
        // If you are a private deployment customer, you need to set the GenAuth service domain name
        // clientOptions.setHost("https://api.your-authing-service.com");

        ManagementClient client = new ManagementClient(clientOptions);

        GetUserLoggedInIdentitiesDto reqDto = new GetUserLoggedInIdentitiesDto();
        reqDto.setUserId("6229ffaxxxxxxxxcade3e3d9");
        UserLoggedInIdentitiesRespDto response = client.getUserLoggedinIdentities(reqDto);
        System.out.println(JsonUtils.serialize(response));
    }
}

¶ Request Response

Type： UserLoggedInIdentitiesRespDto

Name	Type	Description
statusCode	number	Business status code, which can be used to determine whether the operation is successful. 200 means success.
message	string	Description
apiCode	number	Segmented error code, which can be used to get the specific error type (successful requests are not returned). For a detailed list of error codes, see: API Code List (opens new window)
requestId	string	Request ID. Returned when the request fails.
data	array	Response data

Example Results：

{
  "statusCode": 200,
  "message": "Operation successful",
  "requestId": "934108e5-9fbf-4d24-8da1-c330328abd6c",
  "data": {
    "identityId": "62299d8b866d2dab79a89dc4",
    "idpName": "wx",
    "idpNameEn": "wechat",
    "idpLogo": "https://example.com/logo.png",
    "idpId": "62299d8b866d2dab79a89dc4"
  }
}

¶ Data Structure

¶ UserLoggedInIdentitiesDto

Name	Type	Is it required	Description	Example Value
identityId	string	Yes	Identity ID	`62299d8b866d2dab79a89dc4`
idpName	string	Yes	Identity provider name	`xx`
idpNameEn	string	Yes	Identity provider name	`wechat`
idpLogo	string	Yes	Identity provider logo	`https://example.com/logo.png`
idpId	string	Yes	Identity provider id	`62299d8b866d2dab79a89dc4`

Previous article: Get the application that the user has logged in to Next article: User resignation