Update documentation on Link Users (#558)

auth0 · Dec 8, 2020 · 06304e0 · 06304e0
1 parent a21787a
commit 06304e0
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 0 deletions.
diff --git a/src/management/UsersManager.js b/src/management/UsersManager.js
@@ -505,6 +505,8 @@ UsersManager.prototype.deleteMultifactorProvider = function(params, cb) {
  * @param   {Object}    params                Secondary user data.
  * @param   {String}    params.user_id        ID of the user to be linked.
  * @param   {String}    params.connection_id  ID of the connection to be used.
+ * @param   {String}    params.provider       Identity provider of the secondary user account being linked.
+ * @param   {String}    params.link_with      JWT for the secondary account being linked. If sending this parameter, provider, user_id, and connection_id must not be sent.
  * @param   {Function}  [cb]                  Callback function.
  *
  * @return  {Promise|undefined}

diff --git a/src/management/index.js b/src/management/index.js
@@ -1316,6 +1316,8 @@ utils.wrapPropertyMethod(ManagementClient, 'unlinkUsers', 'users.unlink');
  * @param   {Object}    params                Secondary user data.
  * @param   {String}    params.user_id        ID of the user to be linked.
  * @param   {String}    params.connection_id  ID of the connection to be used.
+ * @param   {String}    params.provider       Identity provider of the secondary user account being linked.
+ * @param   {String}    params.link_with      JWT for the secondary account being linked. If sending this parameter, provider, user_id, and connection_id must not be sent.
  * @param   {Function}  [cb]                  Callback function.
  *
  * @return  {Promise|undefined}