Read Linked Accounts
GET {{apiPath}}/environments/{{envID}}/users/{{userID}}/linkedAccounts
A linked account is the connection between a user and an external identity provider. To get the linked accounts associated with a single user resource, the GET /environments/{{envID}}/users/{{userID}}/linkedAccounts
operation returns the linked accounts for the user resource with the ID specified in the request URL.
This request supports the expand
filter parameter on the identityProviders
attribute so that you can see details about the external identity provider associated with each linked account.
Important: Users who authenticate with an authoritative identity provider cannot self-service read their linked accounts. Their user.identityProvider.id
attribute is not null
and their user.identityProvider.type
attribute is not PING_ONE
.
RESPONSES
status: OK
{"_links":{"self":{"href":"https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/b7b3bdd6-a3aa-423f-9921-7f8ce13003d0/linkedAccounts"}},"_embedded":{"linkedAccounts":[{"_links":{"self":{"href":"https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/b7b3bdd6-a3aa-423f-9921-7f8ce13003d0/linkedAccounts/92713768-50f5-4c7a-829f-865c4820d201"},"environment":{"href":"https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"},"user":{"href":"https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/b7b3bdd6-a3aa-423f-9921-7f8ce13003d0"}},"id":"92713768-50f5-4c7a-829f-865c4820d201","environment":{"id":"abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"},"user":{"id":"b7b3bdd6-a3aa-423f-9921-7f8ce13003d0"},"identityProvider":{"id":"550d3bdf-554b-4f9d-8825-ece15308673d"},"externalId":"127152908468744"}]},"count":1,"size":1}