Returns a list of JSON Web Keys

GET 
/auth/v1/jwks

Generate JWT

Request

Query Parameters

kc boolean

Include JWKs from KeyCloak

iss string

Filter JWKs by issuer

Responses

200

Array of JWKs

application/json

Schema

Schema

issuer

object

issstringrequired

Issuer of the JWT

project

object

required

idstringrequired

JWKsURLstring

URL to the JWKs public keys, if no URL is provided you must include 'keys', if both are provided the keys fetched from the URL are merged with the supplied keys

audstring[]

An array of audiences that are valid for this issuer, an empty array is allowed

rolesstring[]

An array of roles that are allowed for this issuer, an empty permmits all roles

prmuint64

An uint64 bitmask representing the permissions valid for this issuser, an empty value permits all permissions

internalboolean

Indicates that this issuer is an internal issuer (NOTE: this field can not be set via the API)

staticboolean

Indicates that this issuer was added via a configuration, (NOTE: this field can not set via the API)

keysarray

JWK public keys used for this issuer, an emtpy array is allowed if a JWKsURL is also provided

keysarrayrequired

Keys maybe empty if the 'iss' param was set, in this case the keys will be under the issuer object

Example (from schema)

{
  "issuer": {
    "iss": "string",
    "project": {
      "id": "string"
    },
    "JWKsURL": "string",
    "aud": [
      "string"
    ],
    "roles": [
      "string"
    ],
    "prm": 0,
    "internal": true,
    "static": true,
    "keys": [
      null
    ]
  },
  "keys": [
    null
  ]
}

400

Bad Request

application/json

Schema

Schema

messagestringrequired

Error message for the end user

errorCodestring

Code that can be set that supplies a specific reason for why a request failed

invalidFields

object[]

Specific error scoped to a field

Array [

namestringrequired

reasonstringrequired

errorCodestring

]

internalstring

Internal user only

Example (from schema)

{
  "message": "string",
  "errorCode": "string",
  "invalidFields": [
    {
      "name": "string",
      "reason": "string",
      "errorCode": "string"
    }
  ],
  "internal": "string"
}

401

Unauthorized

application/json

Schema

Schema

messagestringrequired

Error message for the end user

errorCodestring

Code that can be set that supplies a specific reason for why a request failed

invalidFields

object[]

Specific error scoped to a field

Array [

namestringrequired

reasonstringrequired

errorCodestring

]

internalstring

Internal user only

Example (from schema)

{
  "message": "string",
  "errorCode": "string",
  "invalidFields": [
    {
      "name": "string",
      "reason": "string",
      "errorCode": "string"
    }
  ],
  "internal": "string"
}

403

Forbidden

application/json

Schema

Schema

messagestringrequired

Error message for the end user

errorCodestring

Code that can be set that supplies a specific reason for why a request failed

invalidFields

object[]

Specific error scoped to a field

Array [

namestringrequired

reasonstringrequired

errorCodestring

]

internalstring

Internal user only

Example (from schema)

{
  "message": "string",
  "errorCode": "string",
  "invalidFields": [
    {
      "name": "string",
      "reason": "string",
      "errorCode": "string"
    }
  ],
  "internal": "string"
}

500

Internal Server Error

application/json

Schema

Schema

messagestringrequired

Error message for the end user

errorCodestring

Code that can be set that supplies a specific reason for why a request failed

invalidFields

object[]

Specific error scoped to a field

Array [

namestringrequired

reasonstringrequired

errorCodestring

]

internalstring

Internal user only

Example (from schema)

{
  "message": "string",
  "errorCode": "string",
  "invalidFields": [
    {
      "name": "string",
      "reason": "string",
      "errorCode": "string"
    }
  ],
  "internal": "string"
}