authentication

OAuth2 authentication.

POST /auth/logout

Parameters

No parameters...

Endpoint

curl -X POST http://mgmt-node:8080/api/auth/logout
                

POST /auth/login

Parameters

grant_type
string
formData
optional
OAuth 2 grant type, must be set to "client_credentials" for this endpoint.

Endpoint

curl -X POST http://mgmt-node:8080/api/auth/login
                

Response 200

access_token
string
optional
Access token, should be handled as an opaque value as the format may change in the future.
token_type
string
optional
OAuth2 token type, always "bearer".
expires_in
number
optional
Duration in seconds.
roles
array
optional
All roles of the user the token is associated with.
userId
integer
optional
Internal id of the user this token is associated with.
passwordWasNeverChanged
boolean
optional
Set if the user never changed their password.

Example response

{
  "access_token": "string",
  "token_type": "string",
  "expires_in": 0,
  "roles": [
    "string"
  ],
  "userId": 0,
  "passwordWasNeverChanged": true
}
                  

POST /auth/login-form

Parameters

grant_type
string
formData
optional
OAuth 2 grant type, must be set to "password" for this endpoint.
username
string
formData
optional
User name of the croit or LDAP user.
password
string
formData
optional
Plaintext password.

Endpoint

curl -X POST http://mgmt-node:8080/api/auth/login-form
                

Response 200

access_token
string
optional
Access token, should be handled as an opaque value as the format may change in the future.
token_type
string
optional
OAuth2 token type, always "bearer".
expires_in
number
optional
Duration in seconds.
roles
array
optional
All roles of the user the token is associated with.
userId
integer
optional
Internal id of the user this token is associated with.
passwordWasNeverChanged
boolean
optional
Set if the user never changed their password.

Example response

{
  "access_token": "string",
  "token_type": "string",
  "expires_in": 0,
  "roles": [
    "string"
  ],
  "userId": 0,
  "passwordWasNeverChanged": true
}
                  

GET /auth/token-info

Parameters

No parameters...

Endpoint

curl -X GET http://mgmt-node:8080/api/auth/token-info
                

Response 200

username
string
optional
-
roles
array
optional
-
expiry
integer
optional
-

Example response

{
  "username": "string",
  "roles": [
    "string"
  ],
  "expiry": 0
}
                  

GET /auth/okta/signInConfig

Parameters

No parameters...

Endpoint

curl -X GET http://mgmt-node:8080/api/auth/okta/signInConfig
                

Response 200

baseUrl
string
optional
-
clientId
string
optional
-
issuer
string
optional
-
audience
string
optional
-
mapRoles
object
optional
-

Example response

{
  "baseUrl": "string",
  "clientId": "string",
  "issuer": "string",
  "audience": "string",
  "mapRoles": {}
}
                  

POST /auth/okta/login

Parameters

body
object
optional
-

Endpoint

curl -X POST http://mgmt-node:8080/api/auth/okta/login
                

Example body

{
  "idToken": "string"
}
                

Response 200

access_token
string
optional
Access token, should be handled as an opaque value as the format may change in the future.
token_type
string
optional
OAuth2 token type, always "bearer".
expires_in
number
optional
Duration in seconds.
roles
array
optional
All roles of the user the token is associated with.
userId
integer
optional
Internal id of the user this token is associated with.
passwordWasNeverChanged
boolean
optional
Set if the user never changed their password.

Example response

{
  "access_token": "string",
  "token_type": "string",
  "expires_in": 0,
  "roles": [
    "string"
  ],
  "userId": 0,
  "passwordWasNeverChanged": true
}