OMI Authentication API (v1.0)

Download OpenAPI specification:Download

API which is used to create a session in OneWelcome based on a previously authenticated nonce. This API is useful when building mobile applications which authenticates users using biometrics, such as fingerprint or face recognition. Once the user is authenticated inside the app, this API is used to issue tokens, so that different OneWelcome APIs can be called using the access token issued. This API is protected by a client id and a client secret, which represent the credentials of the oauth2 client previously registered and configured with the appropriate scopes.

omi-session

Requests for creating a session and tokens which can be later used to access APIs

Create session using an OMI session id

This endpoint is used to issue a session based on the user’s session at OMI. In case the request completes successfully, a success event is generated, named OMICreateSessionSuccessEvent. In case of failure, OMICreateSessionFailedEvent event is generated.

Request Body schema: application/x-www-form-urlencoded

client_id required	string OAuth2 client_id is a public identifier
client_secret required	string The client_secret is a secret known only to the application and the authorization server.
omi_session_id required	string Represents the OMI session id used to identify the browser/webserver session. The OMI session id is represented by the OMI nonce.
scope	string A scope is a set of rights to be assigned to the access token. The scopes should be defined at the oauth2 client level. If no scopes are requested, the default scopes configured on the oauth2 client will be assigned to the access token.

Responses

Response samples

Content type

application/json

{"ssoToken": "string",
"idToken": "string",
"accessToken": "string"
}