Linked accounts
The linked accounts endpoints manage a user’s account links to external identity provider accounts. In an authentication flow, after successful authentication at the external identity provider, a linked account resource is created to establish the connection between the user resource in the PingOne directory and that user’s external identity provider account. These endpoints can also be used to view and remove linked accounts in delegated administration or self-service cases.
|
Users who authenticate with an authoritative identity provider cannot self-service their linked accounts. These users have the |
Users linked accounts request data model
| Property | Type | Required | Mutable | Description |
|---|---|---|---|---|
|
Object |
Optional |
Mutable |
An optional user attribute to update when linking the user. These are mapped user attribute names and values from the external identity provider that are used to update the user. |
|
String |
Required |
Mutable |
The identifier for the user’s external identity provider account. Supported only for OIDC or SAML external identity providers. The connection to the external identity provider must be established prior to linking the account. |
|
String |
Required |
Mutable |
The external identity provider ID associated with the user to which the user has a linked account. |
Users linked accounts response data model
| Property | Type | Required | Mutable | Description |
|---|---|---|---|---|
|
String |
Required |
Read-only |
The environment associated with the user’s linked account. |
|
String |
Required |
Read-only |
The identifier for the user’s external identity provider account. |
|
String |
Required |
Read-only |
The linked account ID associated with the user resource ID identified in the request URL. |
|
String |
Required |
Read-only |
The external identity provider ID associated with the user, and to which the user has a linked account. |
|
Object |
Required |
Read-only |
An |
|
String |
Required |
Read-only |
The user ID associated with the linked account. |
Response codes
| Code | Message |
|---|---|
200 |
Successful operation. |
204 |
Successfully removed. No content. |
400 |
The request could not be completed. |
401 |
You do not have access to this resource. |
404 |
The requested resource was not found. |
Linked account errors
In addition to the general error codes, linked account operations can return the following errors:
| HTTP status | Top‑level code | Detail code | When it happens and what the response contains |
|---|---|---|---|
400 |
|
|
Message: When and detailsWhen: A Details: Describes the failing property. |
400 |
|
|
Message: When and detailsWhen: A Details: |
400 |
|
|
Message: When and detailsWhen: A Details: |
400 |
|
|
Message: When and detailsWhen: A Details: |
400 |
|
|
Message: When and detailsWhen: A Details: |
400 |
|
|
Message: When and detailsWhen: A Details: |
400 |
|
|
Message: When and detailsWhen: A Details: |
400 |
|
|
Message: When and detailsWhen: A request body cannot be deserialized as JSON Details: For a JSON field conversion error, the detail is |
400 |
|
None |
Message: When and detailsWhen: A path identifier cannot be parsed as a UUID Details: None. |
403 |
|
None |
Message: When and detailsWhen: The actor lacks the Details: None. |
404 |
|
None |
Message: When and detailsWhen: The user ID, environment ID, or linked account ID in the request URL does not exist Details: None. |
500 |
|
None |
Message: When and detailsWhen: A Details: None. |
For linked accounts endpoint operations, you need the Identity Data Admin role to get or delete linked account resources.