Custom Auth Schemes

Lists all auth schemes in the system

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

GEThttp://localhost:8080/api/rest/auth_scheme

Query parameters

Response

400401403404409500501503default

Body

application/json

codestring

A machine readable code of the error.

messagestring

A description of the error. This error is not intended to be displayed to the end-user, rather it is it designed to relay information to the application developer.

Request

JavaScriptCurlPython

const response = await fetch('http://localhost:8080/api/rest/auth_scheme', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

400401403404409500501503default

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

Creates a new Auth Scheme

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

POSThttp://localhost:8080/api/rest/auth_scheme

Body

*/*

audience*any

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}=)?$

algorithm*enum

RSA_256RSA_384RSA_512ECDSA_256ECDSA_384ECDSA_512

userLevel*enum

The highest permitted user level this particular scheme will authorize.

UNPRIVILEGEDUSERSUPERUSER

tags*any

A list of tags used to index the auth scheme.

allowedIssuers*any

The list of issuers allowed to use this scheme.

Response

400401403404409500501503default

Body

application/json

codestring

A machine readable code of the error.

messagestring

A description of the error. This error is not intended to be displayed to the end-user, rather it is it designed to relay information to the application developer.

Request

JavaScriptCurlPython

const response = await fetch('http://localhost:8080/api/rest/auth_scheme', {
    method: 'POST',
    headers: {
      "Content-Type": "*/*"
    },
    body: JSON.stringify({
      "algorithm": "RSA_256",
      "userLevel": "UNPRIVILEGED"
    }),
});
const data = await response.json();

Response

400401403404409500501503default

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

Gets a specific Auth Scheme

Gets a specific Auth Scheme by the authSchemeId.

GEThttp://localhost:8080/api/rest/auth_scheme/{authSchemeId}

Path parameters

authSchemeId*any

Response

400401403404409500501503default

Body

application/json

codestring

A machine readable code of the error.

messagestring

A description of the error. This error is not intended to be displayed to the end-user, rather it is it designed to relay information to the application developer.

Request

JavaScriptCurlPython

const response = await fetch('http://localhost:8080/api/rest/auth_scheme/{authSchemeId}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

400401403404409500501503default

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

Updates an Auth Scheme

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

PUThttp://localhost:8080/api/rest/auth_scheme/{authSchemeId}

Path parameters

authSchemeId*any

Body

*/*

audience*any

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

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}=)?$

algorithm*enum

The algorithm that Elements will use with the supplied key.

RSA_256RSA_384RSA_512ECDSA_256ECDSA_384ECDSA_512

userLevel*enum

The highest permitted user level this particular scheme will authorize.

UNPRIVILEGEDUSERSUPERUSER

tags*any

The list of tags for tagging the auth scheme.

allowedIssuers*any

The list of issuers allowed to use this scheme.

Response

400401403404409500501503default

Body

application/json

codestring

A machine readable code of the error.

messagestring

A description of the error. This error is not intended to be displayed to the end-user, rather it is it designed to relay information to the application developer.

Request

JavaScriptCurlPython

const response = await fetch('http://localhost:8080/api/rest/auth_scheme/{authSchemeId}', {
    method: 'PUT',
    headers: {
      "Content-Type": "*/*"
    },
    body: JSON.stringify({
      "algorithm": "RSA_256",
      "userLevel": "UNPRIVILEGED"
    }),
});
const data = await response.json();

Response

400401403404409500501503default

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

Deletes an Auth Scheme

Deletes an Auth Scheme with the specified id.

DELETEhttp://localhost:8080/api/rest/auth_scheme/{authSchemeId}

Path parameters

authSchemeId*any

Response

400401403404409500501503default

Body

application/json

codestring

A machine readable code of the error.

messagestring

A description of the error. This error is not intended to be displayed to the end-user, rather it is it designed to relay information to the application developer.

Request

JavaScriptCurlPython

const response = await fetch('http://localhost:8080/api/rest/auth_scheme/{authSchemeId}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

400401403404409500501503

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