Skip to content
Start here

SAML Certificates

List SAML certificate sets
client.zeroTrust.access.samlCertificates.list(SAMLCertificateListParams { account_id, id, page, per_page } params, RequestOptionsoptions?): V4PagePaginationArray<SAMLCertificateListResponse { created_at, uid, updated_at, 2 more } >
GET/accounts/{account_id}/access/saml_certificates
Get SAML certificate set
client.zeroTrust.access.samlCertificates.get(stringsamlCERTSetID, SAMLCertificateGetParams { account_id } params, RequestOptionsoptions?): SAMLCertificateGetResponse { created_at, uid, updated_at, 2 more }
GET/accounts/{account_id}/access/saml_certificates/{saml_cert_set_id}
Rotate SAML certificate
client.zeroTrust.access.samlCertificates.rotate(stringsamlCERTSetID, SAMLCertificateRotateParams { account_id } params, RequestOptionsoptions?): SAMLCertificateRotateResponse { created_at, uid, updated_at, 2 more }
POST/accounts/{account_id}/access/saml_certificates/{saml_cert_set_id}/rotate
Download current certificate in PEM format
client.zeroTrust.access.samlCertificates.getPem(stringsamlCERTSetID, SAMLCertificateGetPemParams { account_id } params, RequestOptionsoptions?): Response
GET/accounts/{account_id}/access/saml_certificates/{saml_cert_set_id}/pem
ModelsExpand Collapse
SAMLCertificateListResponse { created_at, uid, updated_at, 2 more }
created_at: string

When the certificate set was created

formatdate-time
uid: string

Unique identifier for the certificate set

updated_at: string

When the certificate set was last updated

formatdate-time
current_certificate?: CurrentCertificate { is_current, not_after, public_certificate, uid }

The current active certificate

is_current: boolean

Indicates whether the certificate can be used for IdP configuration.

not_after: string

Certificate expiration date

formatdate-time
public_certificate: string

The public certificate in PEM format

uid: string

Unique identifier for the certificate

previous_certificate?: unknown

The previous certificate (maintained during rotation period). May be null when no rotation has occurred. Mirrors the structure of saml_certificate.

SAMLCertificateGetResponse { created_at, uid, updated_at, 2 more }
created_at: string

When the certificate set was created

formatdate-time
uid: string

Unique identifier for the certificate set

updated_at: string

When the certificate set was last updated

formatdate-time
current_certificate?: CurrentCertificate { is_current, not_after, public_certificate, uid }

The current active certificate

is_current: boolean

Indicates whether the certificate can be used for IdP configuration.

not_after: string

Certificate expiration date

formatdate-time
public_certificate: string

The public certificate in PEM format

uid: string

Unique identifier for the certificate

previous_certificate?: unknown

The previous certificate (maintained during rotation period). May be null when no rotation has occurred. Mirrors the structure of saml_certificate.

SAMLCertificateRotateResponse { created_at, uid, updated_at, 2 more }
created_at: string

When the certificate set was created

formatdate-time
uid: string

Unique identifier for the certificate set

updated_at: string

When the certificate set was last updated

formatdate-time
current_certificate?: CurrentCertificate { is_current, not_after, public_certificate, uid }

The current active certificate

is_current: boolean

Indicates whether the certificate can be used for IdP configuration.

not_after: string

Certificate expiration date

formatdate-time
public_certificate: string

The public certificate in PEM format

uid: string

Unique identifier for the certificate

previous_certificate?: unknown

The previous certificate (maintained during rotation period). May be null when no rotation has occurred. Mirrors the structure of saml_certificate.