fieldsArray.<string>
+
+
+
+ List of fields to include or exclude
+ +include_fieldsboolean
+
+
+
+ true if the fields specified are to be included in the result, false otherwise. Default true
+ +include_totalsboolean
+
+
+
+ true if a query summary must be included in the result, false otherwise. Default false
+ +strategystring
+
+
+
+ Provide strategies to only retrieve connections with such strategies
+ +namestring
+
+
+
+ Provide the name of the connection to retrieve
+ +Options for the ManagementClient SDK. If a token is provided only the domain is required, other parameters are ignored. -If no token is provided domain, clientId, clientSecret (or clientAssertionSigningKey) -and scopes are required
+If no token is provided domain, clientId and clientSecret (or clientAssertionSigningKey) +are required. @@ -41804,7 +41804,7 @@Delete a user by its id.
+Creates an authentication method for a given user.
The user data object..
+The user data object.
@@ -2194,13 +2194,13 @@cbdatafunction
+object
@@ -2209,8 +2209,6 @@ Callback function
+Authentication method data.
Promise
-|
-
-undefined
-
-
- management.users.delete({ id: USER_ID }, function (err) {
- if (err) {
- // Handle error.
- }
-
- // User deleted.
-});Delete all users.
-| Name | - - -Type | - - -Attributes | - - - - -Description | -
|---|---|---|---|
|
- Callback function +Callback function. |
- Data object. +The user data object.. @@ -2638,32 +2473,6 @@Parameters:- - | ||
provider |
-
-
-
-
-
-string
-
-
-
- |
-
-
-
-
-
-
- Multifactor provider. - - |
-
var params = { id: USER_ID, provider: MULTIFACTOR_PROVIDER };
-
-management.users.deleteMultifactorProvider(params, function (err, user) {
+ management.users.delete({ id: USER_ID }, function (err) {
if (err) {
// Handle error.
}
- // Users accounts unlinked.
+ // User deleted.
});
Get a user by its id.
+Delete all users.
datacbobject
+function
@@ -2876,6 +2685,8 @@ The user data object.
+Callback function
- +| Name | - - -Type | - - - - - -Description | -
|---|---|---|
id |
-
-
-
-
-
-string
-
-
-
- |
-
-
-
-
-
-
- The user id. - - |
-
cbfunction
-
-
-
- Callback function.
- -management.users.get({ id: USER_ID }, function (err, user) {
- console.log(user);
+ management.users.deleteAll(function (err) {
+ if (err) {
+ // Handle error.
+ }
+
+ // Users deleted
});
Get all users.
+Deletes an authentication method by ID.
Users params.
+The user data object.
@@ -3167,8 +2893,6 @@per_pageidnumber
+string
The user id.
+authentication_method_idstring
+
+
+
+
+
Number of results per page.
+The authentication method id.
+ +pagedatanumber
+object
@@ -3232,8 +2980,6 @@ Page number, zero indexed.
- -Updated authentication method data.
@@ -3336,27 +3074,6 @@- This method takes an optional object as first argument that may be used to - specify pagination settings and the search query. If pagination options are - not present, the first page of a limited number of results will be returned. -
- -// Pagination settings.
-var params = {
- per_page: 10,
- page: 0
-};
-
-management.users.getAll(params, function (err, users) {
- console.log(users.length);
-});Get Users by an Email Address
+Deletes all authentication methods for the given user.
emailstring
-
-
-
- Email address of user(s) to find
- -optionsparamsAdditional options to pass to the endpoint
+The user data object.
@@ -3530,8 +3209,6 @@fieldsidComma-separated list of fields to include or exclude in the result
- -include_fieldsboolean
-
-
-
- Whether specified fields are to be included (true) or excluded (false). Defaults to true.
+The user id.
- This method takes a first argument as the Email address to look for - users, and uses the /users-by-email API, not the search API -
- -management.users.getByEmail('email@address', function (err, users) {
- console.log(users);
-});Get a list of Guardian enrollments.
+Delete a multifactor provider.
dataparamsThe user data object.
+Data object.
@@ -3883,6 +3500,32 @@providerstring
+
+
+
+ Multifactor provider.
+ +Callback function.
+Callback function
management.users.getGuardianEnrollments({ id: USER_ID }, function (err, enrollments) {
- console.log(enrollments);
+ var params = { id: USER_ID, provider: MULTIFACTOR_PROVIDER };
+
+management.users.deleteMultifactorProvider(params, function (err, user) {
+ if (err) {
+ // Handle error.
+ }
+
+ // Users accounts unlinked.
});
Given an access token get the user profile linked to it.
+Get a user by its id.
accessTokendatastring
+object
@@ -4099,7 +3748,58 @@ User access token.
+The user data object.
+ + + +| Name | + + +Type | + + + + + +Description | +
|---|---|---|
id |
+
+
+
+
+
+string
+
+
+
+ |
+
+
+
+
+
+
+ The user id. + + |
+
- Get the user information based on the Auth0 access token (obtained during - login). Find more information in the - API Docs. -
- -auth0.users.getInfo(accessToken, function (err, userInfo) {
- if (err) {
- // Handle error.
- }
-
- console.log(userInfo);
+ management.users.get({ id: USER_ID }, function (err, user) {
+ console.log(user);
});
Get a list of permissions for a user.
+Get all users.
dataparamsThe user data object.
+Users params.
@@ -4337,6 +4029,8 @@idper_pagestring
+number
The user id.
+Number of results per page.
+ +pagenumber
+
+
+
+ Page number, zero indexed.
management.users.getPermissions({ id: USER_ID }, function (err, permissions) {
- console.log(permissions);
+
+ This method takes an optional object as first argument that may be used to
+ specify pagination settings and the search query. If pagination options are
+ not present, the first page of a limited number of results will be returned.
+
+
+ // Pagination settings.
+var params = {
+ per_page: 10,
+ page: 0
+};
+
+management.users.getAll(params, function (err, users) {
+ console.log(users.length);
});
Get a list of roles for a user.
+Gets an authentication method by ID.
dataparamsauthentication_method_idstring
+
+
+
+ The authentication method id.
+ +management.users.getRoles({ id: USER_ID }, function (err, roles) {
- console.log(roles);
-});Get a list of organizations for a user.
+Gets a list of authentication methods.
dataparamsmanagement.users.getUserOrganizations({ id: USER_ID }, function (err, orgs) {
- console.log(orgs);
-});Impersonate the user with the given user ID.
+Get Users by an Email Address
userIdemailUser ID token.
+Email address of user(s) to find
settingsoptionsImpersonation settings.
+Additional options to pass to the endpoint
@@ -5180,41 +4944,7 @@impersonator_idstring
-
-
-
- Impersonator user ID.
- -protocolfieldsThe authentication protocol.
- -tokenstring
-
-
-
- API v1 token obtained for impersonation
+Comma-separated list of fields to include or exclude in the result
clientIdinclude_fieldsstring
+boolean
@@ -5309,7 +5007,7 @@ Client id used for impersonation. Uses the one supplied in the constructor by default.
+Whether specified fields are to be included (true) or excluded (false). Defaults to true.
- Gets a link that can be used once to log in as a specific user. Useful for - troubleshooting. Find more information in the - [API Docs](https://auth0.com/docs/auth-api#!#post--users--user_id--impersonate). + This method takes a first argument as the Email address to look for + users, and uses the /users-by-email API, not the search API
-var settings = {
- impersonator_id: '{IMPERSONATOR_ID}',
- protocol: 'oauth2',
- additionalParameters: {} // Optional additional params.
-};
-
-auth0.users.impersonate(userId, settings, function (err, link) {
- if (err) {
- // Handle error.
- }
-
- console.log(link);
+ management.users.getByEmail('email@address', function (err, users) {
+ console.log(users);
});
@@ -5433,14 +5120,14 @@ Example
- invalidateRememberBrowser(params, cbopt) → {Promise|undefined}
+ getGuardianEnrollments(data, cbopt) → {Promise|undefined}
- Invalidate all remembered browsers for MFA.
+ Get a list of Guardian enrollments.
@@ -5476,7 +5163,7 @@ Source:
Parameters:
- paramsdata
@@ -5685,12 +5372,8 @@ Returns:
Example
- management.users.invalidateRememberBrowser({ id: USER_ID }, function (err, result) {
- if (err) {
- // Handle error.
- }
-
- // Invalidated all remembered browsers.
+ management.users.getGuardianEnrollments({ id: USER_ID }, function (err, enrollments) {
+ console.log(enrollments);
});
@@ -5702,14 +5385,14 @@ Example
- link(userId, params, cbopt) → {Promise|undefined}
+ getInfo(accessToken, cbopt) → {Promise|undefined}
- Link the user with another account.
+ Given an access token get the user profile linked to it.
@@ -5745,7 +5428,7 @@ linkSource:
Parameters:
- userIdaccessToken
@@ -5816,7 +5499,7 @@ Parameters:
- ID of the primary user.
+ User access token.
@@ -5825,13 +5508,13 @@ Parameters:
- paramscb
-object
+function
@@ -5840,6 +5523,8 @@ Parameters:
+ <optional>
+
@@ -5850,111 +5535,221 @@ Parameters:
- Secondary user data.
+ Callback function.
-
+
+
-
-
-
-
- Name
-
+
+
+
- Type
-
-
- Description
-
-
-
-
-
-
- user_id
-
-
-string
-
-
-
-
-
- ID of the user to be linked.
-
-
-
-
-
-
- connection_idReturns:
-
-
-
-string
+
+
+ -
+ Type:
+
+ -
+
+
Promise
+|
-
-
+undefined
-
-
+
+
-
- ID of the connection to be used.
-
-
-
+
-
-
- provider
-
-
-string
+
+Example
-
-
+
+ Get the user information based on the Auth0 access token (obtained during
+ login). Find more information in the
+ API Docs.
+
+
+ auth0.users.getInfo(accessToken, function (err, userInfo) {
+ if (err) {
+ // Handle error.
+ }
-
+ console.log(userInfo);
+});
+
+
+
+
+
-
- Identity provider of the secondary user account being linked.
-
+
+
+ getPermissions(data, cbopt) → {Promise|undefined}
+
+
+
+
+
+
+ Get a list of permissions for a user.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ data
+
+
+object
+
+
+
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+ The user data object.
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
- link_withid
@@ -5971,7 +5766,7 @@ Parameters:
- JWT for the secondary account being linked. If sending this parameter, provider, user_id, and connection_id must not be sent.
+ The user id.
@@ -6066,18 +5861,8 @@ Returns:
Example
- var userId = 'USER_ID';
-var params = {
- user_id: 'OTHER_USER_ID',
- connection_id: 'CONNECTION_ID'
-};
-
-management.users.link(userId, params, function (err, user) {
- if (err) {
- // Handle error.
- }
-
- // Users linked.
+ management.users.getPermissions({ id: USER_ID }, function (err, permissions) {
+ console.log(permissions);
});
@@ -6089,14 +5874,14 @@ Example
- logs(params, cbopt) → {Promise|undefined}
+ getRoles(data, cbopt) → {Promise|undefined}
- Get user's log events.
+ Get a list of roles for a user.
@@ -6132,7 +5917,7 @@ logsSource:
Parameters:
- paramsdata
@@ -6203,7 +5988,7 @@ Parameters:
- Get logs data.
+ The user data object.
@@ -6246,33 +6031,15 @@ Parameters:
- User id.
+ The user id.
+
+
-
-
- per_page
-
-
-number
-
-
-
-
-
-
-
-
-
-
- Number of results per page.
@@ -6281,143 +6048,57 @@ Parameters:
- pagecb
-number
+function
-
-
-
-
- Page number, zero indexed.
+
-
-
-
-
-
-
-
- sort
-
+ <optional>
-string
+
-
-
-
+
+
- The field to use for sorting. Use field:order where order is 1 for ascending and -1 for descending. For example date:-1.
+ Callback function.
+
+
-
-
- include_totals
-
-
-boolean
-
-
-
-
-
- true if a query summary must be included in the result, false otherwise. Default false;
-
-
-
-
-
-
-
-
cbfunction
-
- Callback function.
- -var params = { id: USER_ID, page: 0, per_page: 50, sort: 'date:-1', include_totals: true };
-
-management.users.logs(params, function (err, logs) {
- if (err) {
- // Handle error.
- }
-
- console.log(logs);
+ management.users.getRoles({ id: USER_ID }, function (err, roles) {
+ console.log(roles);
});
Generate new Guardian recovery code.
+Get a list of organizations for a user.
paramsdataGet logs data.
+The user data object.
@@ -6621,7 +6296,7 @@User id.
+The user id.
management.users.regenerateRecoveryCode("USER_ID", function (err, result) {
- console.log(result.recovery_code);
+ management.users.getUserOrganizations({ id: USER_ID }, function (err, orgs) {
+ console.log(orgs);
});
Remove permissions from a user
+Impersonate the user with the given user ID.
paramsuserIdstring
+
+
+
+ User ID token.
+ +settingsparams object
+Impersonation settings.
@@ -6857,6 +6566,8 @@idimpersonator_iduser_id
-Impersonator user ID.
dataprotocolobject
+string
@@ -6928,33 +6639,50 @@ data object containing list of permission IDs
+The authentication protocol.
- +| Name | - + -Type | +|||
|---|---|---|---|---|
token |
+
-
+
+
+
+string
-
- | Description | -+ + + + + + | + + + + +
+ API v1 token obtained for impersonation + + |
+
-
permissions |
+ clientId |
@@ -6967,11 +6695,21 @@ Parameters: |
+
+
+ <optional> + + + + + + |
+
- Array of permission IDs +Client id used for impersonation. Uses the one supplied in the constructor by default. |
- params object +The user data object. @@ -7243,7 +6990,7 @@Parameters: |
- user_id +The user id. |
@@ -7260,13 +7007,13 @@
data |
+ cb |
-string
+function
@@ -7275,6 +7022,8 @@ Parameters: |
+ <optional> + @@ -7285,101 +7034,14 @@ Parameters: |
- data object containing list of role IDs +Callback function. - + |
+
| Name | - - -Type | - - - - - -Description | -
|---|---|---|
roles |
-
-
-
-
-
-string
-
-
-
- |
-
-
-
-
-
-
- Array of role IDs - - |
-
cbfunction
-
-
-
- Callback function.
- -var params = { id : 'USER_ID';
-var data = { "roles" : ["roleId1", "roleID2"]};
-
-management.users.removeRoles(params, data, function (err, user) {
+ management.users.invalidateRememberBrowser({ id: USER_ID }, function (err, result) {
if (err) {
// Handle error.
}
- // roles removed.
+ // Invalidated all remembered browsers.
});
Unlink the given accounts.
+Link the user with another account.
userIdstring
+
+
+
+ ID of the primary user.
+ +paramsLinked users data.
+Secondary user data.
@@ -7583,7 +7276,7 @@iduser_idPrimary user ID.
+ID of the user to be linked.
+ +connection_idstring
+
+
+
+ ID of the connection to be used.
Identity provider in use.
+Identity provider of the secondary user account being linked.
user_idlink_withSecondary user ID.
+JWT for the secondary account being linked. If sending this parameter, provider, user_id, and connection_id must not be sent.
var params = { id: USER_ID, provider: 'auht0', user_id: OTHER_USER_ID };
+ var userId = 'USER_ID';
+var params = {
+ user_id: 'OTHER_USER_ID',
+ connection_id: 'CONNECTION_ID'
+};
-management.users.unlink(params, function (err, user) {
+management.users.link(userId, params, function (err, user) {
if (err) {
// Handle error.
}
- // Users accounts unlinked.
+ // Users linked.
});
Update a user by its id.
+Get user's log events.
The user parameters.
+Get logs data.
@@ -7923,15 +7646,33 @@The user id.
+User id.
per_pagenumber
+
+
+
+ Number of results per page.
datapageobject
+number
Page number, zero indexed.
+sortstring
+
+
+
+ The field to use for sorting. Use field:order where order is 1 for ascending and -1 for descending. For example date:-1.
-include_totalsboolean
+
+
+
+ New user data.
+true if a query summary must be included in the result, false otherwise. Default false;
+ +Callback function
+Callback function.
var params = { id: USER_ID };
+ var params = { id: USER_ID, page: 0, per_page: 50, sort: 'date:-1', include_totals: true };
-management.users.update(params, data, function (err, user) {
+management.users.logs(params, function (err, logs) {
if (err) {
// Handle error.
}
- // Updated user.
- console.log(user);
+ console.log(logs);
});
Update the app metadata.
+Generate new Guardian recovery code.
The user data object..
+Get logs data.
@@ -8229,7 +8021,7 @@The user id.
+User id.
metadataobject
-
-
-
- New app metadata.
- -cbCallback function
+Callback function.
var params = { id: USER_ID };
-var metadata = {
- foo: 'bar'
-};
-
-management.users.updateAppMetadata(params, metadata, function (err, user) {
- if (err) {
- // Handle error.
- }
-
- // Updated user.
- console.log(user);
+ management.users.regenerateRecoveryCode("USER_ID", function (err, result) {
+ console.log(result.recovery_code);
});
Update the user metadata.
+Remove permissions from a user
The user data object..
+params object
@@ -8538,7 +8286,7 @@The user id.
+user_id
metadatadataNew user metadata.
+data object containing list of permission IDs
+ + + +| Name | + + +Type | + + + + + +Description | +
|---|---|---|
permissions |
+
+
+
+
+
+string
+
+
+
+ |
+
+
+
+
+
+
+ Array of permission IDs + + |
+
Callback function
+Callback function.
var params = { id: USER_ID };
-var metadata = {
- address: '123th Node.js Street'
-};
+ var params = { id : 'USER_ID';
+var data = { "permissions" : [{"permission_name" :"do:something" ,"resource_server_identifier" :"test123" }]};
-management.users.updateUserMetadata(params, metadata, function (err, user) {
+management.users.removePermissions(params, data, function (err, user) {
if (err) {
// Handle error.
}
- // Updated user.
- console.log(user);
+ // permissions removed.
});
Abstracts interaction with the users endpoint.
Remove roles from a user
+optionsparamsThe client options.
+params object
@@ -8837,8 +8614,6 @@baseUrliduser_id
-The URL of the API.
headersdataobject
+string
@@ -8900,8 +8675,6 @@ Headers to be included in all requests.
+data object containing list of role IDs
-| Name | + + +Type | + + + + + +Description | +||
|---|---|---|---|---|
retry |
+ roles |
-object
+string
|
-
-
- <optional> - - - - - - |
-
- Retry Policy Config +Array of role IDs |
cbfunction
+
+ Callback function.
+ +For CRUD on user's authenticators
-Promise
+|
-
+undefined
-
-
+ var params = { id : 'USER_ID';
+var data = { "roles" : ["roleId1", "roleID2"]};
-
+management.users.removeRoles(params, data, function (err, user) {
+ if (err) {
+ // Handle error.
+ }
-
+ // roles removed.
+});external:RestClient
-
-
- Provides an abstraction layer for retrieving Guardian enrollments.
+Unlink the given accounts.
external:RestClient
- | Name | + + +Type | - -||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
params |
+
+
+
+
+object
+
+ |
+
+
+
-
|
+
-
+
-
+
+ Linked users data. + + - +
|
+ ||||||||||||
cb |
+
+
+
+
+
+function
+
+
+
+ |
+
+
+
+
+ <optional> + + + + + + |
+
+
+
+
+
+ Callback function. + + |
+
Promise
+|
+
+undefined
+
+
+ var params = { id: USER_ID, provider: 'auht0', user_id: OTHER_USER_ID };
+
+management.users.unlink(params, function (err, user) {
+ if (err) {
+ // Handle error.
+ }
+
+ // Users accounts unlinked.
+});Update a user by its id.
+| Name | + + +Type | + + +Attributes | + + + + +Description | +||||||
|---|---|---|---|---|---|---|---|---|---|
params |
+
+
+
+
+
+object
+
+
+
+ |
+
+
+ + + + + + + | + + + + +
+ The user parameters. + + + +
|
+ ||||||
data |
+
+
+
+
+
+object
+
+
+
+ |
+
+
+ + + + + + + | + + + + +
+ New user data. + + |
+ ||||||
cb |
+
+
+
+
+
+function
+
+
+
+ |
+
+
+
+
+ <optional> + + + + + + |
+
+
+
+
+
+ Callback function + + |
+
Promise
+|
+
+undefined
+
+
+ var params = { id: USER_ID };
+
+management.users.update(params, data, function (err, user) {
+ if (err) {
+ // Handle error.
+ }
+
+ // Updated user.
+ console.log(user);
+});Update the app metadata.
+| Name | + + +Type | + + +Attributes | + + + + +Description | +||||||
|---|---|---|---|---|---|---|---|---|---|
params |
+
+
+
+
+
+object
+
+
+
+ |
+
+
+ + + + + + + | + + + + +
+ The user data object.. + + + +
|
+ ||||||
metadata |
+
+
+
+
+
+object
+
+
+
+ |
+
+
+ + + + + + + | + + + + +
+ New app metadata. + + |
+ ||||||
cb |
+
+
+
+
+
+function
+
+
+
+ |
+
+
+
+
+ <optional> + + + + + + |
+
+
+
+
+
+ Callback function + + |
+
Promise
+|
+
+undefined
+
+
+ var params = { id: USER_ID };
+var metadata = {
+ foo: 'bar'
+};
+
+management.users.updateAppMetadata(params, metadata, function (err, user) {
+ if (err) {
+ // Handle error.
+ }
+
+ // Updated user.
+ console.log(user);
+});Updates an authentication method.
+| Name | + + +Type | + + +Attributes | + + + + +Description | +|||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
params |
+
+
+
+
+
+object
+
+
+
+ |
+
+
+ + + + + + + | + + + + +
+ The user data object. + + + +
|
+ |||||||||
data |
+
+
+
+
+
+object
+
+
+
+ |
+
+
+ + + + + + + | + + + + +
+ Updated authentication method data. + + |
+ |||||||||
cb |
+
+
+
+
+
+function
+
+
+
+ |
+
+
+
+
+ <optional> + + + + + + |
+
+
+
+
+
+ Callback function. + + |
+
Promise
+|
+
+undefined
+
+
+ Updates all authentication methods for a user by replacing them with the given ones.
+| Name | + + +Type | + + +Attributes | + + + + +Description | +||||||
|---|---|---|---|---|---|---|---|---|---|
params |
+
+
+
+
+
+object
+
+
+
+ |
+
+
+ + + + + + + | + + + + +
+ The user data object. + + + +
|
+ ||||||
data |
+
+
+
+
+
+object
+
+
+
+ |
+
+
+ + + + + + + | + + + + +
+ Updated authentication method data. + + |
+ ||||||
cb |
+
+
+
+
+
+function
+
+
+
+ |
+
+
+
+
+ <optional> + + + + + + |
+
+
+
+
+
+ Callback function. + + |
+
Promise
+|
+
+undefined
+
+
+ Update the user metadata.
+| Name | + + +Type | + + +Attributes | + + + + +Description | +||||||
|---|---|---|---|---|---|---|---|---|---|
params |
+
+
+
+
+
+object
+
+
+
+ |
+
+
+ + + + + + + | + + + + +
+ The user data object.. + + + +
|
+ ||||||
metadata |
+
+
+
+
+
+object
+
+
+
+ |
+
+
+ + + + + + + | + + + + +
+ New user metadata. + + |
+ ||||||
cb |
+
+
+
+
+
+function
+
+
+
+ |
+
+
+
+
+ <optional> + + + + + + |
+
+
+
+
+
+ Callback function + + |
+
Promise
+|
+
+undefined
+
+
+ var params = { id: USER_ID };
+var metadata = {
+ address: '123th Node.js Street'
+};
+
+management.users.updateUserMetadata(params, metadata, function (err, user) {
+ if (err) {
+ // Handle error.
+ }
+
+ // Updated user.
+ console.log(user);
+});Abstracts interaction with the users endpoint.
| Name | + + +Type | + + + + + +Description | +||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
options |
+
+
+
+
+
+object
+
+
+
+ |
+
+
+
+
+
+
+ The client options. + + + +
|
+
For CRUD on user's authenticators
+external:RestClient
+
+
+ Provides an abstraction layer for retrieving Guardian enrollments.
+external:RestClient
+
+
+ Provides a simple abstraction layer for linking user accounts.
+external:RestClient
+
+
+ Provides an abstraction layer for invalidating all remembered browsers for MFA.
+external:RestClient
+
+
+ Provides an abstraction layer for consuming the +Multifactor Provider endpoint.
+external:RestClient
+
+
+ Provides an abstraction layer for CRD on permissions directly on a user
+external:RestClient
+
+
+ Provides an abstraction layer for regenerating Guardian recovery codes.
+external:RestClient
+
+
+ Provides an abstraction layer for CRD on roles for a user
+external:RestClient
+
+
+ Provides a simple abstraction layer for user logs
+external:RestClient
+
+
+ Provides an abstraction layer for the new "users-by-email" API
+external:RestClient
+
+
+ Assign permissions to a user
+| Name | + + +Type | + + +Attributes | + + + + +Description | +||||||
|---|---|---|---|---|---|---|---|---|---|
params |
+
+
+
+
+
+object
+
+
+
+ |
+
+
+ + + + + + + | + + + + +
+ params object + + + +
|
+ ||||||
data |
+
+
+
+
+
+string
+
+
+
+ |
+
+
+ + + + + + + | + + + + +
+ data object containing list of permissions + + + +
|
+ ||||||
cb |
+
+
+
+
+
+function
+
+
+
+ |
+
+
+
+
+ <optional> + + + + + + |
+
+
+
+
+
+ Callback function. + + |
+
Promise
+|
+
+undefined
+
+
+ var params = { id : 'USER_ID';
+var data = { "permissions" : [{"permission_name" :"do:something" ,"resource_server_identifier" :"test123" }]};
+
+management.users.assignPermissions(params, data, function (err, user) {
+ if (err) {
+ // Handle error.
+ }
+
+ // permissions added.
+});Assign roles to a user
+| Name | + + +Type | + + +Attributes | + + + + +Description | +||||||
|---|---|---|---|---|---|---|---|---|---|
params |
+
+
+
+
+
+object
+
+
+
+ |
+
+
+ + + + + + + | + + + + +
+ params object + + + +
|
+ ||||||
data |
+
+
+
+
+
+string
+
+
+
+ |
+
+
+ + + + + + + | + + + + +
+ data object containing list of role IDs + + + +
|
+ ||||||
cb |
+
+
+
+
+
+function
+
+
+
+ |
+
+
+
+
+ <optional> + + + + + + |
+
+
+
+
+
+ Callback function. + + |
+
Promise
+|
+
+undefined
+
+
+ var params = { id : 'USER_ID';
+var data = { "roles" : ["roleId1", "roleID2"]};
+
+management.users.assignRoles(params, data, function (err, user) {
+ if (err) {
+ // Handle error.
+ }
+
+ // roles added.
+});Create a new user.
+| Name | + + +Type | + + +Attributes | + + + + +Description | +
|---|---|---|---|
data |
+
+
+
+
+
+object
+
+
+
+ |
+
+
+ + + + + + + | + + + + +
+ User data. + + |
+
cb |
+
+
+
+
+
+function
+
+
+
+ |
+
+
+
+
+ <optional> + + + + + + |
+
+
+
+
+
+ Callback function. + + |
+
Promise
+|
+
+undefined
+
+
+ management.users.create(data, function (err) {
+ if (err) {
+ // Handle error.
+ }
+ // User created.
+});Provides an abstraction layer for invalidating all remembered browsers for MFA.
+Creates an authentication method for a given user.
| Name | + + +Type | + + +Attributes | + + + + +Description | +||||||
|---|---|---|---|---|---|---|---|---|---|
params |
+
+
+
+
+
+object
+
+
+
+ |
+
+
+ + + + + + + | + - + - +
+ The user data object. + + - +
|
+ ||||||
data |
-
+
+
+object
+
+ |
+
+ + + - + + | + - -
+ Authentication method data. + + |
+ ||||||
cb |
+
-
+
+
+function
+
+ |
+
+
+
+ <optional> + + -
|
+
-
+
-
+
+ Callback function. + + |
+
Promise
+|
- external:RestClient
+undefined
- Provides an abstraction layer for CRD on permissions directly on a user
+Delete a user by its id.
external:RestClient
-
- | Name | - -Type | -Attributes | + + +Description | +||||||
|---|---|---|---|---|---|---|---|---|---|
params |
+
-
+
+
+object
-
-
+
+ |
-
+
+ + - + - + + | + - + - +
+ The user data object.. + + - +
|
+ ||||||
cb |
+
+
+
+
+function
-
-
-
- roles :external:RestClient+ |
+
+
+
+ <optional> + + + + |
+
-
+ Callback function + + |
+
Promise
+|
-
+undefined
-
-
+ external:RestClient
-
-
- management.users.delete({ id: USER_ID }, function (err) {
+ if (err) {
+ // Handle error.
+ }
+ // User deleted.
+});Provides a simple abstraction layer for user logs
+Delete all users.
external:RestClient
- | Name | + - +Type | - -||
|---|---|---|---|
cb |
+
+
+
+
+function
+
+ |
+
+
+
+ <optional> + -
|
+
-
+
-
+
+ Callback function + + |
+
external:RestClient
+
+
+Promise
+|
+undefined
- management.users.deleteAll(function (err) {
+ if (err) {
+ // Handle error.
+ }
+
+ // Users deleted
+});Assign permissions to a user
+Deletes an authentication method by ID.
params object
+The user data object.
@@ -9907,30 +13590,261 @@user_id
+The user id.
+ +authentication_method_idstring
+
+
+
+ The authentication method id.
+ +dataobject
+
+
+
+ Updated authentication method data.
+ +cbfunction
+
+
+
+ Callback function.
Promise
+|
+
+undefined
+
+
+ Deletes all authentication methods for the given user.
+| Name | + + +Type | + + +Attributes | + + + - - -Description | + + +
|---|---|---|---|
data |
+ params |
-string
+object
@@ -9949,7 +13863,7 @@ Parameters: |
- data object containing list of permissions +The user data object. @@ -9975,7 +13889,7 @@Parameters: |
permissions |
+ id |
@@ -9992,7 +13906,7 @@ Parameters: |
- Array of permission IDs +The user id. |
- params object +Data object. @@ -10264,15 +14162,7 @@Parameters: |
- user_id - - |
-
-
-
-
The user id.
@@ -10281,58 +14171,7 @@datastring
-
-
-
- data object containing list of role IDs
- - - -| Name | - - -Type | - - - - - -Description | -||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
roles |
+ provider |
@@ -10349,7 +14188,7 @@ Parameters: |
- Array of role IDs +Multifactor provider. |
- Callback function. +Callback function |
@@ -10444,15 +14283,14 @@
- User data. +The user data object. + + + +
|
@@ -10665,12 +14554,8 @@
+ <optional> + @@ -10796,7 +14683,7 @@ Parameters: |
- The user data object.. +Users params. @@ -10810,6 +14697,8 @@Parameters: | Type | +Attributes | + @@ -10822,24 +14711,70 @@|||
id |
+ per_page |
-string
+number
|
+
+
+ <optional> + + + + + + |
+
- The user id. +Number of results per page. + + |
+ ||||||||
page |
+
+
+
+
+
+number
+
+
+
+ |
+
+
+
+
+ <optional> + + + + + + |
+
+
+
+
+
+ Page number, zero indexed. |
- Callback function +Callback function. |
@@ -10934,12 +14869,20 @@ ||||||||
params |
+
+
+
+
+
+object
+
+
+
+ |
+
+
+ + + + + + + | + + + + +
+ The user data object. + + + +
|
+ |||||||||
cb |
@@ -11069,7 +15121,7 @@
- Callback function +Callback function. |
- Data object. +The user data object. @@ -11300,32 +15339,6 @@Parameters:- - | ||||||||||
provider |
-
-
-
-
-
-string
-
-
-
- |
-
-
-
-
-
-
- Multifactor provider. - - |
-
Callback function
+Callback function.
var params = { id: USER_ID, provider: MULTIFACTOR_PROVIDER };
-
-management.users.deleteMultifactorProvider(params, function (err, user) {
- if (err) {
- // Handle error.
- }
-
- // Users accounts unlinked.
-});Get a user by its id.
+Get Users by an Email Address
| Name | + + +Type | + + +Attributes | + + + + +Description | +||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
email |
+
+
+
+
+
+string
+
+
+
+ |
+
+
+
+
+ <optional> + + + + + + |
+
-
+
-
+
+ Email address of user(s) to find + + |
+ ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
options |
+
+
+
+
+object
+
+ |
+
+
+
+ <optional> + + + + |
+
+
-
+ Additional options to pass to the endpoint + +
|