/oauth2

Previous/custom Next/oidc

Last updated 3 days ago

Lists all auth schemes in the system

get

Requires SUPERUSER access. Gets a pagination of Auth Schemes for the given query.

Authorizations

Query parameters

offsetany · default: 0

countany · default: 20

tagsany

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'http://localhost:8080/api/rest/auth_scheme/oauth2' \
  --header 'Authorization: YOUR_API_KEY'

400

401

403

404

409

500

501

503

default

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

Creates a new Auth Scheme

post

Creates a new Auth Scheme, from the data in the given auth scheme request

Authorizations

Body

idanyrequired

The unique ID of the auth scheme.

nameanyrequired

A unique name used to identify the scheme within the instance of Elements. If using the same OAuth2 provider (e.g. Steam), it is recommended to suffix the name for each application when using multitenancy, e.g. steam_game1, steam_game2, etc.

validationUrlanyrequired

The URL to send the user token validation request to.

headersany

The headers required for the validation request.

paramsany

The query parameters required for the validation request.

responseIdMappingany

Determines how to map the user id in the response. For example "response.params.steamid"

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'http://localhost:8080/api/rest/auth_scheme/oauth2' \
  --header 'Authorization: YOUR_API_KEY' \
  --header 'Content-Type: */*' \
  --data '{
    "id": null,
    "name": null,
    "validationUrl": null,
    "headers": [
      {
        "key": null,
        "value": null,
        "fromClient": null
      }
    ],
    "params": [
      {
        "key": null,
        "value": null,
        "fromClient": null
      }
    ],
    "responseIdMapping": null
  }'

400

401

403

404

409

500

501

503

default

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

Gets a specific Auth Scheme

get

Gets a specific Auth Scheme by the oAuth2AuthSchemeId.

Authorizations

Path parameters

oAuth2AuthSchemeIdanyrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'http://localhost:8080/api/rest/auth_scheme/oauth2/{oAuth2AuthSchemeId}' \
  --header 'Authorization: YOUR_API_KEY'

400

401

403

404

409

500

501

503

default

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

Updates an Auth Scheme

put

Updates an Auth Scheme with the specified data in the auth scheme request.

Authorizations

Path parameters

oAuth2AuthSchemeIdanyrequired

Body

idanyrequired

The unique ID of the auth scheme.

nameanyrequired

validationUrlanyrequired

The URL to send the user token validation request to.

headersany

The headers required for the validation request.

paramsany

The query parameters required for the validation request.

responseIdMappingany

Determines how to map the user id in the response. For example "response.params.steamid"

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url 'http://localhost:8080/api/rest/auth_scheme/oauth2/{oAuth2AuthSchemeId}' \
  --header 'Authorization: YOUR_API_KEY' \
  --header 'Content-Type: */*' \
  --data '{
    "id": null,
    "name": null,
    "validationUrl": null,
    "headers": [
      {
        "key": null,
        "value": null,
        "fromClient": null
      }
    ],
    "params": [
      {
        "key": null,
        "value": null,
        "fromClient": null
      }
    ],
    "responseIdMapping": null
  }'

400

401

403

404

409

500

501

503

default

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

Deletes an Auth Scheme

delete

Deletes an Auth Scheme with the specified id.

Authorizations

Path parameters

oAuth2AuthSchemeIdanyrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url 'http://localhost:8080/api/rest/auth_scheme/oauth2/{oAuth2AuthSchemeId}' \
  --header 'Authorization: YOUR_API_KEY'

400

401

403

404

409

500

501

503

default

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