Get the bound external identity source

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.

As described in the Introduction section, an external identity source corresponds to multiple external identity source connections. After a user binds an external identity source account through an external identity source connection, the user will establish an association relationship with this external identity source. This interface is used to obtain all external identity sources bound to this user.

Depending on the specific implementation of the external identity source, a user may have multiple identity IDs in the external identity source, such as openid and unionid in the WeChat system, and open_id, union_id and user_id in non-books. In GenAuth, we call such an open_id or unionid_ an Identity, so a user will have multiple Identity records in one identity source.

Taking WeChat as an example, if a user logs in with WeChat or binds a WeChat account, his Identity information is as follows:

[
  {
    "identityId": "62f20932xxxxbcc10d966ee5",
    "extIdpId": "62f209327xxxxcc10d966ee5",
    "provider": "wechat",
    "type": "openid",
    "userIdInIdp": "oH_5k5SflrwjGvk7wqpoBKq_cc6M",
    "originConnIds": ["62f2093244fa5cb19ff21ed3"]
  },
  {
    "identityId": "62f726239xxxxe3285d21c93",
    "extIdpId": "62f209327xxxxcc10d966ee5",
    "provider": "wechat",
    "type": "unionid",
    "userIdInIdp": "o9Nka5ibU-lUGQaeAHqu0nOZyJg0",
    "originConnIds": ["62f2093244fa5cb19ff21ed3"]
  }
]

You can see that their extIdpId is the same, which is the identity source ID you created in GenAuth; provider is wechat; type can be used to distinguish which is openid and which is unionid, as well as the specific value (userIdInIdp); they all come from the same identity source connection (originConnIds).

Method name

AuthenticationClient.get_identities

Request parameters

Name	Type	Required	Default value	Description	Sample value

Request response

Type: GetIdentitiesRespDto

Name	Type	Description
message	string	Description
apiCode	number	Segmented error code, which can be used to get the specific error type. For a detailed list of error codes, see: API Code List
requestId	string	Request ID. Returned when the request fails.
data	array	User's identity source list

Sample result:

{
  "statusCode": 200,
  "message": "Operation successful",
  "requestId": "934108e5-9fbf-4d24-8da1-c330328abd6c",
  "data": {
    "identityId": "62299d8b866d2dab79a89dc4",
    "extIdpId": "6076bacxxxxxxxxd80d993b5",
    "provider": "wechat",
    "type": "openid",
    "userIdInIdp": "oj7Nq05R-RRaqak0_YlMLnnIwsvg",
    "accessToken": "57_fK0xgSL_NwVlS-gmUwlMQ2N6AONNIOAYxxxx",
    "refreshToken": "57_IZFu91Ak1Wg6DRytZFFIOd3upNF5lH7vPxxxxx",
    "originConnIds": "[\"605492ac41xxxxe0362f0707\"]"
  }
}

Data structure

IdentityDto

Name	Type	Is it required?	Description	Sample value
identityId	string	yes	Identity source ID	62299d8b866d2dab79a89dc4
extIdpId	string	yes	Identity source connection ID	6076bacxxxxxxxxd80d993b5
provider	string	yes	External identity source type: - wechat: WeChat - qq: QQ - wechatwork: WeChat for Business - dingtalk: DingTalk - weibo: Weibo - github: GitHub - alipay: Alipay - baidu: Baidu - lark: Feishu - welink: Welink - yidun: NetEase Yidun - qingcloud: Qingyun - google: Google - gitlab: GitLab - gitee: Gitee - twitter: Twitter - facebook: Facebook - slack: Slack - linkedin: Linkedin - instagram: Instagram - oidc: OIDC-type enterprise identity source - oauth2: OAuth2-type enterprise identity source - saml: SAML-type enterprise identity source - ldap: LDAP-type enterprise identity source - ad: AD-type enterprise identity source - cas: CAS-type enterprise identity source - azure-ad: Azure AD-type enterprise identity source	oidc
type	string	yes	Identity type, such as unionid, openid, primary	openid
userIdInIdp	string	yes	ID in the external identity source	oj7Nq05R-RRaqak0_YlMLnnIwsvg
userInfoInIdp	object	yes	User's identity information in idp
accessToken	string	no	Access Token in the external identity source (this parameter is only returned when the user actively obtains it, and the management side interface will not return it).	57_fK0xgSL_NwVlS-gmUwlMQ2N6AONNIOAYxxxx
refreshToken	string	no	Refresh Token in the external identity source (this parameter is only returned when the user actively obtains it, and the management side interface will not return it).	57_IZFu91Ak1Wg6DRytZFFIOd3upNF5lH7vPxxxxx
originConnIds	array	yes	List of identity origin connection IDs that the identity came from	["605492ac41xxxxe0362f0707"]