Merge pull request #514 from auth0/update-device-credentials-docs

Document user_id parameter for getDeviceCredentials API
auth0 · Jul 23, 2020 · c88afbd · c88afbd
2 parents bde5148 + 3a2a29e
commit c88afbd
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 2 deletions.
diff --git a/src/management/DeviceCredentialsManager.js b/src/management/DeviceCredentialsManager.js
@@ -88,10 +88,13 @@ utils.wrapPropertyMethod(DeviceCredentialsManager, 'createPublicKey', 'resource.
  * @memberOf  module:management.DeviceCredentialsManager.prototype
  *
  * @example
- * management.deviceCredentials.getAll(function (err, credentials) {
+ * var params = {user_id: "USER_ID"};
+ *
+ * management.deviceCredentials.getAll(params, function (err, credentials) {
  *   console.log(credentials.length);
  * });
  *
+ * @param   {Object}    params  Credential parameters.
  * @param   {Function}  [cb]    Callback function.
  *
  * @return  {Promise|undefined}

diff --git a/src/management/index.js b/src/management/index.js
@@ -791,10 +791,13 @@ utils.wrapPropertyMethod(
  * @memberOf  module:management.ManagementClient.prototype
  *
  * @example
- * management.getDeviceCredentials(function (err, credentials) {
+ * var params = {user_id: "USER_ID"};
+ *
+ * management.getDeviceCredentials(params, function (err, credentials) {
  *   console.log(credentials.length);
  * });
  *
+ * @param   {Object}    params  Credential parameters.
  * @param   {Function}  [cb]    Callback function.
  *
  * @return  {Promise|undefined}