API Reference

Admin

Organization

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Certificates

List organization certificates

client.admin.organization.certificates.list(CertificateListParams { after, limit, order } query?, RequestOptionsoptions?): ConversationCursorPage<CertificateListResponse { id, active, certificate_details, 3 more } >

GET/organization/certificates

Upload certificate

client.admin.organization.certificates.create(CertificateCreateParams { certificate, name } body, RequestOptionsoptions?): Certificate { id, certificate_details, created_at, 3 more }

POST/organization/certificates

Get certificate

client.admin.organization.certificates.retrieve(stringcertificateID, CertificateRetrieveParams { include } query?, RequestOptionsoptions?): Certificate { id, certificate_details, created_at, 3 more }

GET/organization/certificates/{certificate_id}

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}

Delete certificate

client.admin.organization.certificates.delete(stringcertificateID, RequestOptionsoptions?): CertificateDeleteResponse { id, object }

DELETE/organization/certificates/{certificate_id}

Activate certificates for organization

client.admin.organization.certificates.activate(CertificateActivateParams { certificate_ids } body, RequestOptionsoptions?): Page<CertificateActivateResponse { id, active, certificate_details, 3 more } >

POST/organization/certificates/activate

Deactivate certificates for organization

client.admin.organization.certificates.deactivate(CertificateDeactivateParams { certificate_ids } body, RequestOptionsoptions?): Page<CertificateDeactivateResponse { id, active, certificate_details, 3 more } >

POST/organization/certificates/deactivate

ModelsExpand 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.

CertificateListResponse { id, active, certificate_details, 3 more }

Represents an individual certificate configured at the organization level.

id: string

The identifier, which can be referenced in API endpoints

active: boolean

Whether the certificate is currently active at the organization level.

certificate_details: CertificateDetails { expires_at, valid_at }

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: "organization.certificate"

The object type, which is always organization.certificate.

CertificateDeleteResponse { id, object }

id: string

The ID of the certificate that was deleted.

object: "certificate.deleted"

The object type, must be certificate.deleted.

CertificateActivateResponse { id, active, certificate_details, 3 more }

Represents an individual certificate configured at the organization level.

id: string

The identifier, which can be referenced in API endpoints

active: boolean

Whether the certificate is currently active at the organization level.

certificate_details: CertificateDetails { expires_at, valid_at }

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: "organization.certificate"

The object type, which is always organization.certificate.

CertificateDeactivateResponse { id, active, certificate_details, 3 more }

Represents an individual certificate configured at the organization level.

id: string

The identifier, which can be referenced in API endpoints

active: boolean

Whether the certificate is currently active at the organization level.

certificate_details: CertificateDetails { expires_at, valid_at }

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: "organization.certificate"

The object type, which is always organization.certificate.