Skip to content
Primary navigation

Suggested
API Dashboard
API Reference
Admin
Organization
Certificates

Get certificate

Certificate admin().organization().certificates().retrieve(CertificateRetrieveParamsparams = CertificateRetrieveParams.none(), RequestOptionsrequestOptions = RequestOptions.none())
GET/organization/certificates/{certificate_id}

Get a certificate that has been uploaded to the organization.

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

ParametersExpand Collapse
CertificateRetrieveParams params
Optional<String> certificateId
Optional<List<Include>> include

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.

CONTENT("content")
ReturnsExpand Collapse
class Certificate:

Represents an individual certificate uploaded to the organization.

String id

The identifier, which can be referenced in API endpoints

CertificateDetails certificateDetails
Optional<String> content

The content of the certificate in PEM format.

Optional<Long> expiresAt

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

formatunixtime
Optional<Long> validAt

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

formatunixtime
long createdAt

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

formatunixtime
Optional<String> name

The name of the certificate.

Object object_

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("certificate")
ORGANIZATION_CERTIFICATE("organization.certificate")
ORGANIZATION_PROJECT_CERTIFICATE("organization.project.certificate")
Optional<Boolean> active

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

Get certificate

package com.openai.example;

import com.openai.client.OpenAIClient;
import com.openai.client.okhttp.OpenAIOkHttpClient;
import com.openai.models.admin.organization.certificates.Certificate;
import com.openai.models.admin.organization.certificates.CertificateRetrieveParams;

public final class Main {
    private Main() {}

    public static void main(String[] args) {
        OpenAIClient client = OpenAIOkHttpClient.fromEnv();

        Certificate certificate = client.admin().organization().certificates().retrieve("certificate_id");
    }
}
{
  "object": "certificate",
  "id": "cert_abc",
  "name": "My Example Certificate",
  "created_at": 1234567,
  "certificate_details": {
    "valid_at": 1234567,
    "expires_at": 12345678,
    "content": "-----BEGIN CERTIFICATE-----MIIDeT...-----END CERTIFICATE-----"
  }
}
Returns Examples
{
  "object": "certificate",
  "id": "cert_abc",
  "name": "My Example Certificate",
  "created_at": 1234567,
  "certificate_details": {
    "valid_at": 1234567,
    "expires_at": 12345678,
    "content": "-----BEGIN CERTIFICATE-----MIIDeT...-----END CERTIFICATE-----"
  }
}