API Reference

Admin

Organization

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Certificates

List organization certificates

admin.organization.certificates.list(**kwargs) -> ConversationCursorPage<CertificateListResponse { id, active, certificate_details, 3 more } >

GET/organization/certificates

Upload certificate

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

POST/organization/certificates

Get certificate

admin.organization.certificates.retrieve(certificate_id, **kwargs) -> Certificate { id, certificate_details, created_at, 3 more }

GET/organization/certificates/{certificate_id}

Modify certificate

admin.organization.certificates.update(certificate_id, **kwargs) -> Certificate { id, certificate_details, created_at, 3 more }

POST/organization/certificates/{certificate_id}

Delete certificate

admin.organization.certificates.delete(certificate_id) -> CertificateDeleteResponse { id, object }

DELETE/organization/certificates/{certificate_id}

Activate certificates for organization

admin.organization.certificates.activate(**kwargs) -> Page<CertificateActivateResponse { id, active, certificate_details, 3 more } >

POST/organization/certificates/activate

Deactivate certificates for organization

admin.organization.certificates.deactivate(**kwargs) -> Page<CertificateDeactivateResponse { id, active, certificate_details, 3 more } >

POST/organization/certificates/deactivate

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

class 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: bool

Whether the certificate is currently active at the organization level.

certificate_details: CertificateDetails{ expires_at, valid_at}

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

The object type, which is always organization.certificate.

class CertificateDeleteResponse { id, object }

id: String

The ID of the certificate that was deleted.

object: :"certificate.deleted"

The object type, must be certificate.deleted.

class 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: bool

Whether the certificate is currently active at the organization level.

certificate_details: CertificateDetails{ expires_at, valid_at}

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

The object type, which is always organization.certificate.

class 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: bool

Whether the certificate is currently active at the organization level.

certificate_details: CertificateDetails{ expires_at, valid_at}

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

The object type, which is always organization.certificate.