Custom Auth Schemes

Lists all auth schemes in the system

get

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

Authorizations

auth_bearersession_secret

Query parameters

offsetanyOptionalDefault: 0

countanyOptionalDefault: 20

tagsanyOptional

Responses

get

HTTPcURLJavaScriptPython

GET /api/rest/auth_scheme HTTP/1.1
Host: localhost:8080
Authorization: YOUR_API_KEY
Accept: */*

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

auth_bearersession_secret

Body

Represents a request to create an Auth Scheme for an Application.

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 · enumRequiredPossible values:

userLevelundefined · enumRequired

The highest permitted user level this particular scheme will authorize.

Possible values:

tagsanyRequired

A list of tags used to index the auth scheme.

allowedIssuersanyRequired

The list of issuers allowed to use this scheme.

Responses

post

HTTPcURLJavaScriptPython

POST /api/rest/auth_scheme HTTP/1.1
Host: localhost:8080
Authorization: YOUR_API_KEY
Content-Type: */*
Accept: */*
Content-Length: 113

{
  "audience": null,
  "publicKey": null,
  "algorithm": "RSA_256",
  "userLevel": "UNPRIVILEGED",
  "tags": [],
  "allowedIssuers": []
}

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

Gets a specific Auth Scheme

get

Gets a specific Auth Scheme by the authSchemeId.

Authorizations

auth_bearersession_secret

Path parameters

authSchemeIdanyRequired

Responses

get

HTTPcURLJavaScriptPython

GET /api/rest/auth_scheme/{authSchemeId} HTTP/1.1
Host: localhost:8080
Authorization: YOUR_API_KEY
Accept: */*

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

Updates an Auth Scheme

put

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

Authorizations

auth_bearersession_secret

Path parameters

authSchemeIdanyRequired

Body

Represents a request to update an Auth Scheme for an Application.

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

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

The algorithm that Elements will use with the supplied key.

Possible values:

userLevelundefined · enumRequired

The highest permitted user level this particular scheme will authorize.

Possible values:

tagsanyRequired

The list of tags for tagging the auth scheme.

allowedIssuersanyRequired

The list of issuers allowed to use this scheme.

Responses

put

HTTPcURLJavaScriptPython

PUT /api/rest/auth_scheme/{authSchemeId} HTTP/1.1
Host: localhost:8080
Authorization: YOUR_API_KEY
Content-Type: */*
Accept: */*
Content-Length: 131

{
  "audience": null,
  "regenerate": null,
  "publicKey": null,
  "algorithm": "RSA_256",
  "userLevel": "UNPRIVILEGED",
  "tags": [],
  "allowedIssuers": []
}

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

Deletes an Auth Scheme

delete

Deletes an Auth Scheme with the specified id.

Authorizations

auth_bearersession_secret

Path parameters

authSchemeIdanyRequired

Responses

delete

HTTPcURLJavaScriptPython

DELETE /api/rest/auth_scheme/{authSchemeId} HTTP/1.1
Host: localhost:8080
Authorization: YOUR_API_KEY
Accept: */*

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