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(CertificateListParams**kwargs) -> SyncConversationCursorPage[CertificateListResponse]

GET/organization/certificates

Upload certificate

admin.organization.certificates.create(CertificateCreateParams**kwargs) -> Certificate

POST/organization/certificates

Get certificate

admin.organization.certificates.retrieve(strcertificate_id, CertificateRetrieveParams**kwargs) -> Certificate

GET/organization/certificates/{certificate_id}

Modify certificate

admin.organization.certificates.update(strcertificate_id, CertificateUpdateParams**kwargs) -> Certificate

POST/organization/certificates/{certificate_id}

Delete certificate

admin.organization.certificates.delete(strcertificate_id) -> CertificateDeleteResponse

DELETE/organization/certificates/{certificate_id}

Activate certificates for organization

admin.organization.certificates.activate(CertificateActivateParams**kwargs) -> SyncPage[CertificateActivateResponse]

POST/organization/certificates/activate

Deactivate certificates for organization

admin.organization.certificates.deactivate(CertificateDeactivateParams**kwargs) -> SyncPage[CertificateDeactivateResponse]

POST/organization/certificates/deactivate

ModelsExpand Collapse

class Certificate: …

Represents an individual certificate uploaded to the organization.

id: str

The identifier, which can be referenced in API endpoints

certificate_details: CertificateDetails

content: Optional[str]

The content of the certificate in PEM format.

expires_at: Optional[int]

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

formatunixtime

valid_at: Optional[int]

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

formatunixtime

created_at: int

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

formatunixtime

name: Optional[str]

The name of the certificate.

object: Literal["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: Optional[bool]

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

class CertificateListResponse: …

Represents an individual certificate configured at the organization level.

id: str

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: Optional[int]

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

formatunixtime

valid_at: Optional[int]

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

formatunixtime

created_at: int

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

formatunixtime

name: Optional[str]

The name of the certificate.

object: Literal["organization.certificate"]

The object type, which is always organization.certificate.

class CertificateDeleteResponse: …

id: str

The ID of the certificate that was deleted.

object: Literal["certificate.deleted"]

The object type, must be certificate.deleted.

class CertificateActivateResponse: …

Represents an individual certificate configured at the organization level.

id: str

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: Optional[int]

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

formatunixtime

valid_at: Optional[int]

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

formatunixtime

created_at: int

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

formatunixtime

name: Optional[str]

The name of the certificate.

object: Literal["organization.certificate"]

The object type, which is always organization.certificate.

class CertificateDeactivateResponse: …

Represents an individual certificate configured at the organization level.

id: str

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: Optional[int]

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

formatunixtime

valid_at: Optional[int]

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

formatunixtime

created_at: int

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

formatunixtime

name: Optional[str]

The name of the certificate.

object: Literal["organization.certificate"]

The object type, which is always organization.certificate.