/oidc

Previous/oauth2 Next/blockchain

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/oidc' \
  --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.

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

get

Gets a specific Auth Scheme by the 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

put

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

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

delete

Deletes an Auth Scheme with the specified id.

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