/ 
OpenAPI-Client-OpenAI-0.24
River stage one • 1 direct dependent • 1 total dependent
⭐ Starred 7 GitHub stars
/ OpenAPI::Client::OpenAI::Path::organization-certificates-certificate_id

NAME

OpenAPI::Client::OpenAI::Path::organization-certificates-certificate_id - Documentation for the /organization/certificates/{certificate_id} path.

DESCRIPTION

This document describes the API endpoint at /organization/certificates/{certificate_id}.

PATHS

DELETE /organization/certificates/{certificate_id}

Delete certificate

Delete a certificate from the organization.

The certificate must be inactive for the organization and all projects.

Operation ID

deleteCertificate

$client->deleteCertificate( ... );

Parameters

Responses

Status Code: 200

Certificate deleted successfully.

Content Types:

GET /organization/certificates/{certificate_id}

Get certificate

Get a certificate that has been uploaded to the organization.

You can get a certificate regardless of whether it is active or not.

Operation ID

getCertificate

$client->getCertificate( ... );

Parameters

  • certificate_id (in path) (Required) - Unique ID of the certificate to retrieve.

    Type: string

  • include (in query) (Optional) - A list of additional fields to include in the response. Currently the only supported value is `content` to fetch the PEM content of the certificate.

    Type: array

Responses

Status Code: 200

Certificate retrieved successfully.

Content Types:

  • application/json

    Example (See the OpenAI spec for more detail):

    {
  "object": "certificate",
  "id": "cert_abc",
  "name": "My Certificate",
  "created_at": 1234567,
  "certificate_details": {
    "valid_at": 1234567,
    "expires_at": 12345678,
    "content": "-----BEGIN CERTIFICATE----- MIIGAjCCA...6znFlOW+ -----END CERTIFICATE-----"
  }
}

POST /organization/certificates/{certificate_id}

Modify certificate

Modify a certificate. Note that only the name can be modified.

Operation ID

modifyCertificate

$client->modifyCertificate( ... );

Parameters

Request Body

Content Type: application/json

Responses

Status Code: 200

Certificate modified successfully.

Content Types:

  • application/json

    Example (See the OpenAI spec for more detail):

    {
  "object": "certificate",
  "id": "cert_abc",
  "name": "My Certificate",
  "created_at": 1234567,
  "certificate_details": {
    "valid_at": 1234567,
    "expires_at": 12345678,
    "content": "-----BEGIN CERTIFICATE----- MIIGAjCCA...6znFlOW+ -----END CERTIFICATE-----"
  }
}

SEE ALSO

OpenAPI::Client::OpenAI::Path

COPYRIGHT AND LICENSE

Copyright (C) 2023-2025 by Nelson Ferraz

This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself, either Perl version 5.14.0 or, at your option, any later version of Perl 5 you may have available.