Enable or disable a federated identity link for a user.

Creates or removes a Keycloak federated identity link between the user and the tenant IDP. Fully idempotent.

PATCH /users/{username}/idp-link

Enable or disable a federated identity link for a user.

cURL

curl --request PATCH \
  --url https://test.didxtech.com/consumer-onboarding/api/users/{username}/idp-link \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "enabled": true
}
'

200

{
  "data": {
    "username": "johndoe",
    "idpAlias": "acme-idp",
    "linked": true
  },
  "links": {
    "self": "<string>",
    "first": "<string>",
    "last": "<string>",
    "prev": "<string>",
    "next": "<string>",
    "related": "<string>"
  },
  "meta": {},
  "errors": [
    {
      "detail": "<string>",
      "id": "<string>",
      "status": "<string>",
      "code": "<string>",
      "title": "<string>",
      "source": {
        "pointer": "<string>",
        "parameter": "<string>"
      },
      "meta": {}
    }
  ]
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

username · string · required

Body

application/json

Enable or disable a federated identity link for a user.

enabled · boolean · required

Response

200

application/json

IDP link updated successfully.

data · object · required

Show child attributes

Example:

{
  "username": "johndoe",
  "idpAlias": "acme-idp",
  "linked": true
}

links · object

Show child attributes

meta · object

Show child attributes

errors · object[]

Show child attributes