User Management Tasks
  • 15 Oct 2024
  • 1 Minute to read
  • Dark
    Light
  • PDF

User Management Tasks

  • Dark
    Light
  • PDF

Article summary

OneSpan Cloud Authentication supports the API-based administration of user management tasks. You can administrate users through the user-management interface of the OneSpan Trusted Identity platform API.

User management tasks

The user-management interface validates and returns the status of each operation upon completion. The interface handles the administration tasks with the relevant request endpoints and methods.

Supported user management requests  

Operation

Description

Request endpoint

Create user

PUT /users/{userID@domain}

View user

View a specific user.

GET /users/{userID@domain}

Update user

Update user details (e.g. email address, mobile phone number, MDC profile).

PATCH /users/{userID@domain}

Delete user

Delete a user.

DELETE /users/{userID@domain}

Set user password

Set the password for a user.

PATCH /users/{userID@domain}

Reset user password

Reset the password for a user.

POST /users/{userID@domain}/reset-password

Unlock user

Unlock a user.

POST /users/{userID@domain}/unlock

Query users

Retrieve all users that match certain query criteria (e.g. user, domain, locked status).

GET /users

Enable/disable user

Enable and disable a user.

PATCH /users/{userID@domain}

Set Virtual Mobile Authenticator delivery method

Set user-specific Virtual Mobile Authenticator delivery method (the delivery method for Virtual Mobile Authenticator messages).

PATCH /users/{userID@domain}

Set Message Delivery Component (MDC) profile

Set a user-specific Message Delivery Component (MDC) profile (i.e. the MDC profile to be used for Push Notification messages).

PATCH /users/{userID@domain}

User import

You can import users with a user import file. This task is not API-based but is done via the Administration Web Interface of the Authentication component.


Was this article helpful?

Changing your password will log you out immediately. Use the new password to log back in.
First name must have atleast 2 characters. Numbers and special characters are not allowed.
Last name must have atleast 1 characters. Numbers and special characters are not allowed.
Enter a valid email
Enter a valid password
Your profile has been successfully updated.
ESC

Ozzy, our interactive help assistant