User management

Intelligent Adaptive 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 APIClosed Provides the endpoints that are required for the successful completion of the operations..

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/{[email protected]}

View user View a specific user.

GET /users/{[email protected]}

Update user Update user details (e.g. email address, mobile phone number, MDCClosed Service that accepts one-time password (OTP) notifications and other messages from the authentication component. MDC interfaces with SMS, email, or push notification gateways to relay those messages to a user’s mobile device or email address. profile).

PATCH /users/{[email protected]}

Delete user Delete a user.

DELETE /users/{[email protected]}

Set user password Set the password for a user.

PATCH /users/{[email protected]}

Reset user password Reset the password for a user.

POST /users/{[email protected]}/reset-password

Unlock user Unlock a user.

POST /users/{[email protected]}/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/{[email protected]}

Set Virtual Mobile Authenticator delivery method Set user-specific Virtual Mobile AuthenticatorClosed A mechanism where an OTP is generated and sent to the user's mobile phone or email account. In this case, a physical authenticator is not needed. delivery method (the delivery method for Virtual Mobile Authenticator messages).

PATCH /users/{[email protected]}

Set Message Delivery Component (MDC) profile Set a user-specific Message Delivery Component (MDC)Closed Service that accepts one-time password (OTP) notifications and other messages from the authentication component. MDC interfaces with SMS, email, or push notification gateways to relay those messages to a user’s mobile device or email address. profile (i.e. the MDC profile to be used for Push Notification messages).

PATCH /users/{[email protected]}

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.