Custom Auth Schemes | Elements Manual

Elements Manual

Gets a specific Auth Scheme

get

Gets a specific Auth Scheme by the authSchemeId.

Authorizations

Path parameters

authSchemeIdanyrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

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

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

authSchemeIdanyrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url 'http://localhost:8080/api/rest/auth_scheme/{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

get

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

Authorizations

Query parameters

offsetany · default: 0optional

countany · default: 20optional

tagsanyoptional

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'http://localhost:8080/api/rest/auth_scheme' \
  --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

audienceanyrequired

The JWT audience for the scheme. Must be unique.

publicKeyanyoptional

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

Available options:

userLevelundefined · enumrequired

The highest permitted user level this particular scheme will authorize.

Available options:

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

Updates an Auth Scheme

put

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

Authorizations

Path parameters

authSchemeIdanyrequired

Body

audienceanyrequired

The JWT audience for the scheme. Must be unique.

regenerateanyoptional

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

publicKeyanyoptional

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.

Available options:

userLevelundefined · enumrequired

The highest permitted user level this particular scheme will authorize.

Available options:

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