This endpoint is in preview and may be modified or removed at any time.
To use this endpoint, add preview=true to the request query parameters.
Replace the UserProviderInfo.
Third-party applications using this endpoint via OAuth2 must request the following operation scope: api:admin-write.
objectstringThe ID of the User in the external authentication provider. This value is determined by the authentication provider. At most one User can have a given provider ID in a given Realm.
objectThe replaced UserProviderInfo
stringThe ID of the User in the external authentication provider. This value is determined by the authentication provider. At most one User can have a given provider ID in a given Realm.
1
2
3
4
5
curl -X PUT \
-H "Content-type: application/json" \
-H "Authorization: Bearer $TOKEN" \
"https://$HOSTNAME/api/v2/admin/users/f05f8da4-b84c-4fca-9c77-8af0b13d11de/providerInfo?preview=true" \
-d '{"providerId":"2838c8f3-d76a-4e99-acf1-1dee537e4c48"}'1
2
3
{
"providerId": "2838c8f3-d76a-4e99-acf1-1dee537e4c48"
}| Error Name | ||
|---|---|---|
Get | Error Code | PERMISSION_DENIED |
| Status Code | 403 | |
| Description | The provided token does not have permission to view the provider information for the given user. | |
| Parameters | userId | |
Cannot | Error Code | INVALID_ARGUMENT |
| Status Code | 400 | |
| Description | Provider information for Principals in this Realm cannot be replaced. | |
| Parameters | principalId, realm | |
Replace | Error Code | PERMISSION_DENIED |
| Status Code | 403 | |
| Description | Could not replace the UserProviderInfo. | |
| Parameters | userId | |
User | Error Code | NOT_FOUND |
| Status Code | 404 | |
| Description | The given User could not be found. | |
| Parameters | userId | |
User | Error Code | NOT_FOUND |
| Status Code | 404 | |
| Description | The given UserProviderInfo could not be found. | |
| Parameters | userId | |
See Errors for a general overview of errors in the platform.