/auth

Creates a Session using OIDC

post

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.

Authorizations

auth_bearersession_secret

Body

jwtanyRequired

The JWT to parse

profileIdanyOptional

The profile ID to assign to the session.

profileSelectoranyOptional

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

Responses

400Error

application/json

401Error

application/json

403Error

application/json

404Error

application/json

409Error

application/json

500Error

application/json

501Error

application/json

503Error

application/json

default

default response

application/json

post

HTTPcURLJavaScriptPython

POST /api/rest/auth/oidc HTTP/1.1
Host: localhost:8080
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 52

{
  "jwt": null,
  "profileId": null,
  "profileSelector": null
}

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

Creates a Session using OAuth2

post

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.

Authorizations

auth_bearersession_secret

Body

schemeIdanyRequired

The OAuth2 scheme ID to use.

requestParametersanyOptional

The request parameters to be used in the token validation request. This should adhere to any params marked as fromClient in the auth scheme.

requestHeadersanyOptional

The request headers to be used in the token validation request. This should adhere to any headers marked as fromClient in the auth scheme.

profileIdanyOptional

The profile ID to assign to the session.

profileSelectoranyOptional

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

Responses

400Error

application/json

401Error

application/json

403Error

application/json

404Error

application/json

409Error

application/json

500Error

application/json

501Error

application/json

503Error

application/json

default

default response

application/json

post

HTTPcURLJavaScriptPython

POST /api/rest/auth/oauth2 HTTP/1.1
Host: localhost:8080
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 104

{
  "schemeId": null,
  "requestParameters": null,
  "requestHeaders": null,
  "profileId": null,
  "profileSelector": null
}

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