Upsert a JWT associated with a Consumer

Create or Update a JWT associated with a Consumer using ID.

put

Path Parameters

ConsumerIdForNestedEntitiesstringrequired

Consumer ID for nested entities

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

Body

application/json

Description of the JWT

JWTWithoutParents

* Additional properties are NOT allowed.
algorithmstring

Allowed values:ES256ES256KES384ES512ESB256ESB320ESB384ESB512ESP256ESP384ESP512Ed25519Ed448EdDSAHS256HS384HS512PS256PS384PS512RS256RS384RS512

Default:HS256

consumerobject
Show Child Parameters
created_atinteger

Unix epoch when the resource was created.

idstring

A string representing a UUID (universally unique identifier).

keystring
rsa_public_keystring
secretstring
tagsarray[string]

A string representing a tag.

Response

200 application/json

Successfully upserted 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.

idstring

A string representing a UUID (universally unique identifier).

keystring
rsa_public_keystring
secretstring
tagsarray[string]

A string representing a tag.

put/control-planes/{controlPlaneId}/core-entities/consumers/{ConsumerIdForNestedEntities}/jwt/{JWTId}

Body

{ "algorithm": "HS256", "id": "75695322-e8a0-4109-aed4-5416b0308d85", "key": "YJdmaDvVTJxtcWRCvkMikc8oELgAVNcz", "secret": "C50k0bcahDhLNhLKSUBSR1OMiFGzNZ7X" }
 
200 application/json

List all JWTs

List all JWTs

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

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 JWTs

dataarray[object]

Example:{"algorithm":"HS256","consumer":{"id":"84a73fb8-50fc-44a7-a4d5-aa17728ee83f"},"id":"75695322-e8a0-4109-aed4-5416b0308d85","key":"YJdmaDvVTJxtcWRCvkMikc8oELgAVNcz","secret":"C50k0bcahDhLNhLKSUBSR1OMiFGzNZ7X"}

* 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/jwts
 
application/json

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.

idstring

A string representing a UUID (universally unique identifier).

keystring
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

List all KeySets

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

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/key-sets
 
application/json