User authentication is carried out on the API Server for each API project.
Running an API method requires prior authentication on an API project. If the API method is marked as AllowUnauthenticated, authentication is not required (you can find an example in the SDK)
Authentication has two steps:
-
Required primary authentication: Default authentication through an authentication module
-
Optional secondary authentication: Multi-factor authentication (for example, using Starling 2FA)
Related topics
You can use the imx/login/<API project name> API method for primary authentication on the API project.
To do this, use the POST HTTP method to send the following query:
{ "Module": "RoleBasedPerson", "User": "<user name>", "Password": "<password>" }
TIP: See our SDK for examples.
Related topics
Secondary authentication on the API project using Starling 2FA uses the following methods:
- Login/authentication using push notifications: starling/send/push
- Login/authentication using SMS messages: starling/send/sms
- Login/authentication using phone calls: starling/send/call
Related topics
You can use the imx/logout/<API project name> API method to log out of the API project.
Related topics