Skip to content
Primary navigation

Suggested
API Dashboard
API Reference
Admin
Organization
Certificates

Upload certificate

admin.organization.certificates.create(**kwargs) -> Certificate { id, certificate_details, created_at, 3 more }
POST/organization/certificates

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

Organizations can upload up to 50 certificates.

ParametersExpand Collapse
certificate: String

The certificate content in PEM format

name: String

An optional name for the certificate

ReturnsExpand Collapse
class Certificate { id, certificate_details, created_at, 3 more }

Represents an individual certificate uploaded to the organization.

id: String

The identifier, which can be referenced in API endpoints

certificate_details: CertificateDetails{ content, expires_at, valid_at}
content: String

The content of the certificate in PEM format.

expires_at: Integer

The Unix timestamp (in seconds) of when the certificate expires.

formatunixtime
valid_at: Integer

The Unix timestamp (in seconds) of when the certificate becomes valid.

formatunixtime
created_at: Integer

The Unix timestamp (in seconds) of when the certificate was uploaded.

formatunixtime
name: String

The name of the certificate.

object: :certificate | :"organization.certificate" | :"organization.project.certificate"

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.
One of the following:
:certificate
:"organization.certificate"
:"organization.project.certificate"
active: bool

Whether the certificate is currently active at the specified scope. Not returned when getting details for a specific certificate.

Upload certificate

require "openai"

openai = OpenAI::Client.new(admin_api_key: "My Admin API Key")

certificate = openai.admin.organization.certificates.create(certificate: "certificate")

puts(certificate)
{
  "object": "certificate",
  "id": "cert_abc",
  "name": "My Example Certificate",
  "created_at": 1234567,
  "certificate_details": {
    "valid_at": 12345667,
    "expires_at": 12345678
  }
}
Returns Examples
{
  "object": "certificate",
  "id": "cert_abc",
  "name": "My Example Certificate",
  "created_at": 1234567,
  "certificate_details": {
    "valid_at": 12345667,
    "expires_at": 12345678
  }
}