/ 
OpenAPI-Client-OpenAI-0.28
⭐ Starred 7 / OpenAPI::Client::OpenAI::Path::organization-certificates

NAME

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

OPERATIONS

GET /organization/certificates

listOrganizationCertificates

$client->list_organization_certificates({
    body => { ... },
});

List uploaded certificates for this organization.

Path/query parameters

  • limit (in query, optional, integer) - A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.

    Default: 20

  • after (in query, optional, string) - A cursor for use in pagination. after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list.

  • order (in query, optional, string) - Sort order by the created_at timestamp of the objects. asc for ascending order and desc for descending order.

    Allowed values: asc, desc

    Default: desc

Responses

200 - Certificates listed successfully.

Content-Type: application/json

Example:

{
   "data" : [
      {
         "active" : false,
         "certificate_details" : {
            "expires_at" : 0,
            "valid_at" : 0
         },
         "created_at" : 0,
         "id" : "string",
         "name" : "string",
         "object" : "organization.certificate"
      }
   ],
   "first_id" : "cert_abc",
   "has_more" : false,
   "last_id" : "cert_abc",
   "object" : "list"
}

POST /organization/certificates

uploadCertificate

$client->upload_certificate({
    body => { ... },
});

Upload a certificate to the organization. This does not automatically activate the certificate.

Organizations can upload up to 50 certificates.

Responses

200 - Certificate uploaded successfully.

Content-Type: application/json

Example:

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

SCHEMAS

Certificate

Properties:

  • active (boolean) - Whether the certificate is currently active at the specified scope. Not returned when getting details for a specific certificate.

  • certificate_details (object, required)

  • created_at (integer, required) - The Unix timestamp (in seconds) of when the certificate was uploaded.

  • id (string, required) - The identifier, which can be referenced in API endpoints

  • name (anyOf, required) - The name of the certificate.

  • object (string, required) - The object type.

    - If creating, updating, or getting a specific certificate, the object type is certificate . - If listing, activating, or deactivating certificates for the organization, the object type is organization.certificate . - If listing, activating, or deactivating certificates for a project, the object type is organization.project.certificate .

    Allowed values: certificate, organization.certificate, organization.project.certificate

ListCertificatesResponse

Properties:

  • data (array of OrganizationCertificate, required)

  • first_id (anyOf, required)

  • has_more (boolean, required)

  • last_id (anyOf, required)

  • object (string, required)

    Allowed values: list

OrganizationCertificate

Properties:

  • active (boolean, required) - Whether the certificate is currently active at the organization level.

  • certificate_details (object, required)

  • created_at (integer, required) - The Unix timestamp (in seconds) of when the certificate was uploaded.

  • id (string, required) - The identifier, which can be referenced in API endpoints

  • name (anyOf, required) - The name of the certificate.

  • object (string, required) - The object type, which is always organization.certificate .

    Allowed values: organization.certificate

UploadCertificateRequest

Properties:

  • certificate (string, required) - The certificate content in PEM format

  • name (string) - An optional name for the certificate

SEE ALSO

OpenAPI::Client::OpenAI::Path

COPYRIGHT AND LICENSE

Copyright (C) 2023-2026 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.