Skip to main content
API docs by Redocly

Authn API (2.0.0)

Download OpenAPI specification:Download

Authn provides the main gateway into the SME Connect services. It provides a JWT that is used to authorize users for services such as Presence, Signal, and Graylog.

login

Logs into Authn Service

GET /login

The login process occurs once a user has a valid JWT token provided by either OAuth or ClientAuth services. When a user logs into SME Connect, the authn login endpoint will create a valid service session and return a session cookie to the user. This cookie is valid for a 2 hour window. The session cookie stores the user's credentials, which will then be used to authorize the user to interact with the JWT.

Authorizations:
bearerAuth
header Parameters
x-adapt-host
string
x-adapt-handler
string
x-adapt-url
string

Responses

Response samples

Content type
application/json
{
  • "session": {
    }
}

jwt

Gets a JWT

GET /jwt

The session cookie from the login endpoint is used to get a valid JWT. This token will then be used to authorize the user to interact with the SME Connect endpoints such as presence, signal, and graylog.

cookie Parameters
sess{Unique ID}
required
string
Example: sess{Unique ID}=sess38b9de00=12345678-9abc-4f44-9aba-773c5a9d3465

The session cookie from the Presence service

header Parameters
x-adapt-host
string
x-adapt-handler
string
x-adapt-url
string

Responses

Response samples

Content type
application/json
{
  • "session": {
    }
}

logout

Logs user out of Authn

GET /logout Logout will end a user's Authn session and expire their session cookie.

cookie Parameters
sess{Unique ID}
required
string
Example: sess{Unique ID}=sess38b9de00=12345678-9abc-4f44-9aba-773c5a9d3465

The session cookie from the Presence service

header Parameters
x-adapt-host
string
x-adapt-handler
string
x-adapt-url
string

Responses

Response samples

Content type
application/json
{
  • "status": 200
}