Skip to content
Primary navigation

Suggested
API Dashboard
API Reference
Admin
Organization
Certificates

Modify certificate

client.admin.organization.certificates.update(stringcertificateID, CertificateUpdateParams { name } body, RequestOptionsoptions?): Certificate { id, certificate_details, created_at, 3 more }
POST/organization/certificates/{certificate_id}

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

ParametersExpand Collapse
certificateID: string
body: CertificateUpdateParams { name }
name?: string

The updated name for the certificate

ReturnsExpand Collapse
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?: number

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

formatunixtime
valid_at?: number

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

formatunixtime
created_at: number

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

formatunixtime
name: string | null

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?: boolean

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

Modify certificate

import OpenAI from 'openai';

const client = new OpenAI({
  adminAPIKey: process.env['OPENAI_ADMIN_KEY'], // This is the default and can be omitted
});

const certificate = await client.admin.organization.certificates.update('certificate_id');

console.log(certificate.id);
{
  "object": "certificate",
  "id": "cert_abc",
  "name": "Renamed Certificate",
  "created_at": 1234567,
  "certificate_details": {
    "valid_at": 12345667,
    "expires_at": 12345678
  }
}
Returns Examples
{
  "object": "certificate",
  "id": "cert_abc",
  "name": "Renamed Certificate",
  "created_at": 1234567,
  "certificate_details": {
    "valid_at": 12345667,
    "expires_at": 12345678
  }
}