Skip to content

Retrieve a certificate authority

Request

Early Access
OAuth 2.0 scope:
  • okta.certificateAuthorities.read

Retrieves a certificate authority (CA) by its authorityInstanceId.

The authorityInstanceId is stable across renewals, so this operation addresses the authority as a whole rather than one generation of it. Use expand=certificates to include every valid certificate the authority currently holds.

Path
authorityInstanceIdstring^[0-9A-F]+$required

The stable identifier of the certificate authority, in uppercase hexadecimal. It survives renewals and is the value embedded in the SCEP enrollment URL.

Query
expandstring(CertificateAuthorityExpand)

Set to certificates to include each authority's certificates in _embedded

Value:"certificates"
curl -i -X GET \
  'https://subdomain.okta.com/pki/api/v2/certificate-authorities/{authorityInstanceId}?expand=certificates'

Responses

OK

Bodyapplication/json
authorityInstanceIdstringread-only

The stable identifier of the authority. For the authority's original certificate, this is also that certificate's ski, because a CA's own subject key identifier becomes the authority's identifier when the CA is created.

caTypestring(CertificateAuthorityCaType)

The family of the certificate authority. OKTA_AS_CA is the Okta CA used for SCEP enrollment and device management attestation; DEVICE_ACCESS_OKTA_AS_CA is the Device Access CA. The caType query parameter filters on the same values.

Enum:"DEVICE_ACCESS_OKTA_AS_CA""OKTA_AS_CA"
statusstring(CertificateAuthorityCertificateStatus)read-only

The status of the certificate. VALID is in service and able to issue certificates, which is how Okta generates a replacement CA certificate. INACTIVE is a replacement that Okta generated but hasn't brought into service, which occurs only for an authority renewed before selective renewal was available; renewing such an authority activates it.

Enum:"INACTIVE""VALID"
subjectDNstringread-only

The distinguished name in the subject of the authority's certificate

typestring(CertificateAuthorityType)

The position of the certificate authority in the hierarchy. A root is self-signed; an intermediate is signed by the root and signs the certificates Okta issues to devices. The type query parameter filters on the same values.

Enum:"INTERMEDIATE""ROOT"
_embeddedobject(CertificateAuthorityEmbedded)read-only

Resources embedded in the authority. Present only when the request sets expand=certificates.

Response
{ "authorityInstanceId": "1699E4263D0DC9D9FDA0B6AAE1286E5F7B57ACCC", "type": "INTERMEDIATE", "caType": "OKTA_AS_CA", "status": "VALID", "subjectDN": "CN=Organization Intermediate Authority, OU=00o1a2b3c4D5e6F7g8h9, DC=example, DC=okta, DC=com" }