Waiting for engine...
Skip to main content

GatewayCertificateAuthenticationInput

Input parameters for configuring client certificate authentication settings on a gateway.

input GatewayCertificateAuthenticationInput {
  certificateHeaderAuthEnabled: Boolean
  certificateHeaderName: String
  certificateAuthRequired: Boolean
  addTrustedCertificates: [ID!]
  addTrustedX500Names: [TrustedX500NameInput]
  deleteTrustedCertificates: [ID!]
  deleteTrustedX500Names: [ID!]
}

Fields​

GatewayCertificateAuthenticationInput.certificateHeaderAuthEnabled ● Boolean scalar miscellaneous

To enable Client Certificate Header Authentication, set this to true. If not provided, the current state will be maintained.

GatewayCertificateAuthenticationInput.certificateHeaderName ● String scalar miscellaneous

Specifies the header name that holds the Client Certificate when Client Certificate Header Authentication is enabled (when client certificate header authentication is enabled certificate header name should be present).

GatewayCertificateAuthenticationInput.certificateAuthRequired ● Boolean scalar miscellaneous

To enforce Client Certificate for all APIs attached to the gateway, set this to true. If not provided, the current state will be maintained.

GatewayCertificateAuthenticationInput.addTrustedCertificates ● [ID!] list scalar miscellaneous

To add Trusted Certificates to the gateway, provide a list of Certificate component IDs.

GatewayCertificateAuthenticationInput.addTrustedX500Names ● [TrustedX500NameInput] list input platform

To add a list of Trusted Client Certificate Distinguished Names to the gateway's Certificate Authentication settings.

GatewayCertificateAuthenticationInput.deleteTrustedCertificates ● [ID!] list scalar miscellaneous

To delete Trusted Client Certificates from gateway, provide a list of trusted certificate IDs.

GatewayCertificateAuthenticationInput.deleteTrustedX500Names ● [ID!] list scalar miscellaneous

To delete trusted client certificate Distinguished Names from the gateway, provide a list of Distinguished Name IDs.

Member Of​

GatewayInput input

On this Page