Skip to content

get_client_certificate

Operation

get_client_certificate

get_client_certificate(request: GetClientCertificateInput | GetClientCertificateInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetClientCertificateInputDict]) -> GetClientCertificateOutput

Gets information about the current ClientCertificate resource.

Parameters:

Name Type Description Default
request GetClientCertificateInput | GetClientCertificateInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

None
**kwargs Unpack[GetClientCertificateInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
GetClientCertificateOutput

An instance of GetClientCertificateOutput.

get_client_certificate async

get_client_certificate(request: GetClientCertificateInput | GetClientCertificateInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetClientCertificateInputDict]) -> GetClientCertificateOutput

Gets information about the current ClientCertificate resource.

Parameters:

Name Type Description Default
request GetClientCertificateInput | GetClientCertificateInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

None
**kwargs Unpack[GetClientCertificateInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
GetClientCertificateOutput

An instance of GetClientCertificateOutput.

Input

Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.

GetClientCertificateInputDict

Bases: TypedDict

Dictionary form of GetClientCertificateInput.

Attributes

client_certificate_id instance-attribute
client_certificate_id: Required[str]

The identifier of the ClientCertificate resource to be described.

GetClientCertificateInput dataclass

Bases: _SerdeShape

A request to get information about the current ClientCertificate resource.

Attributes

client_certificate_id class-attribute instance-attribute
client_certificate_id: str | None = ...

The identifier of the ClientCertificate resource to be described.

Output

GetClientCertificateOutput dataclass

Bases: _SerdeShape

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

Attributes

client_certificate_id class-attribute instance-attribute
client_certificate_id: str | None = ...

The identifier of the client certificate.

created_date class-attribute instance-attribute
created_date: datetime | None = ...

The timestamp when the client certificate was created.

description class-attribute instance-attribute
description: str | None = ...

The description of the client certificate.

expiration_date class-attribute instance-attribute
expiration_date: datetime | None = ...

The timestamp when the client certificate will expire.

pem_encoded_certificate class-attribute instance-attribute
pem_encoded_certificate: str | None = ...

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

response_metadata class-attribute instance-attribute
response_metadata: ResponseMetadata = ...

Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.

tags class-attribute instance-attribute
tags: dict[str, str] | None = ...

The collection of tags. Each tag element is associated with a given resource.