Amazon API Gateway REST API Reference

ClientCertificate

Represents a client certificate used to configure client-side SSL authentication while sending requests to the integration endpoint.


Relation Description Method Templated
self

A relation that refers to the current resource.

GET No
clientcertificate:update

Changes information about the ClientCertificate resource.

PATCH No
clientcertificate:delete

Deletes the ClientCertificate resource.

DELETE No


Properties

{
  "clientCertificateId" : "String",
  "description" : "String",
  "pemEncodedCertificate" : "String",
  "createdDate" : "Timestamp",
  "expirationDate" : "Timestamp"
}

  • clientCertificateId
  • The identifier of the client certificate.

  • description
  • The description of the client certificate.

  • pemEncodedCertificate
  • The PEM-encoded public key of the client certificate, which can be used to configure certificate authentication in the integration endpoint .

  • createdDate
  • The timestamp when the client certificate was created.

  • expirationDate
  • The timestamp when the client certificate will expire.

Remarks

Client certificates are used to authenticate an API by the backend server. To authenticate an API client (or user), use IAM roles and policies, a custom Authorizer or an Amazon Cognito user pool.

See Also

Use Client-Side Certificate