MTLS-auth credentials
List all MTLS-auth credentials associated with a Consumer in a workspace
List all MTLS-auth credentials associated with a Consumer 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
Consumer ID for nested entities
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
200 application/json
Response
A successful response listing MTLS-auth credentials
Example:{"ca_certificate":{"id":"b2f34145-0343-41a4-9602-4c69dec2f260"},"consumer":{"id":"84a73fb8-50fc-44a7-a4d5-aa17728ee83f"},"id":"b2f34145-0343-41a4-9602-4c69dec2f269","subject_name":"CA_Subject_Name"}
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 MTLS-auth credential associated with a Consumer in a workspace
Create a new MTLS-auth credential associated with a Consumer in a workspace
Path Parameters
Consumer ID for nested entities
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 new MTLS-auth credential for creation
MTLSAuthWithoutParents
Show Child Parameters
Show Child Parameters
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.
A string representing a tag.
Response
201 application/json
Response
Successfully created MTLS-auth credential
MTLSAuth
Show Child Parameters
Show Child Parameters
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.
A string representing a tag.
Authentication
Path Parameters
Body
Delete a a MTLS-auth credential associated with a Consumer in a workspace
Delete a a MTLS-auth credential associated with a Consumer using ID in a workspace.
Path Parameters
Consumer ID for nested entities
ID of the MTLS-auth credential to lookup
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
204
Response
Successfully deleted MTLS-auth credential or the resource didn’t exist
Authentication
Path Parameters
Get a MTLS-auth credential associated with a Consumer in a workspace
Get a MTLS-auth credential associated with a Consumer using ID in a workspace.
Path Parameters
Consumer ID for nested entities
ID of the MTLS-auth credential to lookup
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
Successfully fetched MTLS-auth credential
MTLSAuth
Show Child Parameters
Show Child Parameters
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.
A string representing a tag.