/auth

Previous/application/configuration Next/auth_scheme

Last updated 10 days ago

Creates a Session using OIDC

Begins a session by accepting a JWT. Upon successful validation against the scheme provided in the path, this will return a Session which can be used for authentication. If there is no User associated with the supplied credentials, this will implicitly create a new account and will include that account information in the response. If there is an account, or this method receives an existing session key, this will link to the existing scheme if the account was not previously linked.

post

/auth/oidc

Authorizations

Body

jwtanyrequired

The JWT to parse

profileIdany

The profile ID to assign to the session.

profileSelectorany

A query string to select the profile to use. NOTE: This will not be run if a profileId is specified.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'http://localhost:8080/api/rest/auth/oidc' \
  --header 'Authorization: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "jwt": null,
    "profileId": null,
    "profileSelector": null
  }'

400

401

403

404

409

500

501

503

default

{
  "code": "text",
  "message": "text"
}

Creates a Session using OAuth2

Begins a session by accepting a session request with parameters matching the specified OAuth2 Scheme. Upon successful validation against the scheme provided in the path, this will return a Session which can be used for authentication. If there is no User associated with the supplied credentials, this will implicitly create a new account and will include that account information in the response. If there is an account, or this method receives an existing session key, this will link to the existing scheme if the account was not previously linked.

post

/auth/oauth2