Skip to main content

Add link to an identity provider to an user

POST 
https://$CUSTOM-DOMAIN/v2/users/:userId/links

Add link to an identity provider to an user..

Request​

Path Parameters

    userId stringrequired

Body

required

    idpLink

    object

    idpId string

    Possible values: non-empty and <= 200 characters

    ID of the identity provider

    userId string

    Possible values: non-empty and <= 200 characters

    ID of the user of the identity provider

    userName string

    Possible values: non-empty and <= 200 characters

    username of the user of the identity provider

Responses​

OK

Schema

    details

    object

    sequence uint64

    on read: the sequence of the last event reduced by the projection

    on manipulation: the timestamp of the event(s) added by the manipulation

    changeDate date-time

    on read: the timestamp of the last event reduced by the projection

    on manipulation: the timestamp of the event(s) added by the manipulation

    resourceOwner resource_owner is the organization or instance_id an object belongs to (string)
    creationDate date-time
curl -L 'https://$CUSTOM-DOMAIN/v2/users/:userId/links' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
  "idpLink": {
    "idpId": "d654e6ba-70a3-48ef-a95d-37c8d8a7901a",
    "userId": "6516849804890468048461403518",
    "userName": "user@external.com"
  }
}'
Request Collapse all
Base URL
https://$CUSTOM-DOMAIN
Auth
Parameters
— pathrequired
Body required
{
  "idpLink": {
    "idpId": "d654e6ba-70a3-48ef-a95d-37c8d8a7901a",
    "userId": "6516849804890468048461403518",
    "userName": "user@external.com"
  }
}
ResponseClear

Click the Send API Request button above and see the response here!