Get a JWT

Get a JWT using ID.

get

Path Parameters

JWTIdstringrequired

ID of the JWT to lookup

Example:4a7f5faa-8c96-46d6-8214-c87573ef2ac4

controlPlaneIdstring(uuid)required

The UUID of your control plane. This variable is available in the Konnect manager.

Example:9524ec7d-36d9-465d-a8c5-83a3c9390458

Response

application/json

Successfully fetched JWT

JWT

* Additional properties are NOT allowed.
algorithmstring

Allowed values:ES256ES256KES384ES512ESB256ESB320ESB384ESB512ESP256ESP384ESP512Ed25519Ed448EdDSAHS256HS384HS512PS256PS384PS512RS256RS384RS512

Default:HS256

consumerobject
Show Child Parameters
created_atinteger

Unix epoch when the resource was created.

descriptionstring

User-defined entity description. Konnect only field, not synced to the Gateway.

idstring

A string representing a UUID (universally unique identifier).

keystring
managed_byobject

Arbitrary JSON data for client responsible for managing the entity. Konnect only field, not synced to the Gateway.

* Additional properties are allowed.
rsa_public_keystring
secretstring
tagsarray[string]

A string representing a tag.

get/control-planes/{controlPlaneId}/core-entities/jwts/{JWTId}
 
application/json

KeySets

A JSON Web key set. Key sets are the preferred way to expose keys to plugins because they tell the plugin where to look for keys or have a scoping mechanism to restrict plugins to specific keys.

List all KeySets in a workspace

List all KeySets in a workspace

get

Query Parameters

sizeinteger

Number of resources to be returned.

Default:100

>= 1<= 1000

offsetstring

Offset from which to return the next set of resources. Use the value of the ‘offset’ field from the response of a list operation as input here to paginate through all the resources

tagsstring

A list of tags to filter the list of resources on. Multiple tags can be concatenated using ‘,’ to mean AND or using ‘/’ to mean OR.

Example:tag1,tag2

Path Parameters

workspacestring(string)required

The name of the workspace

Example:team-payments

controlPlaneIdstring(uuid)required

The UUID of your control plane. This variable is available in the Konnect manager.

Example:9524ec7d-36d9-465d-a8c5-83a3c9390458

Response

application/json

A successful response listing KeySets

dataarray[object]

Example:{"id":"b58c7d9d-e54f-444c-b24d-cdfc4159f61e","name":"example-key-set","tags":["idp-keys"]}

* Additional properties are NOT allowed.
Show Child Parameters
nextstring

URI to the next page (may be null)

offsetstring

Offset is used to paginate through the API. Provide this value to the next list operation to fetch the next page

get/control-planes/{controlPlaneId}/core-entities/{workspace}/key-sets
 
application/json

Create a new KeySet in a workspace

Create a new KeySet in a workspace

post

Path Parameters

workspacestring(string)required

The name of the workspace

Example:team-payments

controlPlaneIdstring(uuid)required

The UUID of your control plane. This variable is available in the Konnect manager.

Example:9524ec7d-36d9-465d-a8c5-83a3c9390458

Body

application/json

Description of the new KeySet for creation

KeySet

* Additional properties are NOT allowed.
created_atinteger

Unix epoch when the resource was created.

descriptionstring

User-defined entity description. Konnect only field, not synced to the Gateway.

idstring

A string representing a UUID (universally unique identifier).

managed_byobject

Arbitrary JSON data for client responsible for managing the entity. Konnect only field, not synced to the Gateway.

* Additional properties are allowed.
namestring

The name to associate with the given key-set.

tagsarray[string]

A string representing a tag.

updated_atinteger

Unix epoch when the resource was last updated.

Response

application/json

Successfully created KeySet

KeySet

* Additional properties are NOT allowed.
created_atinteger

Unix epoch when the resource was created.

descriptionstring

User-defined entity description. Konnect only field, not synced to the Gateway.

idstring

A string representing a UUID (universally unique identifier).

managed_byobject

Arbitrary JSON data for client responsible for managing the entity. Konnect only field, not synced to the Gateway.

* Additional properties are allowed.
namestring

The name to associate with the given key-set.

tagsarray[string]

A string representing a tag.

updated_atinteger

Unix epoch when the resource was last updated.

post/control-planes/{controlPlaneId}/core-entities/{workspace}/key-sets

Body

{ "id": "b58c7d9d-e54f-444c-b24d-cdfc4159f61e", "name": "example-key-set", "tags": [ "idp-keys" ] }
 
application/json

Delete a KeySet in a workspace

Delete a KeySet in a workspace

delete

Path Parameters

KeySetIdstringrequired

ID of the KeySet to lookup

Example:6cc34248-50b4-4a81-9201-3bdf7a83f712

workspacestring(string)required

The name of the workspace

Example:team-payments

controlPlaneIdstring(uuid)required

The UUID of your control plane. This variable is available in the Konnect manager.

Example:9524ec7d-36d9-465d-a8c5-83a3c9390458

Response

Successfully deleted KeySet or the resource didn’t exist

delete/control-planes/{controlPlaneId}/core-entities/{workspace}/key-sets/{KeySetId}