Link a User Account

Link two user accounts together forming a primary and secondary relationship. On successful linking, the endpoint returns the new array of the primary account identities.

Note: There are two ways of invoking the endpoint:

• With the authenticated primary account’s JWT in the Authorization header, which has the update:current_user_identities scope:

  POST /api/v2/users/PRIMARY_ACCOUNT_USER_ID/identities
  Authorization: "Bearer PRIMARY_ACCOUNT_JWT"
  {
    "link_with": "SECONDARY_ACCOUNT_JWT"
  }
  

  In this case, only the link_with param is required in the body, which also contains the JWT obtained upon the secondary account’s authentication.

• With a token generated by the API V2 containing the update:users scope:

  POST /api/v2/users/PRIMARY_ACCOUNT_USER_ID/identities
  Authorization: "Bearer YOUR_API_V2_TOKEN"
  {
    "provider": "SECONDARY_ACCOUNT_PROVIDER",
    "connection_id": "SECONDARY_ACCOUNT_CONNECTION_ID(OPTIONAL)",
    "user_id": "SECONDARY_ACCOUNT_USER_ID"
  }
  

  In this case you need to send provider and user_id in the body. Optionally you can also send the connection_id param which is suitable for identifying a particular database connection for the ‘auth0’ provider.

POST https://{tenantDomain}/api/v2/users/{id}/identities

Go

Go

package example

import (
    context "context"

    client "github.com/auth0/go-auth0/management/management/client"
    option "github.com/auth0/go-auth0/management/management/option"
    users "github.com/auth0/go-auth0/management/management/users"
)

func do() {
    client := client.NewClient(
        option.WithToken(
            "<token>",
        ),
    )
    request := &users.LinkUserIdentityRequestContent{}
    client.Users.Identities.Link(
        context.TODO(),
        "id",
        request,
    )
}

201

[
  {
    "connection": "twitter",
    "user_id": "abc",
    "provider": "twitter",
    "profileData": {
      "email": "<string>",
      "email_verified": true,
      "name": "<string>",
      "username": "johndoe",
      "given_name": "<string>",
      "phone_number": "<string>",
      "phone_verified": true,
      "family_name": "<string>"
    },
    "isSocial": true,
    "access_token": "<string>",
    "access_token_secret": "<string>",
    "refresh_token": "<string>"
  }
]

Authorizations

bearerAuthoAuth2ClientCredentials

Authorization · string · header · required

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

Path Parameters

id · string · required

ID of the primary user account to link a second user account to.

Body

application/jsonapplication/x-www-form-urlencoded

provider · enum<string>

Identity provider of the secondary user account being linked.

Available options: ad, adfs, amazon, apple, dropbox, bitbucket, auth0-oidc, auth0, baidu, bitly, box, custom, daccount, dwolla, email, evernote-sandbox, evernote, exact, facebook, fitbit, github, google-apps, google-oauth2, instagram, ip, line, linkedin, oauth1, oauth2, office365, oidc, okta, paypal, paypal-sandbox, pingfederate, planningcenter, salesforce-community, salesforce-sandbox, salesforce, samlp, sharepoint, shopify, shop, sms, soundcloud, thirtysevensignals, twitter, untappd, vkontakte, waad, weibo, windowslive, wordpress, yahoo, yandex

connection_id · string

connection_id of the secondary user account being linked when more than one auth0 database provider exists.

Pattern: ^con_[A-Za-z0-9]{16}$

user_id · string integer · default: abc

user_id of the secondary user account being linked.

Minimum string length: 1

link_with · string · default: {SECONDARY_ACCOUNT_JWT}

JWT for the secondary account being linked. If sending this parameter, provider, user_id, and connection_id must not be sent.

Response

201

application/json

Identity successfully added.

connection · string · default: twitter · required

Connection name of this identity.

user_id · string integer · default: abc · required

user_id of this identity.

Minimum string length: 1

provider · string · default: twitter · required

Type of identity provider.

profileData · object

Show child attributes

isSocial · boolean

Whether the identity provider is a social provider (true) or not (false).

access_token · string

IDP access token returned if scope read:user_idp_tokens is defined.

access_token_secret · string

IDP access token secret returned only if scope read:user_idp_tokens is defined.

refresh_token · string

IDP refresh token returned only if scope read:user_idp_tokens is defined.