/oidc

Lists all auth schemes in the system

get

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

Authorizations
Query parameters
offsetanyOptionalDefault: 0
countanyOptionalDefault: 20
tagsanyOptional
Responses
400Error
application/json
get
GET /api/rest/auth_scheme/oidc 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
Body

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

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.

keysUrlanyOptional

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

mediaTypeanyOptional

The JWK format. Defaults to application/json

Responses
400Error
application/json
post
POST /api/rest/auth_scheme/oidc HTTP/1.1
Host: localhost:8080
Authorization: YOUR_API_KEY
Content-Type: */*
Accept: */*
Content-Length: 130

{
  "id": null,
  "issuer": null,
  "keys": [
    {
      "alg": null,
      "kid": null,
      "kty": null,
      "use": null,
      "e": null,
      "n": null
    }
  ],
  "keysUrl": null,
  "mediaType": null
}
{
  "code": "text",
  "message": "text"
}

Gets a specific Auth Scheme

get

Gets a specific Auth Scheme by the oidcAuthSchemeId.

Authorizations
Path parameters
oidcAuthSchemeIdanyRequired
Responses
400Error
application/json
get
GET /api/rest/auth_scheme/oidc/{oidcAuthSchemeId} 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
Path parameters
oidcAuthSchemeIdanyRequired
Body

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

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.

keysUrlanyOptional

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

mediaTypeanyOptional

The JWK format. Defaults to application/json

Responses
400Error
application/json
put
PUT /api/rest/auth_scheme/oidc/{oidcAuthSchemeId} HTTP/1.1
Host: localhost:8080
Authorization: YOUR_API_KEY
Content-Type: */*
Accept: */*
Content-Length: 130

{
  "id": null,
  "issuer": null,
  "keys": [
    {
      "alg": null,
      "kid": null,
      "kty": null,
      "use": null,
      "e": null,
      "n": null
    }
  ],
  "keysUrl": null,
  "mediaType": null
}
{
  "code": "text",
  "message": "text"
}

Deletes an Auth Scheme

delete

Deletes an Auth Scheme with the specified id.

Authorizations
Path parameters
oidcAuthSchemeIdanyRequired
Responses
400Error
application/json
delete
DELETE /api/rest/auth_scheme/oidc/{oidcAuthSchemeId} HTTP/1.1
Host: localhost:8080
Authorization: YOUR_API_KEY
Accept: */*
{
  "code": "text",
  "message": "text"
}

Last updated