/auth_scheme

Previous/auth Next/blockchain

Last updated 10 days ago

Lists all auth schemes in the system

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

get

/auth_scheme/custom

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/custom' \
  --header 'Authorization: YOUR_API_KEY'

400

401

403

404

409

500

501

503

default

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

Creates a new Auth Scheme

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

post

/auth_scheme/custom

Authorizations

Body

audienceanyrequired

The JWT audience for the scheme. Must be unique.

publicKeyany

The Base64 public key that was either given or generated during creation. See https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/security/spec/X509EncodedKeySpec.html for details on the specifics of the format.

Pattern: ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$

algorithmundefined · enumrequired

Options: RSA_256, RSA_384, RSA_512

userLevelundefined · enumrequired

The highest permitted user level this particular scheme will authorize.

Options: UNPRIVILEGED, USER, SUPERUSER

tagsanyrequired

A list of tags used to index the auth scheme.

allowedIssuersanyrequired

The list of issuers allowed to use this scheme.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'http://localhost:8080/api/rest/auth_scheme/custom' \
  --header 'Authorization: YOUR_API_KEY' \
  --header 'Content-Type: */*' \
  --data '{
    "audience": null,
    "publicKey": null,
    "algorithm": "RSA_256",
    "userLevel": "UNPRIVILEGED",
    "tags": [],
    "allowedIssuers": []
  }'

400

401

403

404

409

500

501

503

default

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

Gets a specific Auth Scheme

Gets a specific Auth Scheme by the authSchemeId.

get

/auth_scheme/custom/{authSchemeId}

Authorizations

Path parameters

authSchemeIdanyrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

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

400

401

403

404

409

500

501

503

default

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

Updates an Auth Scheme

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

put

/auth_scheme/custom/{authSchemeId}

Authorizations

Path parameters

authSchemeIdanyrequired

Body

audienceanyrequired

The JWT audience for the scheme. Must be unique.

regenerateany

If set to true, Elements will regenerate the key and pubKey must be null or omitted

publicKeyany

Pattern: ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$

algorithmundefined · enumrequired

The algorithm that Elements will use with the supplied key.

Options: RSA_256, RSA_384, RSA_512

userLevelundefined · enumrequired

The highest permitted user level this particular scheme will authorize.

Options: UNPRIVILEGED, USER, SUPERUSER

tagsanyrequired

The list of tags for tagging the auth scheme.

allowedIssuersanyrequired

The list of issuers allowed to use this scheme.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url 'http://localhost:8080/api/rest/auth_scheme/custom/{authSchemeId}' \
  --header 'Authorization: YOUR_API_KEY' \
  --header 'Content-Type: */*' \
  --data '{
    "audience": null,
    "regenerate": null,
    "publicKey": null,
    "algorithm": "RSA_256",
    "userLevel": "UNPRIVILEGED",
    "tags": [],
    "allowedIssuers": []
  }'

400

401

403

404

409

500

501

503

default

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

Deletes an Auth Scheme

Deletes an Auth Scheme with the specified id.

delete

/auth_scheme/custom/{authSchemeId}

Authorizations

Path parameters

authSchemeIdanyrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

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

400

401

403

404

409

500

501

503

default

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

Lists all auth schemes in the system

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

get

/auth_scheme/oauth2

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

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

post

/auth_scheme/oauth2

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

Gets a specific Auth Scheme by the oAuth2AuthSchemeId.

get

/auth_scheme/oauth2/{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

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

put

/auth_scheme/oauth2/{oAuth2AuthSchemeId}

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

Deletes an Auth Scheme with the specified id.

delete

/auth_scheme/oauth2/{oAuth2AuthSchemeId}

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"
}

Lists all auth schemes in the system

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

get

/auth_scheme/oidc

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/oidc' \
  --header 'Authorization: YOUR_API_KEY'

400

401

403

404

409

500

501

503

default

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

Creates a new Auth Scheme

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

post

/auth_scheme/oidc

Authorizations

Body

idanyrequired

The unique ID of the auth scheme.

issueranyrequired

A unique name used to identify the scheme within the instance of Elements. When validating from an external source (e.g. Google or Apple SSO), must match the 'iss' property of the decoded JWT.

keysanyrequired

A set of JWKs containing the keys required to validate JWT signatures.

keysUrlany

The URL for the JWK data. Will attempt to refresh keys if the kid cannot be found in the collection.

mediaTypeany

The JWK format. Defaults to application/json

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'http://localhost:8080/api/rest/auth_scheme/oidc' \
  --header 'Authorization: YOUR_API_KEY' \
  --header 'Content-Type: */*' \
  --data '{
    "id": null,
    "issuer": null,
    "keys": [
      {
        "alg": null,
        "kid": null,
        "kty": null,
        "use": null,
        "e": null,
        "n": null
      }
    ],
    "keysUrl": null,
    "mediaType": null
  }'

400

401

403

404

409

500

501

503

default

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

Gets a specific Auth Scheme

Gets a specific Auth Scheme by the oidcAuthSchemeId.

get

/auth_scheme/oidc/{oidcAuthSchemeId}

Authorizations

Path parameters

oidcAuthSchemeIdanyrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

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

400

401

403

404

409

500

501

503

default

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

Updates an Auth Scheme

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

put

/auth_scheme/oidc/{oidcAuthSchemeId}

Authorizations

Path parameters

oidcAuthSchemeIdanyrequired

Body

idanyrequired

The unique ID of the auth scheme.

issueranyrequired

A unique name used to identify the scheme within the instance of Elements. When validating from an external source (e.g. Google or Apple SSO), must match the 'iss' property of the decoded JWT.

keysanyrequired

A set of JWKs containing the keys required to validate JWT signatures.

keysUrlany

The URL for the JWK data. Will attempt to refresh keys if the kid cannot be found in the collection.

mediaTypeany

The JWK format. Defaults to application/json

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url 'http://localhost:8080/api/rest/auth_scheme/oidc/{oidcAuthSchemeId}' \
  --header 'Authorization: YOUR_API_KEY' \
  --header 'Content-Type: */*' \
  --data '{
    "id": null,
    "issuer": null,
    "keys": [
      {
        "alg": null,
        "kid": null,
        "kty": null,
        "use": null,
        "e": null,
        "n": null
      }
    ],
    "keysUrl": null,
    "mediaType": null
  }'

400

401

403

404

409

500

501

503

default

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

Deletes an Auth Scheme

Deletes an Auth Scheme with the specified id.

delete

/auth_scheme/oidc/{oidcAuthSchemeId}

Authorizations

Path parameters

oidcAuthSchemeIdanyrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

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

400

401

403

404

409

500

501

503

default

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