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
Query Parameters
Number of resources to be returned.
Default:100
>= 1<= 1000
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
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
The name of the workspace
Example:team-payments
The UUID of your control plane. This variable is available in the Konnect manager.
Example:9524ec7d-36d9-465d-a8c5-83a3c9390458
Response
application/json
Response
A successful response listing KeySets
Example:{"id":"b58c7d9d-e54f-444c-b24d-cdfc4159f61e","name":"example-key-set","tags":["idp-keys"]}
Show Child Parameters
URI to the next page (may be null)
Offset is used to paginate through the API. Provide this value to the next list operation to fetch the next page
Authentication
Path Parameters
Query Parameters
Create a new KeySet in a workspace
Create a new KeySet in a workspace
Path Parameters
The name of the workspace
Example:team-payments
The UUID of your control plane. This variable is available in the Konnect manager.
Example:9524ec7d-36d9-465d-a8c5-83a3c9390458
Body
application/json
Body
Description of the new KeySet for creation
KeySet
Unix epoch when the resource was created.
User-defined entity description. Konnect only field, not synced to the Gateway.
A string representing a UUID (universally unique identifier).
Arbitrary JSON data for client responsible for managing the entity. Konnect only field, not synced to the Gateway.
The name to associate with the given key-set.
A string representing a tag.
Unix epoch when the resource was last updated.
Response
application/json
Response
Successfully created KeySet
KeySet
Unix epoch when the resource was created.
User-defined entity description. Konnect only field, not synced to the Gateway.
A string representing a UUID (universally unique identifier).
Arbitrary JSON data for client responsible for managing the entity. Konnect only field, not synced to the Gateway.
The name to associate with the given key-set.
A string representing a tag.
Unix epoch when the resource was last updated.
Authentication
Path Parameters
Body
Delete a KeySet in a workspace
Delete a KeySet in a workspace
Path Parameters
ID of the KeySet to lookup
Example:6cc34248-50b4-4a81-9201-3bdf7a83f712
The name of the workspace
Example:team-payments
The UUID of your control plane. This variable is available in the Konnect manager.
Example:9524ec7d-36d9-465d-a8c5-83a3c9390458
Response
Response
Successfully deleted KeySet or the resource didn’t exist
Authentication
Path Parameters
Get a KeySet in a workspace
Get a KeySet using ID or name in a workspace.
Path Parameters
The name of the workspace
Example:team-payments
ID of the KeySet to lookup
Example:6cc34248-50b4-4a81-9201-3bdf7a83f712
The UUID of your control plane. This variable is available in the Konnect manager.
Example:9524ec7d-36d9-465d-a8c5-83a3c9390458
Response
application/json
Response
Successfully fetched KeySet
KeySet
Unix epoch when the resource was created.
User-defined entity description. Konnect only field, not synced to the Gateway.
A string representing a UUID (universally unique identifier).
Arbitrary JSON data for client responsible for managing the entity. Konnect only field, not synced to the Gateway.
The name to associate with the given key-set.
A string representing a tag.
Unix epoch when the resource was last updated.