Management API Reference - Node
Overview#
LoginIdManagement Constructor#
This server SDK can be used with a management application and requires an API credential to be assigned to that integration. All calls made from this SDK are intended to be backend-to-backend calls, as the operations are sensitive.
Credential Management Functions#
getCredentials#
Get an exhaustive list of credentials for a given user.
renameCredential#
Rename a given credential.
revokeCredential#
Revoke a credential so it can longer be used.
Code Related Functions#
generateCode#
Generate a code, which can be used for a variety of purposes. Check out the guides section for how various ways these codes can be used.
authorizeCode#
Authorize a code which was previously generated through the generateCode method.
waitCode#
Submit a code and wait for it to be authorized. You can use this method when leveraging the code to authenticate a user.
invalidateAllCodes#
Invalidate all codes of a given type for a specific user.
User Management Functions#
getUserId#
Get a user identifier for a given username.
deactivateUserById#
Temporarily deactivate a user account.
activateUserById#
Re-activate a previously deactivated user profile.
deleteUserById#
Deletes a user profile based on a userId as the input. This operation cannot be undone.
deleteUserByUsername#
Deletes a user profile based on a username as the input. This operation cannot be undone.
createUserWithoutCredentials#
Adds a new user without credentials. The new user can create new credentials with recovery flow