Upsert a MTLS-auth credential associated with a Consumer in a workspace

Create or Update a MTLS-auth credential associated with a Consumer using ID in a workspace.

put

Path Parameters

ConsumerIdForNestedEntitiesstringrequired

Consumer ID for nested entities

MTLSAuthIdstringrequired

ID of the MTLS-auth credential to lookup

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 MTLS-auth credential

MTLSAuthWithoutParents

* Additional properties are NOT allowed.
ca_certificateobject
Show Child Parameters
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).

managed_byobject

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

* Additional properties are allowed.
subject_namestringrequired
tagsarray[string]

A string representing a tag.

Response

200 application/json

Successfully upserted MTLS-auth credential

MTLSAuth

* Additional properties are NOT allowed.
ca_certificateobject
Show Child Parameters
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).

managed_byobject

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

* Additional properties are allowed.
subject_namestringrequired
tagsarray[string]

A string representing a tag.

put/control-planes/{controlPlaneId}/core-entities/{workspace}/consumers/{ConsumerIdForNestedEntities}/mtls-auth/{MTLSAuthId}

Body

{ "ca_certificate": { "id": "b2f34145-0343-41a4-9602-4c69dec2f260" }, "id": "b2f34145-0343-41a4-9602-4c69dec2f269", "subject_name": "CA_Subject_Name" }
 
200 application/json

List all MTLS-auth credentials in a workspace

List all MTLS-auth credentials 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 MTLS-auth credentials

dataarray[object]

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"}

* 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}/mtls-auths
 
application/json

Get a MTLS-auth credential in a workspace

Get a MTLS-auth credential using ID in a workspace.

get

Path Parameters

workspacestring(string)required

The name of the workspace

Example:team-payments

MTLSAuthIdstringrequired

ID of the MTLS-auth credential to lookup

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 MTLS-auth credential

MTLSAuth

* Additional properties are NOT allowed.
ca_certificateobject
Show Child Parameters
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).

managed_byobject

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

* Additional properties are allowed.
subject_namestringrequired
tagsarray[string]

A string representing a tag.

get/control-planes/{controlPlaneId}/core-entities/{workspace}/mtls-auths/{MTLSAuthId}
 
application/json

List all MTLS-auth credentials associated with a Consumer

List all MTLS-auth credentials associated with a Consumer

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

ConsumerIdForNestedEntitiesstringrequired

Consumer ID for nested entities

controlPlaneIdstring(uuid)required

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

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

Response

200 application/json

A successful response listing MTLS-auth credentials

dataarray[object]

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"}

* 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/consumers/{ConsumerIdForNestedEntities}/mtls-auth
 
200 application/json

Create a new MTLS-auth credential associated with a Consumer

Create a new MTLS-auth credential associated with a Consumer

post

Path Parameters

ConsumerIdForNestedEntitiesstringrequired

Consumer ID for nested entities

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 new MTLS-auth credential for creation

MTLSAuthWithoutParents

* Additional properties are NOT allowed.
ca_certificateobject
Show Child Parameters
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).

managed_byobject

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

* Additional properties are allowed.
subject_namestringrequired
tagsarray[string]

A string representing a tag.

Response

201 application/json

Successfully created MTLS-auth credential

MTLSAuth

* Additional properties are NOT allowed.
ca_certificateobject
Show Child Parameters
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).

managed_byobject

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

* Additional properties are allowed.
subject_namestringrequired
tagsarray[string]

A string representing a tag.

post/control-planes/{controlPlaneId}/core-entities/consumers/{ConsumerIdForNestedEntities}/mtls-auth

Body

{ "ca_certificate": { "id": "b2f34145-0343-41a4-9602-4c69dec2f260" }, "id": "b2f34145-0343-41a4-9602-4c69dec2f269", "subject_name": "CA_Subject_Name" }
 
201 application/json