¶ Get user real-name authentication information

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

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 this document description is incorrect, please refer to V3 API.

Get user real-name authentication information through user ID, and you can choose to specify the user ID type.

¶ Method name

ManagementClient.get_user_principal_authentication_info

¶ Request parameters

Name	Type	Required	Default value	Description	Sample value
userId	string	yes	-	The unique identifier of the user, which can be user ID, user name, email, phone number, externalId, or ID in an 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`

¶ Request Response

Type: PrincipalAuthenticationInfoPaginatedRespDto

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 request does not return). For a detailed list of error codes, see: API Code List (opens new window)
requestId	string	Request ID. Returned when the request fails.
data	PrincipalAuthenticationInfoPagingDto	Response data

Example results:

{
  "statusCode": 200,
  "message": "Success",
  "requestId": "934108e5-9fbf-4d24-8da1-c330328abd6c",
  "data": {
    "list": {
      "authenticated": true,
      "principalType": "Certification subject type, P represents individual, E represents enterprise",
      "principalCode": "6229c4deb3e4d8a20b6021ff",
      "principalName": "ss",
      "authenticatedAt": "2022-04-05T10:23:50.631Z"
    }
  }
}

¶ Data Structure

¶ PrincipalAuthenticationInfoPagingDto

Name	Type	Is it required?	Description	Sample value
totalCount	number	Yes	Total number of records
list	array	Yes	Response data Nested type: PrincipalAuthenticationInfoDto.

¶ PrincipalAuthenticationInfoDto

Name	Type	Is it required?	Description	Sample value
authenticated	boolean	yes	Whether to authenticate	`true`
principalType	string	yes	User ID	`Authentication principal type, P stands for individual, E stands for enterprise`
principalCode	string	yes	Authentication principal certificate number	`6229c4deb3e4d8a20b6021ff`
principalName	string	yes	Authentication principal name	`ss`
authenticatedAt	string	yes	Certification time, standard time string	`2022-04-05T10:23:50.631Z`

Previous article: Get User Role List Next article: Delete User Real-name Authentication Info