openapi: 3.2.0 info: description: API for managing certificates. title: Certificates Service Management Certificates Management API version: '20210224' x-provenance: method: harvested first_party: true publisher: Oracle source: https://docs.oracle.com/en-us/iaas/api/specs/453c802bd9e7ec3f5186cd5a732084236e024b99054d7d7d3f17d999f9cb3836.yaml harvested: '2026-08-04' note: Published by Oracle as the contract for the Certificates Service Management API OCI service and stored verbatim; API Evangelist added only this provenance block. x-evidence: - url: https://docs.oracle.com/en-us/iaas/api/specs/index.json what: Oracle's own index of every OCI service specification - url: https://docs.oracle.com/en-us/iaas/api/specs/453c802bd9e7ec3f5186cd5a732084236e024b99054d7d7d3f17d999f9cb3836.yaml what: the harvested document for Certificates Service Management API servers: - url: https://certificatesmanagement.$region.oci.oraclecloud.com/20210224 tags: - description: Certificates Service Management API name: certificatesManagement paths: /associations: get: description: 'Lists all associations that match the query parameters. Optionally, you can use the parameter `FilterByAssociationIdQueryParam` to limit the result set to a single item that matches the specified association. ' operationId: ListAssociations parameters: - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/CertificatesResourceIdQueryParam' - $ref: '#/components/parameters/AssociatedResourceIdQueryParam' - $ref: '#/components/parameters/FilterByAssociationIdQueryParam' - $ref: '#/components/parameters/FilterByNameQueryParam' - $ref: '#/components/parameters/SortByQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/AssociationTypeQueryParam' responses: 200: description: A list of association summary objects. headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then there are additional items still to get. Include this value as the `page` parameter for the subsequent GET request. For information about pagination, see [List Pagination](/Content/API/Concepts/usingapi.htm#List_Pagination). ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/AssociationCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Lists all associations. tags: - certificatesManagement x-example: 'GET /20210224/associations?compartmentId=<compartmentOCID> Host: certificates.us-ashburn-1.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/AssociationSummary' /associations/{associationId}: get: description: Gets details about the specified association. operationId: GetAssociation parameters: - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/AssociationIdRequiredPathParam' responses: 200: description: The specified association object. headers: etag: description: For optimistic concurrency control. See `if-match`. schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Association' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Gets an association. tags: - certificatesManagement x-example: 'GET /20210224/associations/<associationOCID> Host: certificates.us-ashburn-1.oraclecloud.com <authorization and other headers> ' /caBundles: get: description: 'Lists all CA bundles that match the query parameters. Optionally, you can use the parameter `FilterByCaBundleIdQueryParam` to limit the result set to a single item that matches the specified CA bundle. ' operationId: ListCaBundles parameters: - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/CaBundleLifecycleStateQueryParam' - $ref: '#/components/parameters/FilterByNameQueryParam' - $ref: '#/components/parameters/SortByQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/FilterByCaBundleIdQueryParam' responses: 200: description: A list of CA bundle summary objects. headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then there are additional items still to get. Include this value as the `page` parameter for the subsequent GET request. For information about pagination, see [List Pagination](/Content/API/Concepts/usingapi.htm#List_Pagination). ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/CaBundleCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Lists all CA bundles. tags: - certificatesManagement x-example: 'GET /20210224/caBundles?compartmentId=<compartmentId> Host: certificates.us-ashburn-1.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/CaBundleSummary' post: description: Creates a new CA bundle according to the details of the request. operationId: CreateCaBundle parameters: - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 200: description: The CA bundle has been created. headers: etag: description: For optimistic concurrency control. See `if-match`. schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/CaBundle' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Creates a CA bundle. tags: - certificatesManagement x-example: "POST /20210224/caBundles\nHost: certificates.us-ashburn-1.oraclecloud.com\n<authorization and other headers>\n{\n \"caBundlePem\": \"-----BEGIN PUBLIC KEY-----\\<keycontents>\\n-----END PUBLIC KEY-----\\n\",\n \"compartmentId\": \"ocid1.compartment.oc1..exampleawwcufihrc62gpbcvbjizswgoj4w7rg5q4fwbg2fauxvlcxbtliaa\",\n \"definedTags\": {},\n \"freeformTags\": {},\n \"name\": \"test-ca-bundle\"\n}\n" x-related-resource: '#/definitions/CaBundle' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateCaBundleDetails' description: The details of the request to create a new CA bundle. required: true /caBundles/{caBundleId}: delete: description: Deletes the specified CA bundle. operationId: DeleteCaBundle parameters: - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/CaBundleIdRequiredPathParam' responses: 204: description: The CA bundle has been deleted. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Deletes a CA bundle. tags: - certificatesManagement x-example: 'DELETE /20210224/caBundles/<caBundleOCID> Host: certificates.us-ashburn-1.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/CaBundle' get: description: Gets details about the specified CA bundle. operationId: GetCaBundle parameters: - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/CaBundleIdRequiredPathParam' responses: 200: description: The specified CA bundle object. headers: etag: description: For optimistic concurrency control. See `if-match`. schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/CaBundle' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Gets a CA bundle. tags: - certificatesManagement x-example: 'GET /20210224/caBundles/lt;caBundleOCID> Host: certificates.us-ashburn-1.oraclecloud.com <authorization and other headers> ' put: description: Updates the properties of a CA bundle. operationId: UpdateCaBundle parameters: - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/CaBundleIdRequiredPathParam' responses: 200: description: The updated CA bundle object. headers: etag: description: For optimistic concurrency control. See `if-match`. schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/CaBundle' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Updates a CA bundle's properties. tags: - certificatesManagement x-example: "PUT /20210224/caBundles/lt;caBundleOCID>\nHost: certificates.us-ashburn-1.oraclecloud.com\n<authorization and other headers>\n{\n \"caBundlePem\": \"-----BEGIN PUBLIC KEY-----\\<keycontents>\\n-----END PUBLIC KEY-----\\n\",\n \"definedTags\": {},\n \"freeformTags\": {},\n \"description\": \"new description for Test CA Bundle\"\n}\n" requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateCaBundleDetails' description: The details of the request to update a CA bundle. required: true /caBundles/{caBundleId}/actions/changeCompartment: post: description: 'Moves a CA bundle to a different compartment in the same tenancy. For information about moving resources between compartments, see [Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes). When provided, if-match is checked against the ETag values of the secret. ' operationId: ChangeCaBundleCompartment parameters: - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/CaBundleIdRequiredPathParam' responses: 204: description: The compartment information for the CA bundle has been updated. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Moves a CA bundle to a different compartment. tags: - certificatesManagement x-example: "POST /20210224/caBundles/<caBundleOCID>/actions/changeCompartment\nHost: certificates.us-ashburn-1.oraclecloud.com\n<authorization and other headers>\n{\n \"compartmentId\" : \"ocid1.tenancy.oc1..exampleauingds4uwkcvbxv4ijs7zxuqnoewldef4fauxs7vaax2fab4gcsq\"\n}\n" x-related-resource: '#/definitions/CaBundle' requestBody: content: application/json: schema: $ref: '#/components/schemas/ChangeCaBundleCompartmentDetails' description: The updated compartment details. required: true /certificateAuthorities: get: description: 'Lists all certificate authorities (CAs) in the specified compartment. Optionally, you can use the parameter `FilterByCertificateAuthorityIdQueryParam` to limit the results to a single item that matches the specified CA. ' operationId: ListCertificateAuthorities parameters: - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/CertificateAuthorityLifecycleStateQueryParam' - $ref: '#/components/parameters/FilterByNameQueryParam' - $ref: '#/components/parameters/FilterByIssuerCertificateAuthorityIdQueryParam' - $ref: '#/components/parameters/FilterByCertificateAuthorityIdQueryParam' - $ref: '#/components/parameters/CertificateAuthoritySortByQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' responses: 200: description: A list of CA summary objects. headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then there are additional items still to get. Include this value as the `page` parameter for the subsequent GET request. For information about pagination, see [List Pagination](/Content/API/Concepts/usingapi.htm#List_Pagination). ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/CertificateAuthorityCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: List all certificate authorities. tags: - certificatesManagement x-example: 'GET /20210224/certificateAuthorities?compartmentId=<compartmentId> Host: certificates.us-ashburn-1.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/CertificateAuthoritySummary' post: description: Creates a new certificate authority (CA) according to the details of the request. operationId: CreateCertificateAuthority parameters: - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 200: description: The new CA object. headers: etag: description: For optimistic concurrency control. See `if-match`. schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/CertificateAuthority' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Creates a certificate authority. tags: - certificatesManagement x-example: "POST /20210224/certificateAuthorities\nHost: certificates.us-ashburn-1.oraclecloud.com\n<authorization and other headers>\n{\n \"certificateAuthorityConfig\": {\n \"configType\": \"ROOT_CA_GENERATED_INTERNALLY\",\n \"signingAlgorithm\": \"SHA512_WITH_RSA\",\n \"subject\": {\n \"commonName\": \"www.example.com\"\n },\n \"validity\": {\n \"timeOfValidityNotAfter\": \"2031-05-06T00:00:00.000Z\"\n }\n },\n \"certificateAuthorityRules\": [\n {\n \"advanceRenewalPeriod\": \"P30D\",\n \"renewalInterval\": \"P3650D\",\n \"ruleType\": \"CERTIFICATE_AUTHORITY_RENEWAL_RULE\"\n }\n ],\n \"certificateRevocationListDetails\": {\n \"objectStorageConfig\": {\n \"objectStorageBucketName\": \"ca-crl-bucket\",\n \"objectStorageNamespace\": \"example-namespace\",\n \"objectStorageObjectNameFormat\": \"ca-1-crl\"\n }\n },\n \"compartmentId\": \"ocid1.tenancy.oc1..exampleauingds4uwkcvbxv4ijs7zxuqnoewldef4fauxs7vaax2fab4gcsq\",\n \"definedTags\": {},\n \"freeformTags\": {},\n \"kmsKeyId\": \"ocid1.key.oc1.iad.examplegaag4s.abzwkljsd4iacvbv3s2e57hhwyljoc2zfxcgugfauxafqyxm7ljawezfc3cq\",\n \"name\": \"test-ca-1\"\n}\n" x-related-resource: '#/definitions/CertificateAuthority' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateCertificateAuthorityDetails' description: The details of the request to create a new CA. required: true /certificateAuthorities/{certificateAuthorityId}: get: description: Gets details about the specified certificate authority (CA). operationId: GetCertificateAuthority parameters: - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/CertificateAuthorityIdRequiredPathParam' responses: 200: description: The specified CA object. headers: etag: description: For optimistic concurrency control. See `if-match`. schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/CertificateAuthority' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Gets a certificate authority. tags: - certificatesManagement x-example: 'GET /20210224/certificateAuthorities/<certificateAuthorityOCID> Host: certificates.us-ashburn-1.oraclecloud.com <authorization and other headers> ' put: description: Updates the properties of the specified certificate authority (CA). operationId: UpdateCertificateAuthority parameters: - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/CertificateAuthorityIdRequiredPathParam' responses: 200: description: The updated CA object. headers: etag: description: For optimistic concurrency control. See `if-match`. schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/CertificateAuthority' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Updates a certificate authority. tags: - certificatesManagement x-example: 'PUT /20210224/certificateAuthorities/<certificateAuthorityOCID> Host: certificates.us-ashburn-1.oraclecloud.com <authorization and other headers> { "description" : "updated description for this certificate authority" } ' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateCertificateAuthorityDetails' description: The details of the request to update a CA. required: true /certificateAuthorities/{certificateAuthorityId}/actions/cancelDeletion: post: description: Cancels the scheduled deletion of the specified certificate authority (CA). operationId: CancelCertificateAuthorityDeletion parameters: - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/CertificateAuthorityIdRequiredPathParam' responses: 204: description: The scheduled deletion of this CA has been canceled. headers: etag: description: For optimistic concurrency control. See `if-match`. schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Cancels a scheduled certificate authority deletion. tags: - certificatesManagement x-example: 'POST /20210224/certificateAuthorities/<certificateAuthorityOCID>/actions/cancelDeletion Host: certificates.us-ashburn-1.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/CertificateAuthority' /certificateAuthorities/{certificateAuthorityId}/actions/changeCompartment: post: description: 'Moves a certificate authority (CA) to a different compartment within the same tenancy. For information about moving resources between compartments, see [Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes). When provided, If-Match is checked against the ETag values of the source. ' operationId: ChangeCertificateAuthorityCompartment parameters: - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/CertificateAuthorityIdRequiredPathParam' responses: 204: description: The compartment for the CA has been updated. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Moves a certificate authority to a different compartment. tags: - certificatesManagement x-example: "POST /20210224/certificateAuthorities/<certificateAuthorityOCID>/actions/changeCompartment\nHost: certificates.us-ashburn-1.oraclecloud.com\n<authorization and other headers>\n{ \n \"compartmentId\" : \"ocid1.compartment.oc1..exampleawwcufihrc62gpbcvbjizswgoj4w7rg5q4fwbg2fauxvlcxbtliaa\"\n}\n" x-related-resource: '#/definitions/CertificateAuthority' requestBody: content: application/json: schema: $ref: '#/components/schemas/ChangeCertificateAuthorityCompartmentDetails' description: The updated compartment details required: true /certificateAuthorities/{certificateAuthorityId}/actions/scheduleDeletion: post: description: 'Schedules the deletion of the specified certificate authority (CA). This sets the lifecycle state of the CA to `PENDING_DELETION` and then deletes it after the specified retention period ends. If needed, you can determine the status of the deletion by using `GetCertificateAuthority`. ' operationId: ScheduleCertificateAuthorityDeletion parameters: - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/CertificateAuthorityIdRequiredPathParam' responses: 204: description: 'The CA has been scheduled for deletion. ' headers: etag: description: For optimistic concurrency control. See `if-match`. schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Schedules a certificate authority deletion. tags: - certificatesManagement x-example: "POST /20210224/certificateAuthorities/<certificateAuthorityOCID>/actions/scheduleDeletion\nHost: certificates.us-ashburn-1.oraclecloud.com\n<authorization and other headers>\n{\n \"timeOfDeletion\" : \"2021-05-06T00:00:00.000Z\"\n}\n" x-related-resource: '#/definitions/CertificateAuthority' requestBody: content: application/json: schema: $ref: '#/components/schemas/ScheduleCertificateAuthorityDeletionDetails' description: The details of the request to schedule the deletion of a CA. required: true /certificateAuthorities/{certificateAuthorityId}/version/{certificateAuthorityVersionNumber}: get: description: Gets details about the specified certificate authority (CA) version. operationId: GetCertificateAuthorityVersion parameters: - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/CertificateAuthorityIdRequiredPathParam' - $ref: '#/components/parameters/CertificateAuthorityVersionNumberRequiredPathParam' responses: 200: description: The specified CA version object. headers: etag: description: For optimistic concurrency control. See `if-match`. schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/CertificateAuthorityVersion' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Gets a certificate authority version. tags: - certificatesManagement x-example: 'GET /20210224/certificateAuthorities/<certificateAuthorityOCID>/version/<versionNumber> Host: certificates.us-ashburn-1.oraclecloud.com <authorization and other headers> ' /certificateAuthorities/{certificateAuthorityId}/version/{certificateAuthorityVersionNumber}/actions/cancelDeletion: post: description: 'Cancels the scheduled deletion of the specified certificate authority (CA) version. Canceling a scheduled deletion restores the CA version''s lifecycle state to what it was before its scheduled deletion. ' operationId: CancelCertificateAuthorityVersionDeletion parameters: - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/CertificateAuthorityIdRequiredPathParam' - $ref: '#/components/parameters/CertificateAuthorityVersionNumberRequiredPathParam' responses: 204: description: The scheduled deletion of the CA version has been canceled. headers: etag: description: For optimistic concurrency control. See `if-match`. schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Cancels a scheduled certificate authority version deletion. tags: - certificatesManagement x-example: 'POST 20210224/certificateAuthorities/<certificateAuthorityOCID>/version/<versionNumber>/actions/cancelDeletion Host: certificates.us-ashburn-1.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/CertificateAuthorityVersion' /certificateAuthorities/{certificateAuthorityId}/version/{certificateAuthorityVersionNumber}/actions/revoke: post: description: Revokes a certificate authority (CA) version. operationId: RevokeCertificateAuthorityVersion parameters: - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/CertificateAuthorityIdRequiredPathParam' - $ref: '#/components/parameters/CertificateAuthorityVersionNumberRequiredPathParam' responses: 204: description: The CA version has been revoked. headers: etag: description: For optimistic concurrency control. See `if-match`. schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Revokes a certificate authority version. tags: - certificatesManagement x-example: "POST /20210224/certificateAuthorities/<certificateAuthorityOCID>/version/<versionNumber>/actions/revoke\nHost: certificates.us-ashburn-1.oraclecloud.com\n<authorization and other headers>\n{\n \"revocationReason\" : \"AFFILIATION_CHANGED\"\n}\n" x-related-resource: '#/definitions/CertificateAuthorityVersion' requestBody: content: application/json: schema: $ref: '#/components/schemas/RevokeCertificateAuthorityVersionDetails' description: 'The details of the request to revoke a CA version. ' required: true /certificateAuthorities/{certificateAuthorityId}/version/{certificateAuthorityVersionNumber}/actions/scheduleDeletion: post: description: 'Schedules the deletion of the specified certificate authority (CA) version. This sets the lifecycle state of the CA version to `PENDING_DELETION` and then deletes it after the specified retention period ends. If needed, you can determine the status of the deletion by using `GetCertificateAuthorityVersion`. ' operationId: ScheduleCertificateAuthorityVersionDeletion parameters: - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/CertificateAuthorityIdRequiredPathParam' - $ref: '#/components/parameters/CertificateAuthorityVersionNumberRequiredPathParam' responses: 204: description: The CA version has been scheduled for deletion. headers: etag: description: For optimistic concurrency control. See `if-match`. schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Schedules a certificate authority version deletion. tags: - certificatesManagement x-example: "POST /20210224/certificateAuthorities/<certificateAuthorityOCID>/version/<versionNumber>/actions/scheduleDeletion\nHost: certificates.us-ashburn-1.oraclecloud.com\n<authorization and other headers>\n{\n \"timeOfDeletion\" : \"2021-05-06T00:00:00.000Z\"\n}\n" x-related-resource: '#/definitions/CertificateAuthorityVersion' requestBody: content: application/json: schema: $ref: '#/components/schemas/ScheduleCertificateAuthorityVersionDeletionDetails' description: 'The details of the request to delete a CA version. ' required: true /certificateAuthorities/{certificateAuthorityId}/versions: get: description: 'Lists all versions for the specified certificate authority (CA). Optionally, you can use the parameter `FilterByVersionNumberQueryParam` to limit the results to a single item that matches the specified version number. ' operationId: ListCertificateAuthorityVersions parameters: - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/CertificateAuthorityIdRequiredPathParam' - $ref: '#/components/parameters/FilterByVersionNumberQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/VersionSortByQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' responses: 200: description: A list of CA version summary objects. headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then there are additional items still to get. Include this value as the `page` parameter for the subsequent GET request. For information about pagination, see [List Pagination](/Content/API/Concepts/usingapi.htm#List_Pagination). ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/CertificateAuthorityVersionCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Lists all certificate authority versions. tags: - certificatesManagement x-example: 'GET /20210224/certificateAuthorities/<certificateAuthorityOCID>/versions Host: certificates.us-ashburn-1.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/CertificateAuthorityVersionSummary' /certificates: get: description: 'Lists all certificates that match the query parameters. Optionally, you can use the parameter `FilterByCertificateIdQueryParam` to limit the result set to a single item that matches the specified certificate. ' operationId: ListCertificates parameters: - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/CertificateLifecycleStateQueryParam' - $ref: '#/components/parameters/FilterByNameQueryParam' - $ref: '#/components/parameters/CertificateSortByQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/FilterByIssuerCertificateAuthorityIdQueryParam' - $ref: '#/components/parameters/FilterByCertificateIdQueryParam' responses: 200: description: A list of certificate summary objects. headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then there are additional items still to get. Include this value as the `page` parameter for the subsequent GET request. For information about pagination, see [List Pagination](/Content/API/Concepts/usingapi.htm#List_Pagination). ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/CertificateCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Lists all certificates. tags: - certificatesManagement x-example: 'GET /20210224/certificates?compartmentId=<compartmentId> Host: certificates.us-ashburn-1.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/CertificateSummary' post: description: Creates a new certificate according to the details of the request. operationId: CreateCertificate parameters: - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 200: description: The certificate has been created. headers: etag: description: For optimistic concurrency control. See `if-match`. schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Certificate' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Creates a certificate. tags: - certificatesManagement x-example: "POST /20210224/certificates\nHost: certificates.us-ashburn-1.oraclecloud.com\n<authorization and other headers>\n{\n \"certificateConfig\": {\n \"certificateProfileType\": \"TLS_SERVER_OR_CLIENT\",\n \"configType\": \"ISSUED_BY_INTERNAL_CA\",\n \"issuerCertificateAuthorityId\": \"ocid1.certificateauthority.oc1.iad.exampleae47ajxya5r64cqhcvbhd7vn4ifypr3wn3lqkfhjxfauxqohfpmoa\",\n \"keyAlgorithm\": \"RSA2048\",\n \"subject\": {\n \"commonName\": \"www.example.com\"\n },\n \"validity\": {\n \"timeOfValidityNotAfter\": \"2022-05-06T00:00:00.000Z\"\n }\n },\n \"certificateRules\": [\n {\n \"advanceRenewalPeriod\": \"P30D\",\n \"renewalInterval\": \"P365D\",\n \"ruleType\": \"CERTIFICATE_RENEWAL_RULE\"\n }\n ],\n \"compartmentId\": \"ocid1.compartment.oc1..exampleawwcufihrc62gpbcvbjizswgoj4w7rg5q4fwbg2fauxvlcxbtliaa\",\n \"definedTags\": {},\n \"freeformTags\": {},\n \"name\": \"test-cert\"\n}\n" x-related-resource: '#/definitions/Certificate' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateCertificateDetails' description: The details of the request to create a new certificate. required: true /certificates/{certificateId}: get: description: Gets details about the specified certificate. operationId: GetCertificate parameters: - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/CertificateIdRequiredPathParam' responses: 200: description: The specified certificate object. headers: etag: description: For optimistic concurrency control. See `if-match`. schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Certificate' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Gets a certificate. tags: - certificatesManagement x-example: 'GET /20210224/certificates/<certificateOCID> Host: certificates.us-ashburn-1.oraclecloud.com <authorization and other headers> ' put: description: Updates the properties of a certificate. operationId: UpdateCertificate parameters: - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/CertificateIdRequiredPathParam' responses: 200: description: The updated certificate object. headers: etag: description: For optimistic concurrency control. See `if-match`. schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Certificate' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Updates a certificate's properties. tags: - certificatesManagement x-example: "PUT /20210224/certificates/<certificateOCID>\nHost: certificates.us-ashburn-1.oraclecloud.com\n<authorization and other headers>\n{\n \"description\" : \"new certificate description\"\n}\n" requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateCertificateDetails' description: The details of the request to update a certificate. required: true /certificates/{certificateId}/actions/cancelDeletion: post: description: 'Cancels the pending deletion of the specified certificate. Canceling a scheduled deletion restores the certificate''s lifecycle state to what it was before you scheduled the certificate for deletion. ' operationId: CancelCertificateDeletion parameters: - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/CertificateIdRequiredPathParam' responses: 204: description: The certificate's scheduled deletion has been canceled. headers: etag: description: For optimistic concurrency control. See `if-match`. schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Cancels a scheduled certificate deletion. tags: - certificatesManagement x-example: 'POST /20210224/certificates/<certificateOCID>/actions/cancelDeletion Host: certificates.us-ashburn-1.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/Certificate' /certificates/{certificateId}/actions/changeCompartment: post: description: 'Moves a certificate to a different compartment within the same tenancy. For information about moving resources between compartments, see [Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes). When provided, if-match is checked against the ETag values of the secret. ' operationId: ChangeCertificateCompartment parameters: - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/CertificateIdRequiredPathParam' responses: 204: description: The compartment information for the certificate has been updated. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Moves a certificate to a different compartment. tags: - certificatesManagement x-example: "POST /20210224/certificates/<certificateOCID>/actions/changeCompartment\nHost: certificates.us-ashburn-1.oraclecloud.com\n<authorization and other headers>\n{\n \"compartmentId\" : \"ocid1.tenancy.oc1..exampleauingds4uwkcvbxv4ijs7zxuqnoewldef4fauxs7vaax2fab4gcsq\"\n}\n" x-related-resource: '#/definitions/Certificate' requestBody: content: application/json: schema: $ref: '#/components/schemas/ChangeCertificateCompartmentDetails' description: The updated compartment details. required: true /certificates/{certificateId}/actions/scheduleDeletion: post: description: 'Schedules the deletion of the specified certificate. This sets the lifecycle state of the certificate to `PENDING_DELETION` and then deletes it after the specified retention period ends. You can subsequently use `GetCertificate` to determine the current deletion status. ' operationId: ScheduleCertificateDeletion parameters: - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/CertificateIdRequiredPathParam' responses: 204: description: The certificate has been scheduled for deletion. headers: etag: description: For optimistic concurrency control. See `if-match`. schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Schedules the deletion of a certificate. tags: - certificatesManagement x-example: "POST /20210224/certificates/<certificateOCID>/actions/scheduleDeletion\nHost: certificates.us-ashburn-1.oraclecloud.com\n<authorization and other headers>\n{\n \"timeOfDeletion\" : \"2021-05-06T00:00:00.000Z\"\n}\n" x-related-resource: '#/definitions/Certificate' requestBody: content: application/json: schema: $ref: '#/components/schemas/ScheduleCertificateDeletionDetails' description: 'The details of the request to schedule a certificate deletion. This sets the lifecycle state of the certificate to `PENDING_DELETION` and then deletes it after the specified retention period ends. You can subsequently use `GetCertificate` to determine the current deletion status. ' required: true /certificates/{certificateId}/version/{certificateVersionNumber}: get: description: Gets details about the specified version of a certificate. operationId: GetCertificateVersion parameters: - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/CertificateIdRequiredPathParam' - $ref: '#/components/parameters/CertificateVersionNumberRequiredPathParam' responses: 200: description: The specified certificate version object. headers: etag: description: For optimistic concurrency control. See `if-match`. schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/CertificateVersion' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Gets a certificate version. tags: - certificatesManagement x-example: 'GET /20210224/certificates/<certificateOCID>/version/<versionNumber> Host: certificates.us-ashburn-1.oraclecloud.com <authorization and other headers> ' /certificates/{certificateId}/version/{certificateVersionNumber}/actions/cancelDeletion: post: description: Cancels the scheduled deletion of the specified certificate version. operationId: CancelCertificateVersionDeletion parameters: - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/CertificateIdRequiredPathParam' - $ref: '#/components/parameters/CertificateVersionNumberRequiredPathParam' responses: 204: description: The scheduled certificate version deletion has been canceled. headers: etag: description: For optimistic concurrency control. See `if-match`. schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Cancels a scheduled certificate version deletion. tags: - certificatesManagement x-example: 'POST /20210224/certificates/<certificateOCID>/version/<certificateVersionNumber>/actions/cancelDeletion Host: certificates.us-ashburn-1.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/CertificateVersion' /certificates/{certificateId}/version/{certificateVersionNumber}/actions/revoke: post: description: Revokes the specified certificate version. operationId: RevokeCertificateVersion parameters: - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/CertificateIdRequiredPathParam' - $ref: '#/components/parameters/CertificateVersionNumberRequiredPathParam' responses: 204: description: The certificate version has been revoked. headers: etag: description: For optimistic concurrency control. See `if-match`. schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Revokes a certificate version. tags: - certificatesManagement x-example: "POST /20210224/certificates/<certificateOCID>/version/<certificateVersionNumber>/actions/revoke\nHost: certificates.us-ashburn-1.oraclecloud.com\n<authorization and other headers>\n{\n \"revocationReason\" : \"KEY_COMPROMISE\"\n}\n" x-related-resource: '#/definitions/CertificateVersion' requestBody: content: application/json: schema: $ref: '#/components/schemas/RevokeCertificateVersionDetails' description: 'The details of the request to revoke a certificate version. ' required: true /certificates/{certificateId}/version/{certificateVersionNumber}/actions/scheduleDeletion: post: description: 'Schedules the deletion of the specified certificate version. This sets the lifecycle state of the certificate version to `PENDING_DELETION` and then deletes it after the specified retention period ends. You can only delete a certificate version if the certificate version rotation state is marked as `DEPRECATED`. You can subsequently use `GetCertificateVersion` to determine the current certificate version deletion status. ' operationId: ScheduleCertificateVersionDeletion parameters: - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/CertificateIdRequiredPathParam' - $ref: '#/components/parameters/CertificateVersionNumberRequiredPathParam' responses: 204: description: 'The certificate version has been scheduled for deletion. ' headers: etag: description: For optimistic concurrency control. See `if-match`. schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Schedules the deletion of a certificate version. tags: - certificatesManagement x-example: "POST /20210224/certificates/<certificateOCID>/version1/<certificateVersionNumber>/actions/scheduleDeletion\nHost: certificates.us-ashburn-1.oraclecloud.com\n<authorization and other headers>\n{\n \"timeOfDeletion\" : \"2021-05-06T00:00:00.000Z\"\n}\n" x-related-resource: '#/definitions/CertificateVersion' requestBody: content: application/json: schema: $ref: '#/components/schemas/ScheduleCertificateVersionDeletionDetails' description: 'The details of the request to delete a certificate version. ' required: true /certificates/{certificateId}/versions: get: description: 'Lists all certificate versions for the specified certificate. Optionally, you can use the parameter `FilterByVersionNumberQueryParam` to limit the result set to a single item that matches the specified version number. ' operationId: ListCertificateVersions parameters: - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/CertificateIdRequiredPathParam' - $ref: '#/components/parameters/FilterByVersionNumberQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/VersionSortByQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' responses: 200: description: A list of certificate version summary objects. headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then there are additional items still to get. Include this value as the `page` parameter for the subsequent GET request. For information about pagination, see [List Pagination](/Content/API/Concepts/usingapi.htm#List_Pagination). ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/CertificateVersionCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Lists all certificate versions for a certificate. tags: - certificatesManagement x-example: 'GET /20210224/certificates/<certificateOCID>/versions Host: certificates.us-ashburn-1.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/CertificateVersionSummary' components: schemas: CertificateAuthorityVersionSummary: description: The metadata details of the certificate authority (CA) version. This summary object does not contain the CA contents. properties: certificateAuthorityId: description: The OCID of the CA. maxLength: 255 minLength: 1 type: string issuerCaVersionNumber: description: The version number of the issuing CA. format: int64 minimum: 1 type: integer revocationStatus: $ref: '#/components/schemas/RevocationStatus' serialNumber: description: 'A unique certificate identifier used in certificate revocation tracking, formatted as octets. Example: `03 AC FC FA CC B3 CB 02 B8 F8 DE F5 85 E7 7B FF` ' maxLength: 59 minLength: 2 type: string stages: description: A list of rotation states for this CA version. items: $ref: '#/components/schemas/VersionStage' type: array timeCreated: description: 'A optional property indicating when the CA version was created, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. Example: `2019-04-03T21:10:29.600Z` ' format: date-time type: string timeOfDeletion: default: null description: 'An optional property indicating when to delete the CA version, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. Example: `2019-04-03T21:10:29.600Z` ' format: date-time type: string validity: $ref: '#/components/schemas/Validity' versionName: default: null description: 'The name of the CA version. When this value is not null, the name is unique across CA versions for a given CA. ' maxLength: 50 minLength: 1 type: string versionNumber: description: The version number of the CA. format: int64 minimum: 1 type: integer required: - certificateAuthorityId - timeCreated - versionNumber - stages type: object x-example: "{\n \"certificateAuthorityId\": \"ocid1.certificateauthority.oc1.iad.exampleae47ajxyaovlvo7eycvb6jgblgmvdaixez2rrfauxov2v6wplhjiq\",\n \"issuerCaVersionNumber\": null,\n \"serialNumber\": \"1234567894183178072847116123235304931087123456789\",\n \"timeCreated\": \"2021-04-06T22:11:58.288Z\",\n \"versionNumber\": 1,\n \"versionName\": null,\n \"timeOfDeletion\": null,\n \"validity\": {\n \"timeOfValidityNotBefore\": \"2021-04-06T22:11:58.008Z\",\n \"timeOfValidityNotAfter\": \"2031-05-06T00:00:00.000Z\"\n },\n \"stages\": [\n \"CURRENT\",\n \"LATEST\"\n ],\n \"revocationStatus\": null\n }\n" CertificateSubjectAlternativeName: description: 'A subject alternative name for the certificate that binds additional or alternate names to the subject of the certificate. In the certificate, the alternate subject name format is "type:name". ' properties: type: description: The subject alternative name type. Currently only DNS domain or host names and IP addresses are supported. enum: - DNS - IP type: string value: description: The subject alternative name. minLength: 1 type: string required: - type - value type: object Error: description: A response error. properties: code: description: 'A short error code that defines the error, meant for programmatic parsing. See [API Errors](/Content/API/References/apierrors.htm). ' type: string message: description: A human-readable error string. type: string required: - code - message ChangeCaBundleCompartmentDetails: description: The details of the request to change compartments for the CA bundle. properties: compartmentId: description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment into which the CA bundle should move. ' maxLength: 255 minLength: 1 type: string required: - compartmentId type: object x-example: "{\n \"compartmentId\" : \"ocid1.tenancy.oc1..exampleauingds4uwkcvbxv4ijs7zxuqnoewldef4fauxs7vaax2fab4gcsq\"\n}\n" CertificateCollection: description: The results of a certificate search. This object contains certificate summary objects and other data. properties: items: description: A list of certificate summary objects. items: $ref: '#/components/schemas/CertificateSummary' type: array required: - items type: object x-example: "{\n \"items\": [\n {\n \"id\": \"ocid1.certificate.oc1.iad.exampleae47ajxyajghg27gcvbu2ukncd4hn7ho4qgwfauxzz5a5matr2jgq\",\n \"issuerCertificateAuthorityId\": \"ocid1.certificateauthority.oc1.iad.exampleae47ajxya5r64cqhcvbhd7vn4ifypr3wn3lqkfhjxfauxqohfpmoa\",\n \"name\": \"test-cert-1\",\n \"description\": null,\n \"timeCreated\": \"2021-04-07T01:27:13.646Z\",\n \"timeOfDeletion\": null,\n \"lifecycleState\": \"ACTIVE\",\n \"compartmentId\": \"ocid1.compartment.oc1..exampleawwcufihrc62gpbcvbjizswgoj4w7rg5q4fwbg2fauxvlcxbtliaa\",\n \"certificateRules\": null,\n \"currentVersionSummary\": {\n \"certificateId\": \"ocid1.certificate.oc1.iad.exampleae47ajxyajghg27gcvbu2ukncd4hn7ho4qgwfauxzz5a5matr2jgq\",\n \"serialNumber\": \"123456789056170442297477452096219981553123456789\",\n \"timeCreated\": \"2021-04-07T01:27:16.165Z\",\n \"versionNumber\": 1,\n \"issuerCaVersionNumber\": 3,\n \"versionName\": null,\n \"subjectAlternativeNames\": null,\n \"timeOfDeletion\": null,\n \"validity\": {\n \"timeOfValidityNotBefore\": \"2021-04-07T01:27:13.646Z\",\n \"timeOfValidityNotAfter\": \"2022-05-06T00:00:00.000Z\"\n },\n \"stages\": [\n \"CURRENT\",\n \"LATEST\"\n ],\n \"revocationStatus\": null\n },\n \"subject\": {\n \"commonName\": \"www.example.net\",\n \"country\": null,\n \"domainComponent\": null,\n \"distinguishedNameQualifier\": null,\n \"generationQualifier\": null,\n \"givenName\": null,\n \"initials\": null,\n \"localityName\": null,\n \"organization\": null,\n \"organizationalUnit\": null,\n \"pseudonym\": null,\n \"serialNumber\": null,\n \"stateOrProvinceName\": null,\n \"street\": null,\n \"surname\": null,\n \"title\": null,\n \"userId\": null\n },\n \"configType\": \"ISSUED_BY_INTERNAL_CA\",\n \"keyAlgorithm\": \"RSA2048\",\n \"signatureAlgorithm\": \"SHA512_WITH_RSA\",\n \"certificateProfileType\": \"TLS_CODE_SIGN\",\n \"freeformTags\": {},\n \"definedTags\": {}\n },\n {\n \"id\": \"ocid1.certificate.oc1.iad.exampleae47ajxya3tq2pgf4nlcvblsn4aodhye2gnlfauxbovygyvooeuxa\",\n \"issuerCertificateAuthorityId\": \"ocid1.certificateauthority.oc1.iad.exampleae47ajxya5r64cqhcvbhd7vn4ifypr3wn3lqkfhjxfauxqohfpmoa\",\n \"name\": \"test-cert\",\n \"description\": null,\n \"timeCreated\": \"2021-04-07T01:11:59.276Z\",\n \"timeOfDeletion\": null,\n \"lifecycleState\": \"ACTIVE\",\n \"compartmentId\": \"ocid1.compartment.oc1..exampleawwcufihrc62gpbcvbjizswgoj4w7rg5q4fwbg2fauxvlcxbtliaa\",\n \"certificateRules\": null,\n \"currentVersionSummary\": {\n \"certificateId\": \"ocid1.certificate.oc1.iad.exampleae47ajxya3tq2pgf4nlcvblsn4aodhye2gnlfauxbovygyvooeuxa\",\n \"serialNumber\": \"1234567895791863306968852173349741900590123456789\",\n \"timeCreated\": \"2021-04-07T01:12:01.109Z\",\n \"versionNumber\": 1,\n \"issuerCaVersionNumber\": 3,\n \"versionName\": null,\n \"subjectAlternativeNames\": null,\n \"timeOfDeletion\": null,\n \"validity\": {\n \"timeOfValidityNotBefore\": \"2021-04-07T01:11:59.276Z\",\n \"timeOfValidityNotAfter\": \"2022-05-06T00:00:00.000Z\"\n },\n \"stages\": [\n \"CURRENT\",\n \"LATEST\"\n ],\n \"revocationStatus\": null\n },\n \"subject\": {\n \"commonName\": \"www.example.com\",\n \"country\": null,\n \"domainComponent\": null,\n \"distinguishedNameQualifier\": null,\n \"generationQualifier\": null,\n \"givenName\": null,\n \"initials\": null,\n \"localityName\": null,\n \"organization\": null,\n \"organizationalUnit\": null,\n \"pseudonym\": null,\n \"serialNumber\": null,\n \"stateOrProvinceName\": null,\n \"street\": null,\n \"surname\": null,\n \"title\": null,\n \"userId\": null\n },\n \"configType\": \"ISSUED_BY_INTERNAL_CA\",\n \"keyAlgorithm\": \"RSA2048\",\n \"signatureAlgorithm\": \"SHA512_WITH_RSA\",\n \"certificateProfileType\": \"TLS_SERVER_OR_CLIENT\",\n \"freeformTags\": {},\n \"definedTags\": {}\n }\n ]\n}\n" CertificateAuthorityCollection: description: The results of a certificate authority (CA) search. This object contains CA summary objects and other data. properties: items: description: List of CertificateAuthoritySummary. items: $ref: '#/components/schemas/CertificateAuthoritySummary' type: array required: - items type: object x-example: "{\n \"id\": \"ocid1.certificateauthority.oc1.iad.exampleae47ajxyawq5nb2cvbcrtjbbyi4augztb7py2fauxhhakbwcxrfpa\",\n \"issuerCertificateAuthorityId\": \"ocid1.certificateauthority.oc1.iad.exampleae47ajxyac4uhdrldcvbvf6ejucnldpj565v5fauxkwn2dccujyta\",\n \"name\": \"asddf\",\n \"description\": \"sdf\",\n \"timeCreated\": \"2021-03-22T22:14:54.565Z\",\n \"timeOfDeletion\": null,\n \"kmsKeyId\": \"ocid1.key.oc1.iad.examplegaag4s.abzwkljsd4iacvbv3s2e57hhwyljoc2zfxcgugfauxafqyxm7ljawezfc3cq\",\n \"lifecycleState\": \"ACTIVE\",\n \"compartmentId\": \"ocid1.tenancy.oc1..exampleauingds4uwkcvbxv4ijs7zxuqnoewldef4fauxs7vaax2fab4gcsq\",\n \"certificateAuthorityRules\": [\n {\n \"ruleType\": \"CERTIFICATE_AUTHORITY_RENEWAL_RULE\",\n \"renewalInterval\": \"P3650D\",\n \"advanceRenewalPeriod\": \"P30D\"\n }\n ],\n \"currentVersionSummary\": {\n \"certificateAuthorityId\": \"ocid1.certificateauthority.oc1.iad.exampleae47ajxyawq5nb2cvbcrtjbbyi4augztb7py2fauxhhakbwcxrfpa\",\n \"issuerCaVersionNumber\": null,\n \"serialNumber\": \"123456789900771507182728973147594537602123456789\",\n \"timeCreated\": \"2021-03-22T22:14:54.695Z\",\n \"versionNumber\": 1,\n \"versionName\": null,\n \"timeOfDeletion\": null,\n \"validity\": {\n \"timeOfValidityNotBefore\": \"2021-03-22T22:14:54.565Z\",\n \"timeOfValidityNotAfter\": \"2031-04-22T00:00:00.000Z\"\n },\n \"stages\": [\n \"CURRENT\",\n \"LATEST\"\n ],\n \"revocationStatus\": null\n },\n \"subject\": {\n \"commonName\": \"www.example.net\",\n \"country\": null,\n \"domainComponent\": null,\n \"distinguishedNameQualifier\": null,\n \"generationQualifier\": null,\n \"givenName\": null,\n \"initials\": null,\n \"localityName\": null,\n \"organization\": null,\n \"organizationalUnit\": null,\n \"pseudonym\": null,\n \"serialNumber\": null,\n \"stateOrProvinceName\": null,\n \"street\": null,\n \"surname\": null,\n \"title\": null,\n \"userId\": null\n },\n \"configType\": \"SUBORDINATE_CA_ISSUED_BY_INTERNAL_CA\",\n \"signingAlgorithm\": \"SHA512_WITH_RSA\",\n \"freeformTags\": {},\n \"definedTags\": {}\n},\n{\n \"id\": \"ocid1.certificateauthority.oc1.iad.exampleae47ajxyammgcng3cvb2uv64ld2k7f6dyaz4y35pi6faux7s7ppca\",\n \"issuerCertificateAuthorityId\": \"ocid1.certificateauthority.oc1.iad.exampleae47ajxyac4uhdrldcvbvf6ejucnldpj565v5fauxkwn2dccujyta\",\n \"name\": \"a\",\n \"description\": \"sdf\",\n \"timeCreated\": \"2021-03-22T22:14:06.144Z\",\n \"timeOfDeletion\": null,\n \"kmsKeyId\": \"ocid1.key.oc1.iad.examplegaag4s.abzwkljsd4iacvbv3s2e57hhwyljoc2zfxcgugfauxafqyxm7ljawezfc3cq\",\n \"lifecycleState\": \"ACTIVE\",\n \"compartmentId\": \"ocid1.tenancy.oc1..exampleauingds4uwkcvbxv4ijs7zxuqnoewldef4fauxs7vaax2fab4gcsq\",\n \"certificateAuthorityRules\": [\n {\n \"ruleType\": \"CERTIFICATE_AUTHORITY_RENEWAL_RULE\",\n \"renewalInterval\": \"P3650D\",\n \"advanceRenewalPeriod\": \"P30D\"\n },\n {\n \"ruleType\": \"CERTIFICATE_AUTHORITY_ISSUANCE_EXPIRY_RULE\",\n \"leafCertificateMaxValidityDuration\": \"P365D\",\n \"certificateAuthorityMaxValidityDuration\": \"P3650D\"\n }\n ],\n \"currentVersionSummary\": {\n \"certificateAuthorityId\": \"ocid1.certificateauthority.oc1.iad.exampleae47ajxyammgcng3cvb2uv64ld2k7f6dyaz4y35pi6faux7s7ppca\",\n \"issuerCaVersionNumber\": null,\n \"serialNumber\": \"123456789275197334290470762114233020537123456789\",\n \"timeCreated\": \"2021-03-22T22:14:06.313Z\",\n \"versionNumber\": 1,\n \"versionName\": null,\n \"timeOfDeletion\": null,\n \"validity\": {\n \"timeOfValidityNotBefore\": \"2021-03-22T22:14:06.144Z\",\n \"timeOfValidityNotAfter\": \"2031-04-22T00:00:00.000Z\"\n },\n \"stages\": [\n \"CURRENT\",\n \"LATEST\"\n ],\n \"revocationStatus\": null\n },\n \"subject\": {\n \"commonName\": \"www.example.org\",\n \"country\": null,\n \"domainComponent\": null,\n \"distinguishedNameQualifier\": null,\n \"generationQualifier\": null,\n \"givenName\": null,\n \"initials\": null,\n \"localityName\": null,\n \"organization\": null,\n \"organizationalUnit\": null,\n \"pseudonym\": null,\n \"serialNumber\": null,\n \"stateOrProvinceName\": null,\n \"street\": null,\n \"surname\": null,\n \"title\": null,\n \"userId\": null\n },\n \"configType\": \"SUBORDINATE_CA_ISSUED_BY_INTERNAL_CA\",\n \"signingAlgorithm\": \"SHA384_WITH_RSA\",\n \"freeformTags\": {\n \"sdsdf\": \"sdf\"\n },\n \"definedTags\": {}\n}\n" CertificateVersionSummary: description: The details of the certificate version. This object does not contain the certificate contents. properties: certificateId: description: The OCID of the certificate. maxLength: 255 minLength: 1 type: string issuerCaVersionNumber: description: The version number of the issuing certificate authority (CA). format: int64 minimum: 1 type: integer revocationStatus: $ref: '#/components/schemas/RevocationStatus' serialNumber: description: 'A unique certificate identifier used in certificate revocation tracking, formatted as octets. Example: `03 AC FC FA CC B3 CB 02 B8 F8 DE F5 85 E7 7B FF` ' maxLength: 59 minLength: 2 type: string stages: description: A list of rotation states for this certificate version. items: $ref: '#/components/schemas/VersionStage' type: array subjectAlternativeNames: default: null description: A list of subject alternative names. items: $ref: '#/components/schemas/CertificateSubjectAlternativeName' maxItems: 100 type: array timeCreated: description: 'A optional property indicating the time when the certificate version was created, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. Example: `2019-04-03T21:10:29.600Z` ' format: date-time type: string timeOfDeletion: default: null description: 'An optional property indicating when to delete the certificate version, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. Example: `2019-04-03T21:10:29.600Z` ' format: date-time type: string validity: $ref: '#/components/schemas/Validity' versionName: default: null description: 'The name of the certificate version. When the value is not null, a name is unique across versions of a given certificate. ' maxLength: 50 minLength: 1 type: string versionNumber: description: The version number of the certificate. format: int64 minimum: 1 type: integer required: - certificateId - timeCreated - versionNumber - stages type: object x-example: "{\n \"certificateId\": \"ocid1.certificate.oc1.iad.exampleae47ajxya3tq2pgf4nlcvblsn4aodhye2gnlfauxbovygyvooeuxa\",\n \"serialNumber\": \"123456789871232955583173211188557134784123456789\",\n \"timeCreated\": \"2021-04-07T02:12:18.064Z\",\n \"versionNumber\": 2,\n \"issuerCaVersionNumber\": 3,\n \"versionName\": null,\n \"subjectAlternativeNames\": null,\n \"timeOfDeletion\": null,\n \"validity\": {\n \"timeOfValidityNotBefore\": \"2021-04-07T02:12:17.968Z\",\n \"timeOfValidityNotAfter\": \"2022-05-06T00:00:00.000Z\"\n },\n \"stages\": [\n \"CURRENT\",\n \"LATEST\"\n ],\n \"revocationStatus\": null\n}\n" CreateCertificateAuthorityConfigDetails: description: The configuration details for creating a certificate authority (CA). discriminator: propertyName: configType properties: configType: description: The origin of the CA. enum: - ROOT_CA_GENERATED_INTERNALLY - SUBORDINATE_CA_ISSUED_BY_INTERNAL_CA - ROOT_CA_MANAGED_EXTERNALLY - SUBORDINATE_CA_MANAGED_INTERNALLY_ISSUED_BY_EXTERNAL_CA type: string x-obmcs-top-level-enum: '#/definitions/CertificateAuthorityConfigType' versionName: default: null description: 'The name of the CA version. When the value is not null, a name is unique across versions of a given CA. ' maxLength: 50 minLength: 1 type: string required: - configType type: object x-example: "{\n \"configType\": \"ROOT_CA_GENERATED_INTERNALLY\",\n \"signingAlgorithm\": \"SHA512_WITH_RSA\",\n \"subject\": {\n \"commonName\": \"www.example.com\"\n },\n \"validity\": {\n \"timeOfValidityNotAfter\": \"2031-05-06T00:00:00.000Z\"\n }\n}\n" CreateCertificateConfigDetails: description: The details of the contents of the certificate and certificate metadata. discriminator: propertyName: configType properties: configType: description: The origin of the certificate. enum: - ISSUED_BY_INTERNAL_CA - MANAGED_EXTERNALLY_ISSUED_BY_INTERNAL_CA - IMPORTED type: string x-obmcs-top-level-enum: '#/definitions/CertificateConfigType' versionName: default: null description: A name for the certificate. When the value is not null, a name is unique across versions of a given certificate. maxLength: 50 minLength: 1 type: string required: - configType type: object x-example: "{\n \"certificateProfileType\": \"TLS_SERVER_OR_CLIENT\",\n \"configType\": \"ISSUED_BY_INTERNAL_CA\",\n \"issuerCertificateAuthorityId\": \"ocid1.certificateauthority.oc1.iad.exampleae47ajxya5r64cqhcvbhd7vn4ifypr3wn3lqkfhjxfauxqohfpmoa\",\n \"keyAlgorithm\": \"RSA2048\",\n \"subject\": {\n \"commonName\": \"www.example.com\"\n },\n \"validity\": {\n \"timeOfValidityNotAfter\": \"2022-05-06T00:00:00.000Z\"\n }\n}\n" CertificateSummary: description: The details of the certificate. This object does not contain the certificate contents. properties: certificateProfileType: description: The name of the profile used to create the certificate, which depends on the type of certificate you need. enum: - TLS_SERVER_OR_CLIENT - TLS_SERVER - TLS_CLIENT - TLS_CODE_SIGN type: string x-obmcs-top-level-enum: '#/definitions/CertificateProfileType' certificateRules: default: null description: An optional list of rules that control how the certificate is used and managed. items: $ref: '#/components/schemas/CertificateRule' type: array compartmentId: description: The OCID of the compartment that contains the certificate. maxLength: 255 minLength: 1 type: string configType: description: The origin of the certificate. enum: - ISSUED_BY_INTERNAL_CA - MANAGED_EXTERNALLY_ISSUED_BY_INTERNAL_CA - IMPORTED type: string x-obmcs-top-level-enum: '#/definitions/CertificateConfigType' currentVersionSummary: $ref: '#/components/schemas/CertificateVersionSummary' definedTags: additionalProperties: additionalProperties: description: 'An object that represents the value of the tag. Only string, integer, and Boolean types are supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object default: null description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: default: null description: A brief description of the certificate. maxLength: 400 minLength: 1 type: string freeformTags: additionalProperties: type: string default: null description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object id: description: The OCID of the certificate. maxLength: 255 minLength: 1 type: string issuerCertificateAuthorityId: description: The OCID of the certificate authority (CA) that issued the certificate. maxLength: 255 minLength: 1 type: string x-default-description: The default is null, which means that the certificate was issued by an external, third-party public or private CA. keyAlgorithm: description: The algorithm used to create key pairs. enum: - RSA2048 - RSA4096 - ECDSA_P256 - ECDSA_P384 type: string x-obmcs-top-level-enum: '#/definitions/KeyAlgorithm' lifecycleState: description: The current lifecycle state of the certificate. enum: - CREATING - ACTIVE - UPDATING - DELETING - DELETED - SCHEDULING_DELETION - PENDING_DELETION - CANCELLING_DELETION - FAILED type: string x-obmcs-top-level-enum: '#/definitions/CertificateLifecycleState' name: description: A user-friendly name for the certificate. Names are unique within a compartment. Avoid entering confidential information. Valid characters are uppercase or lowercase letters, numbers, hyphens, underscores, and periods. maxLength: 255 minLength: 1 type: string signatureAlgorithm: description: The algorithm used to sign the public key certificate. enum: - SHA256_WITH_RSA - SHA384_WITH_RSA - SHA512_WITH_RSA - SHA256_WITH_ECDSA - SHA384_WITH_ECDSA - SHA512_WITH_ECDSA type: string x-obmcs-top-level-enum: '#/definitions/SignatureAlgorithm' subject: $ref: '#/components/schemas/CertificateSubject' timeCreated: description: 'A property indicating when the certificate was created, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. Example: `2019-04-03T21:10:29.600Z` ' format: date-time type: string timeOfDeletion: default: null description: 'An optional property indicating when to delete the certificate version, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. Example: `2019-04-03T21:10:29.600Z` ' format: date-time type: string required: - id - name - timeCreated - lifecycleState - compartmentId - configType type: object x-example: "{\n \"id\": \"ocid1.certificate.oc1.iad.exampleae47ajxyajghg27gcvbu2ukncd4hn7ho4qgwfauxzz5a5matr2jgq\",\n \"issuerCertificateAuthorityId\": \"ocid1.certificateauthority.oc1.iad.exampleae47ajxya5r64cqhcvbhd7vn4ifypr3wn3lqkfhjxfauxqohfpmoa\",\n \"name\": \"test-cert-1\",\n \"description\": null,\n \"timeCreated\": \"2021-04-07T01:27:13.646Z\",\n \"timeOfDeletion\": null,\n \"lifecycleState\": \"ACTIVE\",\n \"compartmentId\": \"ocid1.compartment.oc1..exampleawwcufihrc62gpbcvbjizswgoj4w7rg5q4fwbg2fauxvlcxbtliaa\",\n \"certificateRules\": null,\n \"currentVersionSummary\": {\n \"certificateId\": \"ocid1.certificate.oc1.iad.exampleae47ajxyajghg27gcvbu2ukncd4hn7ho4qgwfauxzz5a5matr2jgq\",\n \"serialNumber\": \"123456789056170442297477452096219981553123456789\",\n \"timeCreated\": \"2021-04-07T01:27:16.165Z\",\n \"versionNumber\": 1,\n \"issuerCaVersionNumber\": 3,\n \"versionName\": null,\n \"subjectAlternativeNames\": null,\n \"timeOfDeletion\": null,\n \"validity\": {\n \"timeOfValidityNotBefore\": \"2021-04-07T01:27:13.646Z\",\n \"timeOfValidityNotAfter\": \"2022-05-06T00:00:00.000Z\"\n },\n \"stages\": [\n \"CURRENT\",\n \"LATEST\"\n ],\n \"revocationStatus\": null\n },\n \"subject\": {\n \"commonName\": \"www.example.net\",\n \"country\": null,\n \"domainComponent\": null,\n \"distinguishedNameQualifier\": null,\n \"generationQualifier\": null,\n \"givenName\": null,\n \"initials\": null,\n \"localityName\": null,\n \"organization\": null,\n \"organizationalUnit\": null,\n \"pseudonym\": null,\n \"serialNumber\": null,\n \"stateOrProvinceName\": null,\n \"street\": null,\n \"surname\": null,\n \"title\": null,\n \"userId\": null\n },\n \"configType\": \"ISSUED_BY_INTERNAL_CA\",\n \"keyAlgorithm\": \"RSA2048\",\n \"signatureAlgorithm\": \"SHA512_WITH_RSA\",\n \"certificateProfileType\": \"TLS_CODE_SIGN\",\n \"freeformTags\": {},\n \"definedTags\": {}\n}\n" CertificateAuthority: description: The metadata details of the certificate authority (CA). This object does not contain the CA contents. properties: certificateAuthorityRules: default: null description: An optional list of rules that control how the CA is used and managed. items: $ref: '#/components/schemas/CertificateAuthorityRule' type: array certificateRevocationListDetails: $ref: '#/components/schemas/CertificateRevocationListDetails' compartmentId: description: The OCID of the compartment under which the CA is created. maxLength: 255 minLength: 1 type: string configType: description: The origin of the CA. enum: - ROOT_CA_GENERATED_INTERNALLY - SUBORDINATE_CA_ISSUED_BY_INTERNAL_CA - ROOT_CA_MANAGED_EXTERNALLY - SUBORDINATE_CA_MANAGED_INTERNALLY_ISSUED_BY_EXTERNAL_CA type: string x-obmcs-top-level-enum: '#/definitions/CertificateAuthorityConfigType' currentVersion: $ref: '#/components/schemas/CertificateAuthorityVersionSummary' definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and Boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object default: null description: 'Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object description: default: null description: A brief description of the CA. maxLength: 400 minLength: 1 type: string externalKeyDescription: default: null description: For externally managed CAs, a description of the externally managed key. Avoid entering confidential information. maxLength: 400 minLength: 0 type: string freeformTags: additionalProperties: type: string default: null description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' type: object id: description: The OCID of the CA. maxLength: 255 minLength: 1 type: string issuerCertificateAuthorityId: description: 'The OCID of the parent CA that issued this CA. If this is the root CA, then this value is null. ' maxLength: 255 minLength: 1 type: string x-default-description: The default is null, which means that this is a root CA. kmsKeyId: description: The OCID of the Oracle Cloud Infrastructure Vault key used to encrypt the CA. maxLength: 255 minLength: 1 type: string lifecycleDetails: default: null description: Additional information about the current CA lifecycle state. maxLength: 400 minLength: 1 type: string lifecycleState: description: The current lifecycle state of the certificate authority. enum: - CREATING - ACTIVE - UPDATING - DELETING - DELETED - SCHEDULING_DELETION - PENDING_DELETION - CANCELLING_DELETION - FAILED - PENDING_ACTIVATION type: string x-obmcs-top-level-enum: '#/definitions/CertificateAuthorityLifecycleState' name: description: A user-friendly name for the CA. Names are unique within a compartment. Avoid entering confidential information. Valid characters include uppercase or lowercase letters, numbers, hyphens, underscores, and periods. maxLength: 255 minLength: 1 type: string signingAlgorithm: description: The algorithm used to sign public key certificates that the CA issues. enum: - SHA256_WITH_RSA - SHA384_WITH_RSA - SHA512_WITH_RSA - SHA256_WITH_ECDSA - SHA384_WITH_ECDSA - SHA512_WITH_ECDSA type: string x-obmcs-top-level-enum: '#/definitions/SignatureAlgorithm' subject: $ref: '#/components/schemas/CertificateSubject' timeCreated: description: 'A property indicating when the CA was created, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. Example: `2019-04-03T21:10:29.600Z` ' format: date-time type: string timeOfDeletion: default: null description: 'An optional property indicating when to delete the CA version, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. Example: `2019-04-03T21:10:29.600Z` ' format: date-time type: string required: - id - name - timeCreated - lifecycleState - compartmentId - configType type: object x-example: "{\n \"id\": \"ocid1.certificateauthority.oc1.iad.exampleae47ajxyaovlvo7eycvb6jgblgmvdaixez2rrfauxov2v6wplhjiq\",\n \"issuerCertificateAuthorityId\": null,\n \"name\": \"test-ca-cvb\",\n \"description\": null,\n \"externalKeyDescription\": null,\n \"timeCreated\": \"2021-04-06T22:11:58.008Z\",\n \"timeOfDeletion\": null,\n \"kmsKeyId\": \"ocid1.key.oc1.iad.examplegaag4s.abzwkljsd4iacvbv3s2e57hhwyljoc2zfxcgugfauxafqyxm7ljawezfc3cq\",\n \"lifecycleState\": \"ACTIVE\",\n \"lifecycleDetails\": null,\n \"compartmentId\": \"ocid1.tenancy.oc1..exampleauingds4uwkcvbxv4ijs7zxuqnoewldef4fauxs7vaax2fab4gcsq\",\n \"certificateAuthorityRules\": [\n {\n \"ruleType\": \"CERTIFICATE_AUTHORITY_RENEWAL_RULE\",\n \"renewalInterval\": \"P3650D\",\n \"advanceRenewalPeriod\": \"P30D\"\n },\n {\n \"ruleType\": \"CERTIFICATE_AUTHORITY_ISSUANCE_EXPIRY_RULE\",\n \"leafCertificateMaxValidityDuration\": \"P365D\",\n \"certificateAuthorityMaxValidityDuration\": \"P3650D\"\n }\n {\n \"ruleType\": \"CERTIFICATE_AUTHORITY_ISSUANCE_RULE\",\n \"pathLengthConstraint\": 3,\n \"nameConstraint\": {\n \"permittedSubtree\": [\n {\n \"type\": \"DNS\",\n \"value\": \"example.com\"\n }\n ],\n \"excludedSubtree\": [\n {\n \"type\": \"DNS\",\n \"value\": \"example.org\"\n }\n ]\n }\n }\n ],\n \"currentVersion\": {\n \"certificateAuthorityId\": \"ocid1.certificateauthority.oc1.iad.exampleae47ajxyaovlvo7eycvb6jgblgmvdaixez2rrfauxov2v6wplhjiq\",\n \"issuerCaVersionNumber\": null,\n \"serialNumber\": \"1234567894183178072847116123235304931087123456789\",\n \"timeCreated\": \"2021-04-06T22:11:58.288Z\",\n \"versionNumber\": 1,\n \"versionName\": null,\n \"timeOfDeletion\": null,\n \"validity\": {\n \"timeOfValidityNotBefore\": \"2021-04-06T22:11:58.008Z\",\n \"timeOfValidityNotAfter\": \"2031-05-06T00:00:00.000Z\"\n },\n \"stages\": [\n \"CURRENT\",\n \"LATEST\"\n ],\n \"revocationStatus\": null\n },\n \"certificateRevocationListDetails\": {\n \"objectStorageConfig\": {\n \"objectStorageNamespace\": \"example-namespace\",\n \"objectStorageBucketName\": \"ca-crl-bucket\",\n \"objectStorageObjectNameFormat\": \"ca-1-crl\"\n },\n \"customFormattedUrls\": null\n },\n \"configType\": \"ROOT_CA_GENERATED_INTERNALLY\",\n \"subject\": {\n \"commonName\": \"www.example.com\",\n \"country\": null,\n \"domainComponent\": null,\n \"distinguishedNameQualifier\": null,\n \"generationQualifier\": null,\n \"givenName\": null,\n \"initials\": null,\n \"localityName\": null,\n \"organization\": null,\n \"organizationalUnit\": null,\n \"pseudonym\": null,\n \"serialNumber\": null,\n \"stateOrProvinceName\": null,\n \"street\": null,\n \"surname\": null,\n \"title\": null,\n \"userId\": null\n },\n \"signingAlgorithm\": \"SHA512_WITH_RSA\",\n \"freeformTags\": {},\n \"definedTags\": {}\n}\n" CreateCertificateAuthorityDetails: description: The details for creating a certificate authority (CA). properties: certificateAuthorityConfig: $ref: '#/components/schemas/CreateCertificateAuthorityConfigDetails' certificateAuthorityRules: default: null description: A list of rules that control how the CA is used and managed. items: $ref: '#/components/schemas/CertificateAuthorityRule' type: array certificateRevocationListDetails: $ref: '#/components/schemas/CertificateRevocationListDetails' compartmentId: description: The compartment in which you want to create the CA. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and Boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object default: null description: 'Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object description: default: null description: A brief description of the CA. maxLength: 400 minLength: 1 type: string externalKeyDescription: description: For externally managed CAs, a description of the externally managed private key. Avoid entering confidential information. maxLength: 400 minLength: 1 type: string freeformTags: additionalProperties: type: string default: null description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' type: object kmsKeyId: description: The OCID of the Oracle Cloud Infrastructure Vault key used to encrypt the CA. maxLength: 255 minLength: 1 type: string name: description: A user-friendly name for the CA. Names are unique within a compartment. Avoid entering confidential information. Valid characters include uppercase or lowercase letters, numbers, hyphens, underscores, and periods. maxLength: 255 minLength: 1 type: string required: - name - compartmentId - certificateAuthorityConfig type: object x-example: "{\n \"certificateAuthorityConfig\": {\n \"configType\": \"ROOT_CA_GENERATED_INTERNALLY\",\n \"signingAlgorithm\": \"SHA512_WITH_RSA\",\n \"subject\": {\n \"commonName\": \"www.example.com\"\n },\n \"validity\": {\n \"timeOfValidityNotAfter\": \"2031-05-06T00:00:00.000Z\"\n }\n },\n \"certificateAuthorityRules\": [\n {\n \"advanceRenewalPeriod\": \"P30D\",\n \"renewalInterval\": \"P3650D\",\n \"ruleType\": \"CERTIFICATE_AUTHORITY_RENEWAL_RULE\"\n }\n {\n \"ruleType\": \"CERTIFICATE_AUTHORITY_ISSUANCE_RULE\",\n \"pathLengthConstraint\": 3,\n \"nameConstraint\": {\n \"permittedSubtree\": [\n {\n \"type\": \"DNS\",\n \"value\": \"example.com\"\n }\n ],\n \"excludedSubtree\": [\n {\n \"type\": \"DNS\",\n \"value\": \"example.org\"\n }\n ]\n }\n }\n ],\n \"certificateRevocationListDetails\": {\n \"objectStorageConfig\": {\n \"objectStorageBucketName\": \"ca-crl-bucket\",\n \"objectStorageNamespace\": \"example-namespace\",\n \"objectStorageObjectNameFormat\": \"ca-1-crl\"\n }\n },\n \"compartmentId\": \"ocid1.tenancy.oc1..exampleauingds4uwkcvbxv4ijs7zxuqnoewldef4fauxs7vaax2fab4gcsq\",\n \"definedTags\": {},\n \"freeformTags\": {},\n \"kmsKeyId\": \"ocid1.key.oc1.iad.examplegaag4s.abzwkljsd4iacvbv3s2e57hhwyljoc2zfxcgugfauxafqyxm7ljawezfc3cq\",\n \"name\": \"test-ca-1\"\n}\n" CaBundleCollection: description: The results of a CA bundle search. This object contains CA bundle summary objects. properties: items: description: A list of CA bundle summary objects. items: $ref: '#/components/schemas/CaBundleSummary' type: array required: - items type: object x-example: "{\n \"items\": [\n {\n \"id\": \"ocid1.cabundle.oc1.iad.exampleae47ajxyargdcibcvb36td2fkh26cpqpozfaux2imhhwuryr5r37a\",\n \"name\": \"test-ca-bundle-2\",\n \"description\": \"description for CA bundle 2\",\n \"timeCreated\": \"2021-04-07T23:49:43.991Z\",\n \"lifecycleState\": \"FAILED\",\n \"lifecycleDetails\": \"Ca bundle pem is invalid. Setting lifecycle state to FAILED.\",\n \"compartmentId\": \"ocid1.compartment.oc1..exampleawwcufihrc62gpbcvbjizswgoj4w7rg5q4fwbg2fauxvlcxbtliaa\",\n \"freeformTags\": {},\n \"definedTags\": {}\n },\n {\n \"id\": \"ocid1.cabundle.oc1.iad.exampleae47ajxya4xr53oxv6rhi2cvbyce5zpni54kvu4vfauxeueazti3a\",\n \"name\": \"test-ca-bundle\",\n \"description\": null,\n \"timeCreated\": \"2021-04-07T22:11:19.562Z\",\n \"lifecycleState\": \"FAILED\",\n \"lifecycleDetails\": \"Ca bundle pem is invalid. Setting lifecycle state to FAILED.\",\n \"compartmentId\": \"ocid1.compartment.oc1..exampleawwcufihrc62gpbcvbjizswgoj4w7rg5q4fwbg2fauxvlcxbtliaa\",\n \"freeformTags\": {},\n \"definedTags\": {}\n }\n ]\n}\n" CertificateAuthoritySummary: description: The metadata details of the certificate authority (CA). This summary object does not contain the CA contents. properties: certificateAuthorityRules: default: null description: An optional list of rules that control how the CA is used and managed. items: $ref: '#/components/schemas/CertificateAuthorityRule' type: array compartmentId: description: The OCID of the compartment under which the CA is created. maxLength: 255 minLength: 1 type: string configType: description: The origin of the CA. enum: - ROOT_CA_GENERATED_INTERNALLY - SUBORDINATE_CA_ISSUED_BY_INTERNAL_CA - ROOT_CA_MANAGED_EXTERNALLY - SUBORDINATE_CA_MANAGED_INTERNALLY_ISSUED_BY_EXTERNAL_CA type: string x-obmcs-top-level-enum: '#/definitions/CertificateAuthorityConfigType' currentVersionSummary: $ref: '#/components/schemas/CertificateAuthorityVersionSummary' definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and Boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object default: null description: 'Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object description: default: null description: A brief description of the CA. maxLength: 400 minLength: 1 type: string freeformTags: additionalProperties: type: string default: null description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' type: object id: description: The OCID of the certificate authority (CA). maxLength: 255 minLength: 1 type: string issuerCertificateAuthorityId: description: 'The OCID of the parent CA which issued this CA. If this is the root CA, then this value is the same as the `id`. ' maxLength: 255 minLength: 1 type: string x-default-description: The default is null, which means that this is a root CA. kmsKeyId: description: The OCID of the Oracle Cloud Infrastructure Vault key used to encrypt the CA. maxLength: 255 type: string lifecycleState: description: The current lifecycle state of the CA. enum: - CREATING - ACTIVE - UPDATING - DELETING - DELETED - SCHEDULING_DELETION - PENDING_DELETION - CANCELLING_DELETION - FAILED - PENDING_ACTIVATION type: string x-obmcs-top-level-enum: '#/definitions/CertificateAuthorityLifecycleState' name: description: A user-friendly name for the CA. Names are unique within a compartment. Avoid entering confidential information. Valid characters include uppercase or lowercase letters, numbers, hyphens, underscores, and periods. maxLength: 255 minLength: 1 type: string signingAlgorithm: description: The algorithm used to sign public key certificates that the CA issues. enum: - SHA256_WITH_RSA - SHA384_WITH_RSA - SHA512_WITH_RSA - SHA256_WITH_ECDSA - SHA384_WITH_ECDSA - SHA512_WITH_ECDSA type: string x-obmcs-top-level-enum: '#/definitions/SignatureAlgorithm' subject: $ref: '#/components/schemas/CertificateSubject' timeCreated: description: 'A property indicating when the CA was created, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. Example: `2019-04-03T21:10:29.600Z` ' format: date-time type: string timeOfDeletion: default: null description: 'An optional property indicating when to delete the CA version, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. Example: `2019-04-03T21:10:29.600Z` ' format: date-time type: string required: - id - name - timeCreated - lifecycleState - compartmentId - configType type: object x-example: "{\n \"id\": \"ocid1.certificateauthority.oc1.iad.exampleae47ajxyawq5nb2cvbcrtjbbyi4augztb7py2fauxhhakbwcxrfpa\",\n \"issuerCertificateAuthorityId\": \"ocid1.certificateauthority.oc1.iad.exampleae47ajxyac4uhdrldcvbvf6ejucnldpj565v5fauxkwn2dccujyta\",\n \"name\": \"asddf\",\n \"description\": \"sdf\",\n \"timeCreated\": \"2021-03-22T22:14:54.565Z\",\n \"timeOfDeletion\": null,\n \"kmsKeyId\": \"ocid1.key.oc1.iad.examplegaag4s.abzwkljsd4iacvbv3s2e57hhwyljoc2zfxcgugfauxafqyxm7ljawezfc3cq\",\n \"lifecycleState\": \"ACTIVE\",\n \"compartmentId\": \"ocid1.tenancy.oc1..exampleauingds4uwkcvbxv4ijs7zxuqnoewldef4fauxs7vaax2fab4gcsq\",\n \"certificateAuthorityRules\": [\n {\n \"ruleType\": \"CERTIFICATE_AUTHORITY_RENEWAL_RULE\",\n \"renewalInterval\": \"P3650D\",\n \"advanceRenewalPeriod\": \"P30D\"\n }\n {\n \"ruleType\": \"CERTIFICATE_AUTHORITY_ISSUANCE_RULE\",\n \"pathLengthConstraint\": 3,\n \"nameConstraint\": {\n \"permittedSubtree\": [\n {\n \"type\": \"DNS\",\n \"value\": \"example.com\"\n }\n ],\n \"excludedSubtree\": [\n {\n \"type\": \"DNS\",\n \"value\": \"example.org\"\n }\n ]\n }\n }\n ],\n \"currentVersionSummary\": {\n \"certificateAuthorityId\": \"ocid1.certificateauthority.oc1.iad.exampleae47ajxyawq5nb2cvbcrtjbbyi4augztb7py2fauxhhakbwcxrfpa\",\n \"issuerCaVersionNumber\": null,\n \"serialNumber\": \"123456789900771507182728973147594537602123456789\",\n \"timeCreated\": \"2021-03-22T22:14:54.695Z\",\n \"versionNumber\": 1,\n \"versionName\": null,\n \"timeOfDeletion\": null,\n \"validity\": {\n \"timeOfValidityNotBefore\": \"2021-03-22T22:14:54.565Z\",\n \"timeOfValidityNotAfter\": \"2031-04-22T00:00:00.000Z\"\n },\n \"stages\": [\n \"CURRENT\",\n \"LATEST\"\n ],\n \"revocationStatus\": null\n },\n \"subject\": {\n \"commonName\": \"www.example.net\",\n \"country\": null,\n \"domainComponent\": null,\n \"distinguishedNameQualifier\": null,\n \"generationQualifier\": null,\n \"givenName\": null,\n \"initials\": null,\n \"localityName\": null,\n \"organization\": null,\n \"organizationalUnit\": null,\n \"pseudonym\": null,\n \"serialNumber\": null,\n \"stateOrProvinceName\": null,\n \"street\": null,\n \"surname\": null,\n \"title\": null,\n \"userId\": null\n },\n \"configType\": \"SUBORDINATE_CA_ISSUED_BY_INTERNAL_CA\",\n \"signingAlgorithm\": \"SHA512_WITH_RSA\",\n \"freeformTags\": {},\n \"definedTags\": {}\n}\n" CertificateAuthorityVersionCollection: description: The results of a certificate authority (CA) version search. This object contains CA version summary objects and other data. properties: items: description: A list of certificate authority version summary objects. items: $ref: '#/components/schemas/CertificateAuthorityVersionSummary' type: array required: - items type: object x-example: "{\n \"items\": [\n {\n \"certificateAuthorityId\": \"ocid1.certificateauthority.oc1.iad.exampleae47ajxya5r64cqhcvbhd7vn4ifypr3wn3lqkfhjxfauxqohfpmoa\",\n \"issuerCaVersionNumber\": null,\n \"serialNumber\": \"1234567890419170222282007451413738675751123456789\",\n \"timeCreated\": \"2021-04-07T00:49:42.725Z\",\n \"versionNumber\": 3,\n \"versionName\": null,\n \"timeOfDeletion\": null,\n \"validity\": {\n \"timeOfValidityNotBefore\": \"2021-04-07T00:49:42.134Z\",\n \"timeOfValidityNotAfter\": \"2031-05-06T00:00:00.000Z\"\n },\n \"stages\": [\n \"CURRENT\",\n \"LATEST\"\n ],\n \"revocationStatus\": null\n },\n {\n \"certificateAuthorityId\": \"ocid1.certificateauthority.oc1.iad.exampleae47ajxya5r64cqhcvbhd7vn4ifypr3wn3lqkfhjxfauxqohfpmoa\",\n \"issuerCaVersionNumber\": null,\n \"serialNumber\": \"123456789956851165652499115360096990600123456789\",\n \"timeCreated\": \"2021-04-06T23:44:01.346Z\",\n \"versionNumber\": 2,\n \"versionName\": null,\n \"timeOfDeletion\": null,\n \"validity\": {\n \"timeOfValidityNotBefore\": \"2021-04-06T23:44:00.840Z\",\n \"timeOfValidityNotAfter\": \"2031-05-06T00:00:00.000Z\"\n },\n \"stages\": [\n \"PREVIOUS\"\n ],\n \"revocationStatus\": null\n },\n {\n \"certificateAuthorityId\": \"ocid1.certificateauthority.oc1.iad.exampleae47ajxya5r64cqhcvbhd7vn4ifypr3wn3lqkfhjxfauxqohfpmoa\",\n \"issuerCaVersionNumber\": null,\n \"serialNumber\": \"1234567897867164586952251500242631950789123456789\",\n \"timeCreated\": \"2021-04-06T22:57:34.512Z\",\n \"versionNumber\": 1,\n \"versionName\": null,\n \"timeOfDeletion\": null,\n \"validity\": {\n \"timeOfValidityNotBefore\": \"2021-04-06T22:57:34.198Z\",\n \"timeOfValidityNotAfter\": \"2031-05-06T00:00:00.000Z\"\n },\n \"stages\": [\n \"DEPRECATED\"\n ],\n \"revocationStatus\": null\n }\n ]\n}\n" ScheduleCertificateDeletionDetails: description: The details for scheduling the deletion of the specified certificate. properties: timeOfDeletion: description: 'An optional property indicating when to delete the certificate version, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. ' format: date-time type: string x-default-description: The default is 30 days from the current time. type: object x-example: "{\n \"timeOfDeletion\" : \"2021-05-06T00:00:00.000Z\"\n}\n" VersionStage: description: 'A list of possible rotation states for the certificate version. A certificate version marked `CURRENT` is currently in use. A certificate version marked `PENDING` is staged and available for use, but has not been applied on the target system and, therefore, has not been rotated into current, active use. The certificate most recently uploaded to the service is always marked `LATEST`. (The first version of a certificate is always marked as both `CURRENT` and `LATEST`.) A certificate version marked `PREVIOUS` is the certificate version that was most recently marked `CURRENT`, before the last certificate version rotation. A certificate version marked `DEPRECATED` is neither current, pending, nor the previous one in use. Only certificate versions marked `DEPRECATED` can be scheduled for deletion. A certificate version marked `PENDING_ACTIVATION` is issued by an externally managed CA and stays in that rotation state until you successfully sign the certificate signing request (CSR) externally and then import the signed certificate to the Certificates service. ' enum: - CURRENT - PENDING - LATEST - PREVIOUS - DEPRECATED - FAILED - PENDING_ACTIVATION type: string x-example: "{\n \"stages\": [\n \"CURRENT\",\n \"LATEST\"\n ],\n}\n" CertificateVersion: description: The details of the certificate version. This object does not contain the certificate contents. properties: certificateId: description: The OCID of the certificate. maxLength: 255 minLength: 1 type: string issuerCaVersionNumber: description: The version number of the issuing certificate authority (CA). format: int64 minimum: 1 type: integer revocationStatus: $ref: '#/components/schemas/RevocationStatus' serialNumber: description: 'A unique certificate identifier used in certificate revocation tracking, formatted as octets. Example: `03 AC FC FA CC B3 CB 02 B8 F8 DE F5 85 E7 7B FF` ' maxLength: 59 minLength: 2 type: string stages: description: A list of stages of this entity. items: $ref: '#/components/schemas/VersionStage' type: array subjectAlternativeNames: default: null description: A list of subject alternative names. items: $ref: '#/components/schemas/CertificateSubjectAlternativeName' maxItems: 100 type: array timeCreated: description: 'A optional property indicating when the certificate version was created, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. Example: `2019-04-03T21:10:29.600Z` ' format: date-time type: string timeOfDeletion: default: null description: 'An optional property indicating when to delete the certificate version, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. Example: `2019-04-03T21:10:29.600Z` ' format: date-time type: string validity: $ref: '#/components/schemas/Validity' versionName: default: null description: 'The name of the certificate version. When the value is not null, a name is unique across versions of a given certificate. ' maxLength: 50 minLength: 1 type: string versionNumber: description: The version number of the certificate. format: int64 minimum: 1 type: integer required: - certificateId - timeCreated - versionNumber - stages type: object x-example: "{\n \"certificateId\": \"ocid1.certificate.oc1.iad.exampleae47ajxya3tq2pgf4nlcvblsn4aodhye2gnlfauxbovygyvooeuxa\",\n \"serialNumber\": \"123456789871232955583173211188557134784123456789\",\n \"timeCreated\": \"2021-04-07T02:12:18.064Z\",\n \"versionNumber\": 2,\n \"issuerCaVersionNumber\": 3,\n \"versionName\": null,\n \"subjectAlternativeNames\": null,\n \"timeOfDeletion\": null,\n \"validity\": {\n \"timeOfValidityNotBefore\": \"2021-04-07T02:12:17.968Z\",\n \"timeOfValidityNotAfter\": \"2022-05-06T00:00:00.000Z\"\n },\n \"stages\": [\n \"CURRENT\",\n \"LATEST\"\n ],\n \"revocationStatus\": null\n}\n" CertificateVersionCollection: description: The results of a certificate version search. This object contains certificate version summary objects and other data. properties: items: description: A list of certificate version summary objects. items: $ref: '#/components/schemas/CertificateVersionSummary' type: array required: - items type: object x-example: "{\n \"items\": [\n {\n \"certificateId\": \"ocid1.certificate.oc1.iad.exampleae47ajxya3tq2pgf4nlcvblsn4aodhye2gnlfauxbovygyvooeuxa\",\n \"serialNumber\": \"123456789871232955583173211188557134784123456789\",\n \"timeCreated\": \"2021-04-07T02:12:18.064Z\",\n \"versionNumber\": 2,\n \"issuerCaVersionNumber\": 3,\n \"versionName\": null,\n \"subjectAlternativeNames\": null,\n \"timeOfDeletion\": null,\n \"validity\": {\n \"timeOfValidityNotBefore\": \"2021-04-07T02:12:17.968Z\",\n \"timeOfValidityNotAfter\": \"2022-05-06T00:00:00.000Z\"\n },\n \"stages\": [\n \"CURRENT\",\n \"LATEST\"\n ],\n \"revocationStatus\": null\n },\n {\n \"certificateId\": \"ocid1.certificate.oc1.iad.exampleae47ajxya3tq2pgf4nlcvblsn4aodhye2gnlfauxbovygyvooeuxa\",\n \"serialNumber\": \"1234567895791863306968852173349741900590123456789\",\n \"timeCreated\": \"2021-04-07T01:12:01.109Z\",\n \"versionNumber\": 1,\n \"issuerCaVersionNumber\": 3,\n \"versionName\": null,\n \"subjectAlternativeNames\": null,\n \"timeOfDeletion\": null,\n \"validity\": {\n \"timeOfValidityNotBefore\": \"2021-04-07T01:11:59.276Z\",\n \"timeOfValidityNotAfter\": \"2022-05-06T00:00:00.000Z\"\n },\n \"stages\": [\n \"PREVIOUS\"\n ],\n \"revocationStatus\": null\n }\n ]\n}\n" CreateCaBundleDetails: description: The details of the CA bundle that you want to create. properties: caBundlePem: description: Certificates (in PEM format) to include in the CA bundle. maxLength: 51200 minLength: 1 type: string compartmentId: description: The OCID of the compartment for the CA bundle. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'An object that represents the value of the tag. Only string, integer and Boolean types are supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object default: null description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: default: null description: A brief description of the CA bundle. maxLength: 400 minLength: 1 type: string freeformTags: additionalProperties: type: string default: null description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object name: description: A user-friendly name for the CA bundle. Names are unique within a compartment. Avoid entering confidential information. Valid characters include uppercase or lowercase letters, numbers, hyphens, underscores, and periods. maxLength: 255 minLength: 1 type: string required: - name - compartmentId - caBundlePem type: object x-example: "{\n \"caBundlePem\": \"-----BEGIN PUBLIC KEY-----\\<keycontents>\\n-----END PUBLIC KEY-----\\n\",\n \"compartmentId\": \"ocid1.compartment.oc1..exampleawwcufihrc62gpbcvbjizswgoj4w7rg5q4fwbg2fauxvlcxbtliaa\",\n \"definedTags\": {},\n \"freeformTags\": {},\n \"name\": \"test-ca-bundle\"\n}\n" AssociationCollection: description: The results of an association search. properties: items: description: A list of association summary objects. items: $ref: '#/components/schemas/AssociationSummary' type: array required: - items type: object x-example: "{\n \"items\": [\n {\n \"id\": \"ocid1.certificatesassociation.oc1.iad.exampleae47ajxya7yiifw47nz3x7cvbauo6fauxleb4n2op5p72ms6akrfa\",\n \"name\": \"cabundle-cabundle-9e169a04-e7c2-4d80-a602-7043ea273396\",\n \"timeCreated\": \"2021-03-22T18:05:34.583Z\",\n \"lifecycleState\": \"ACTIVE\",\n \"certificatesResourceId\": \"ocid1.cabundle.oc1.iad.exampleae47ajxyalt3ddil26cvbsyw6k6fbhgwfauxnjdrqbpx3sxb35jzq\",\n \"associatedResourceId\": \"ocid1.cabundle.oc1.iad.exampleae47ajxyalt3ddil26cvbsyw6k6fbhgwfauxnjdrqbpx3sxb35jzq\",\n \"compartmentId\": \"ocid1.compartment.oc1..examplea4haham6vm4uzte4cvb3rwlpw5lmzphodx7o5lfauxwyfpvykngra\"\n },\n {\n \"id\": \"ocid1.certificatesassociation.oc1.iad.exampleae47ajxya7yiifw47nz3x7cvbauo6fauxleb4n2op5p72ms6akrfa\",\n \"name\": \"cabundle-cabundle-9e169a04-e7c2-4d80-a602-7043ea273396\",\n \"timeCreated\": \"2021-03-22T18:05:34.583Z\",\n \"lifecycleState\": \"ACTIVE\",\n \"certificatesResourceId\": \"ocid1.cabundle.oc1.iad.exampleae47ajxyalt3ddil26cvbsyw6k6fbhgwfauxnjdrqbpx3sxb35jzq\",\n \"associatedResourceId\": \"ocid1.cabundle.oc1.iad.exampleae47ajxyalt3ddil26cvbsyw6k6fbhgwfauxnjdrqbpx3sxb35jzq\",\n \"compartmentId\": \"ocid1.compartment.oc1..examplea4haham6vm4uzte4cvb3rwlpw5lmzphodx7o5lfauxwyfpvykngra\"\n }\n ]\n}\n" CertificateRule: description: A rule that you can apply to a certificate to enforce certain conditions on the certificate's usage and management. discriminator: propertyName: ruleType properties: ruleType: description: The type of rule. enum: - CERTIFICATE_RENEWAL_RULE type: string required: - ruleType type: object x-example: "{\n \"ruleType\": \"CERTIFICATE_RENEWAL_RULE\"\n}\n" UpdateCertificateAuthorityDetails: description: The details for updating a certificate authority (CA). properties: certificateAuthorityConfig: $ref: '#/components/schemas/UpdateCertificateAuthorityConfigDetails' certificateAuthorityRules: description: A list of rules that control how the CA is used and managed. items: $ref: '#/components/schemas/CertificateAuthorityRule' type: array x-default-description: The default is null, which means that this property is not updated. certificateRevocationListDetails: $ref: '#/components/schemas/CertificateRevocationListDetails' currentVersionNumber: description: Makes this version the current version. This property can't be updated in combination with any other properties. format: int64 type: integer x-default-description: The default is 0, which means that this property is not updated. definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and Boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object x-default-description: The default is null, which means that this property is not updated. description: description: A brief description of the CA. Avoid entering confidential information. maxLength: 400 minLength: 1 type: string x-default-description: The default is null, which means that this property is not updated. externalKeyDescription: description: For externally managed CAs, a description of the externally managed key. Avoid entering confidential information. maxLength: 400 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' type: object x-default-description: The default is null, which means that this property is not updated. type: object x-example: "{\n \"description\": \"Updated CA description\"\n}\n" Validity: description: 'An object that describes a period of time during which an entity is valid. If this is not provided when you create a certificate, the validity of the issuing CA is used. ' properties: timeOfValidityNotAfter: description: 'The date on which the certificate validity period ends, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. Example: `2019-04-03T21:10:29.600Z` ' format: date-time type: string timeOfValidityNotBefore: description: 'The date on which the certificate validity period begins, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. Example: `2019-04-03T21:10:29.600Z` ' format: date-time type: string x-default-description: defaults to the current time required: - timeOfValidityNotAfter x-example: "{\n \"timeOfValidityNotBefore\": \"2021-04-06T22:11:58.008Z\",\n \"timeOfValidityNotAfter\": \"2031-05-06T00:00:00.000Z\"\n}\n" CreateCertificateDetails: description: The details of the certificate to create. properties: certificateConfig: $ref: '#/components/schemas/CreateCertificateConfigDetails' certificateRules: default: null description: An optional list of rules that control how the certificate is used and managed. items: $ref: '#/components/schemas/CertificateRule' type: array compartmentId: description: The OCID of the compartment where you want to create the certificate. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'An object that represents the value of the tag. Only string, integer, and Boolean types are supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object default: null description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: default: null description: A brief description of the certificate. Avoid entering confidential information. maxLength: 400 minLength: 1 type: string freeformTags: additionalProperties: type: string default: null description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object name: description: 'A user-friendly name for the certificate. Names are unique within a compartment. Avoid entering confidential information. Valid characters are uppercase or lowercase letters, numbers, hyphens, underscores, and periods. ' maxLength: 255 minLength: 1 type: string required: - name - compartmentId - certificateConfig type: object x-example: "{\n \"certificateConfig\": {\n \"certificateProfileType\": \"TLS_SERVER_OR_CLIENT\",\n \"configType\": \"ISSUED_BY_INTERNAL_CA\",\n \"issuerCertificateAuthorityId\": \"ocid1.certificateauthority.oc1.iad.exampleae47ajxya5r64cqhcvbhd7vn4ifypr3wn3lqkfhjxfauxqohfpmoa\",\n \"keyAlgorithm\": \"RSA2048\",\n \"subject\": {\n \"commonName\": \"www.example.com\"\n },\n \"validity\": {\n \"timeOfValidityNotAfter\": \"2022-05-06T00:00:00.000Z\"\n }\n },\n \"certificateRules\": [\n {\n \"advanceRenewalPeriod\": \"P30D\",\n \"renewalInterval\": \"P365D\",\n \"ruleType\": \"CERTIFICATE_RENEWAL_RULE\"\n }\n ],\n \"compartmentId\": \"ocid1.compartment.oc1..exampleawwcufihrc62gpbcvbjizswgoj4w7rg5q4fwbg2fauxvlcxbtliaa\",\n \"definedTags\": {},\n \"freeformTags\": {},\n \"name\": \"test-cert\"\n }\n" UpdateCaBundleDetails: description: The details of the CA bundle to update. properties: caBundlePem: default: null description: Certificates (in PEM format) to include in the CA bundle. maxLength: 51200 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'An object that represents the value of the tag. Only string, integer and Boolean types are supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object default: null description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: default: null description: A brief description of the CA bundle. maxLength: 400 minLength: 1 type: string freeformTags: additionalProperties: type: string default: null description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object type: object x-example: "{\n \"caBundlePem\": \"-----BEGIN PUBLIC KEY-----\\<keycontents>\\n-----END PUBLIC KEY-----\\n\",\n \"definedTags\": {},\n \"freeformTags\": {},\n \"description\": \"description for Test CA Bundle\"\n}\n" CaBundleSummary: description: CA bundle metadata. This summary object does not contain the CA bundle certificates. properties: compartmentId: description: The OCID of the compartment for the CA bundle. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'An object that represents the value of the tag. Only string, integer and Boolean types are supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object default: null description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: default: null description: A brief description of the CA bundle. maxLength: 400 minLength: 1 type: string freeformTags: additionalProperties: type: string default: null description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object id: description: The OCID of the CA bundle. maxLength: 255 minLength: 1 type: string lifecycleDetails: default: null description: Additional information about the current lifecycle state of the CA bundle. maxLength: 400 minLength: 1 type: string lifecycleState: description: The current lifecycle state of the CA bundle. enum: - CREATING - ACTIVE - UPDATING - DELETING - DELETED - FAILED type: string x-obmcs-top-level-enum: '#/definitions/CaBundleLifecycleState' name: description: A user-friendly name for the CA bundle. Names are unique within a compartment. Avoid entering confidential information. Valid characters include uppercase or lowercase letters, numbers, hyphens, underscores, and periods. maxLength: 255 minLength: 1 type: string timeCreated: description: 'A property indicating when the CA bundle was created, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. Example: `2019-04-03T21:10:29.600Z` ' format: date-time type: string required: - id - name - timeCreated - lifecycleState - compartmentId type: object x-example: "{\n \"id\": \"ocid1.cabundle.oc1.iad.exampleae47ajxya4xr53oxv6rhi2cvbyce5zpni54kvu4vfauxeueazti3a\",\n \"name\": \"test-ca-bundle\",\n \"description\": null,\n \"timeCreated\": \"2021-04-07T22:11:19.562Z\",\n \"lifecycleState\": \"FAILED\",\n \"lifecycleDetails\": \"Ca bundle pem is invalid. Setting lifecycle state to FAILED.\",\n \"compartmentId\": \"ocid1.compartment.oc1..exampleawwcufihrc62gpbcvbjizswgoj4w7rg5q4fwbg2fauxvlcxbtliaa\",\n \"freeformTags\": {},\n \"definedTags\": {}\n}\n" Association: description: The details of the association. properties: associatedResourceId: description: The OCID of the associated resource. maxLength: 255 minLength: 1 type: string associationType: description: Type of the association. enum: - CERTIFICATE - CERTIFICATE_AUTHORITY - CA_BUNDLE type: string x-obmcs-top-level-enum: '#/definitions/AssociationType' certificatesResourceId: description: The OCID of the certificate-related resource associated with another Oracle Cloud Infrastructure resource. maxLength: 255 minLength: 1 type: string compartmentId: description: The compartment OCID of the association, which is strongly tied to the compartment OCID of the certificate-related resource. maxLength: 255 minLength: 1 type: string id: description: The OCID of the association. maxLength: 255 minLength: 1 type: string lifecycleState: description: The current lifecycle state of the association. enum: - CREATING - ACTIVE - UPDATING - DELETING - FAILED type: string x-obmcs-top-level-enum: '#/definitions/AssociationLifecycleState' name: description: 'A user-friendly name generated by the service for the association, expressed in a format that follows the pattern: [certificatesResourceEntityType]-[associatedResourceEntityType]-UUID. ' maxLength: 255 minLength: 1 type: string timeCreated: description: 'A property indicating when the association was created, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. Example: `2019-04-03T21:10:29.600Z` ' format: date-time type: string required: - id - name - timeCreated - lifecycleState - certificatesResourceId - associatedResourceId - compartmentId - associationType type: object x-example: "{\n \"id\": \"ocid1.certificatesassociation.oc1.iad.exampleae47ajxya7yiifw47nz3x7cvbauo6fauxleb4n2op5p72ms6akrfa\",\n \"name\": \"cabundle-cabundle-9e169a04-e7c2-4d80-a602-7043ea273396\",\n \"timeCreated\": \"2021-03-22T18:05:34.583Z\",\n \"lifecycleState\": \"ACTIVE\",\n \"certificatesResourceId\": \"ocid1.cabundle.oc1.iad.exampleae47ajxyalt3ddil26cvbsyw6k6fbhgwfauxnjdrqbpx3sxb35jzq\",\n \"associatedResourceId\": \"ocid1.cabundle.oc1.iad.exampleae47ajxyalt3ddil26cvbsyw6k6fbhgwfauxnjdrqbpx3sxb35jzq\",\n \"compartmentId\": \"ocid1.compartment.oc1..examplea4haham6vm4uzte4cvb3rwlpw5lmzphodx7o5lfauxwyfpvykngra\",\n \"associationType\": \"CERTIFICATE\"\n}\n" ScheduleCertificateAuthorityVersionDeletionDetails: description: The details of the request to schedule the deletion of the specified certificate authority (CA) version. properties: timeOfDeletion: description: 'An optional property indicating when to delete the CA version, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. Example: `2019-04-03T21:10:29.600Z` ' format: date-time type: string x-default-description: The default is 30 days from the current time. type: object x-example: "{\n \"timeOfDeletion\" : \"2021-05-06T00:00:00.000Z\"\n}\n" UpdateCertificateAuthorityConfigDetails: description: The configuration details for updating a certificate authority (CA). discriminator: propertyName: configType properties: configType: description: The origin of the CA. enum: - ROOT_CA_GENERATED_INTERNALLY - SUBORDINATE_CA_ISSUED_BY_INTERNAL_CA - ROOT_CA_MANAGED_EXTERNALLY - SUBORDINATE_CA_MANAGED_INTERNALLY_ISSUED_BY_EXTERNAL_CA type: string x-obmcs-top-level-enum: '#/definitions/CertificateAuthorityConfigType' stage: default: PENDING description: 'The rotation state of the CA. The default is `PENDING`, meaning that the CA is staged and available for use. A CA version that you mark as `CURRENT` is currently in use, but you don''t yet want to rotate it into current, active use. For example, you might create or update a CA and mark its rotation state as `PENDING` if you haven''t yet updated the certificate on the target system. ' enum: - CURRENT - PENDING type: string versionName: default: null description: 'The name of the CA version. When the value is not null, a name is unique across versions of a given CA. ' maxLength: 50 minLength: 1 type: string required: - configType type: object x-example: "{\n \"configType\": \"ROOT_CA_GENERATED_INTERNALLY\",\n \"validity\": {\n \"timeOfValidityNotBefore\": \"2021-03-22T22:14:54.565Z\",\n \"timeOfValidityNotAfter\": \"2031-04-22T00:00:00.000Z\"\n },\n \"versionName\" : \"renewed-ca-v1\",\n \"stage\" : \"PENDING\"\n}\n" Certificate: description: The details of the certificate. This object does not contain the certificate contents. properties: certificateProfileType: description: The name of the profile used to create the certificate, which depends on the type of certificate you need. enum: - TLS_SERVER_OR_CLIENT - TLS_SERVER - TLS_CLIENT - TLS_CODE_SIGN type: string x-obmcs-top-level-enum: '#/definitions/CertificateProfileType' certificateRevocationListDetails: $ref: '#/components/schemas/CertificateRevocationListDetails' certificateRules: default: null description: A list of rules that control how the certificate is used and managed. items: $ref: '#/components/schemas/CertificateRule' type: array compartmentId: description: The OCID of the compartment where you want to create the certificate. maxLength: 255 minLength: 1 type: string configType: description: The origin of the certificate. enum: - ISSUED_BY_INTERNAL_CA - MANAGED_EXTERNALLY_ISSUED_BY_INTERNAL_CA - IMPORTED type: string x-obmcs-top-level-enum: '#/definitions/CertificateConfigType' currentVersion: $ref: '#/components/schemas/CertificateVersionSummary' definedTags: additionalProperties: additionalProperties: description: 'An object that represents the value of the tag. Only string, integer and Boolean types are supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object default: null description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: default: null description: A brief description of the certificate. Avoid entering confidential information. maxLength: 400 minLength: 1 type: string freeformTags: additionalProperties: type: string default: null description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object id: description: The OCID of the certificate. maxLength: 255 minLength: 1 type: string issuerCertificateAuthorityId: description: The OCID of the certificate authority (CA) that issued the certificate. maxLength: 255 minLength: 1 type: string x-default-description: The default is null, which means that this certificate was issued by an external, third-party public or private CA. keyAlgorithm: description: The algorithm used to create key pairs. enum: - RSA2048 - RSA4096 - ECDSA_P256 - ECDSA_P384 type: string x-obmcs-top-level-enum: '#/definitions/KeyAlgorithm' lifecycleDetails: default: null description: Additional information about the current lifecycle state of the certificate. maxLength: 400 minLength: 1 type: string lifecycleState: description: The current lifecycle state of the certificate. enum: - CREATING - ACTIVE - UPDATING - DELETING - DELETED - SCHEDULING_DELETION - PENDING_DELETION - CANCELLING_DELETION - FAILED type: string x-obmcs-top-level-enum: '#/definitions/CertificateLifecycleState' name: description: A user-friendly name for the certificate. Names are unique within a compartment. Avoid entering confidential information. Valid characters are uppercase or lowercase letters, numbers, hyphens, underscores, and periods. maxLength: 255 minLength: 1 type: string signatureAlgorithm: description: The algorithm used to sign the public key certificate. enum: - SHA256_WITH_RSA - SHA384_WITH_RSA - SHA512_WITH_RSA - SHA256_WITH_ECDSA - SHA384_WITH_ECDSA - SHA512_WITH_ECDSA type: string x-obmcs-top-level-enum: '#/definitions/SignatureAlgorithm' subject: $ref: '#/components/schemas/CertificateSubject' timeCreated: description: 'A property indicating when the certificate was created, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. Example: `2019-04-03T21:10:29.600Z` ' format: date-time type: string timeOfDeletion: default: null description: 'An optional property indicating when to delete the certificate version, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. Example: `2019-04-03T21:10:29.600Z` ' format: date-time type: string required: - id - name - timeCreated - lifecycleState - compartmentId - configType type: object x-example: "{\n \"id\": \"ocid1.certificate.oc1.iad.exampleae47ajxya3tq2pgf4nlcvblsn4aodhye2gnlfauxbovygyvooeuxa\",\n \"issuerCertificateAuthorityId\": \"ocid1.certificateauthority.oc1.iad.exampleae47ajxya5r64cqhcvbhd7vn4ifypr3wn3lqkfhjxfauxqohfpmoa\",\n \"name\": \"test-cert\",\n \"description\": null,\n \"certificateRules\": [\n {\n \"ruleType\": \"CERTIFICATE_RENEWAL_RULE\",\n \"renewalInterval\": \"P365D\",\n \"advanceRenewalPeriod\": \"P30D\"\n }\n ],\n \"timeCreated\": \"2021-04-07T01:11:59.276Z\",\n \"timeOfDeletion\": null,\n \"lifecycleState\": \"ACTIVE\",\n \"lifecycleDetails\": null,\n \"compartmentId\": \"ocid1.compartment.oc1..exampleawwcufihrc62gpbcvbjizswgoj4w7rg5q4fwbg2fauxvlcxbtliaa\",\n \"currentVersion\": {\n \"certificateId\": \"ocid1.certificate.oc1.iad.exampleae47ajxya3tq2pgf4nlcvblsn4aodhye2gnlfauxbovygyvooeuxa\",\n \"serialNumber\": \"1234567895791863306968852173349741900590123456789\",\n \"timeCreated\": \"2021-04-07T01:12:01.109Z\",\n \"versionNumber\": 1,\n \"issuerCaVersionNumber\": 3,\n \"versionName\": null,\n \"subjectAlternativeNames\": null,\n \"timeOfDeletion\": null,\n \"validity\": {\n \"timeOfValidityNotBefore\": \"2021-04-07T01:11:59.276Z\",\n \"timeOfValidityNotAfter\": \"2022-05-06T00:00:00.000Z\"\n },\n \"stages\": [\n \"CURRENT\",\n \"LATEST\"\n ],\n \"revocationStatus\": null\n },\n \"subject\": {\n \"commonName\": \"www.example.com\",\n \"country\": null,\n \"domainComponent\": null,\n \"distinguishedNameQualifier\": null,\n \"generationQualifier\": null,\n \"givenName\": null,\n \"initials\": null,\n \"localityName\": null,\n \"organization\": null,\n \"organizationalUnit\": null,\n \"pseudonym\": null,\n \"serialNumber\": null,\n \"stateOrProvinceName\": null,\n \"street\": null,\n \"surname\": null,\n \"title\": null,\n \"userId\": null\n },\n \"certificateRevocationListDetails\": null,\n \"configType\": \"ISSUED_BY_INTERNAL_CA\",\n \"keyAlgorithm\": \"RSA2048\",\n \"signatureAlgorithm\": \"SHA512_WITH_RSA\",\n \"certificateProfileType\": \"TLS_SERVER_OR_CLIENT\",\n \"freeformTags\": {},\n \"definedTags\": {}\n}\n" UpdateCertificateDetails: description: The details of the certificate to update. properties: certificateConfig: $ref: '#/components/schemas/UpdateCertificateConfigDetails' certificateRules: description: An optional list of rules that control how the certificate is used and managed. items: $ref: '#/components/schemas/CertificateRule' type: array x-default-description: The default is null, which means that this property is not updated. currentVersionNumber: description: Makes this version the current version. This property cannot be updated in combination with any other properties. format: int64 type: integer x-default-description: The default is 0, which means that this property is not updated. definedTags: additionalProperties: additionalProperties: description: 'An object that represents the value of the tag. Only string, integer, and Boolean types are supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object x-default-description: The default is null, which means that this property is not updated. description: description: A brief description of the certificate. Avoid entering confidential information. maxLength: 400 minLength: 1 type: string x-default-description: The default is null, which means that this property is not updated. freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object x-default-description: The default is null, which means that this property is not updated. type: object x-example: "{\n \"description\": \"Updated certificate description\"\n}\n" CaBundle: description: CA bundle metadata. This object does not contain the CA bundle certificates. properties: compartmentId: description: The OCID of the compartment for the CA bundle. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'An object that represents the value of the tag. Only string, integer and Boolean types are supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object default: null description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: default: null description: A brief description of the CA bundle. maxLength: 400 minLength: 1 type: string freeformTags: additionalProperties: type: string default: null description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object id: description: The OCID of the CA bundle. maxLength: 255 minLength: 1 type: string lifecycleDetails: default: null description: Additional information about the current lifecycle state of the CA bundle. maxLength: 400 minLength: 1 type: string lifecycleState: description: The current lifecycle state of the CA bundle. enum: - CREATING - ACTIVE - UPDATING - DELETING - DELETED - FAILED type: string x-obmcs-top-level-enum: '#/definitions/CaBundleLifecycleState' name: description: A user-friendly name for the CA bundle. Names are unique within a compartment. Avoid entering confidential information. Valid characters include uppercase or lowercase letters, numbers, hyphens, underscores, and periods. maxLength: 255 minLength: 1 type: string timeCreated: description: 'A property indicating when the CA bundle was created, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. Example: `2019-04-03T21:10:29.600Z` ' format: date-time type: string required: - id - name - timeCreated - lifecycleState - compartmentId type: object x-example: "{\n \"id\": \"ocid1.cabundle.oc1.iad.exampleae47ajxya4xr53oxv6rhi2cvbyce5zpni54kvu4vfauxeueazti3a\",\n \"name\": \"test-ca-bundle\",\n \"description\": null,\n \"timeCreated\": \"2021-04-07T22:11:19.562Z\",\n \"lifecycleState\": \"FAILED\",\n \"lifecycleDetails\": \"Ca bundle pem is invalid. Setting lifecycle state to FAILED.\",\n \"compartmentId\": \"ocid1.compartment.oc1..exampleawwcufihrc62gpbcvbjizswgoj4w7rg5q4fwbg2fauxvlcxbtliaa\",\n \"freeformTags\": {},\n \"definedTags\": {}\n}\n" ObjectStorageBucketConfigDetails: description: The details of the Object Storage bucket configured to store the certificate revocation list (CRL). properties: objectStorageBucketName: description: The name of the bucket where the CRL is stored. maxLength: 256 minLength: 1 type: string objectStorageNamespace: description: The tenancy of the bucket where the CRL is stored. minLength: 1 type: string x-default-description: If not provided, the certificate's tenancy is used. objectStorageObjectNameFormat: description: 'The object name in the bucket where the CRL is stored, expressed using a format where the version number of the issuing CA is inserted as part of the Object Storage object name wherever you include a pair of curly braces. This versioning scheme helps avoid collisions when new CA versions are created. For example, myCrlFileIssuedFromCAVersion{}.crl becomes myCrlFileIssuedFromCAVersion2.crl for CA version 2. ' maxLength: 1024 minLength: 1 type: string required: - objectStorageBucketName - objectStorageObjectNameFormat type: object x-example: "{\n \"objectStorageBucketName\": \"ca-crl-bucket\",\n \"objectStorageNamespace\": \"example-namespace\",\n \"objectStorageObjectNameFormat\": \"ca-1-crl\"\n}\n" CertificateRevocationListDetails: description: The details of the certificate revocation list (CRL). properties: customFormattedUrls: default: null description: 'Optional CRL access points, expressed using a format where the version number of the issuing CA is inserted wherever you include a pair of curly braces. This versioning scheme helps avoid collisions when new CA versions are created. For example, myCrlFileIssuedFromCAVersion{}.crl becomes myCrlFileIssuedFromCAVersion2.crl for CA version 2. ' items: maxLength: 256 minLength: 1 type: string type: array objectStorageConfig: $ref: '#/components/schemas/ObjectStorageBucketConfigDetails' required: - objectStorageConfig type: object x-example: "{\n \"objectStorageConfig\": {\n \"objectStorageBucketName\": \"ca-crl-bucket\",\n \"objectStorageNamespace\": \"example-namespace\",\n \"objectStorageObjectNameFormat\": \"ca-1-crl\"\n }\n}\n" CertificateAuthorityRule: description: A rule that you can apply to a certificate authority (CA) to enforce certain conditions on its usage and management. discriminator: propertyName: ruleType properties: ruleType: description: 'The type of rule, whether a renewal rule regarding when to renew the CA or an issuance expiry rule that governs how long the certificates and CAs issued by the CA are valid. (For internal use only) An internal issuance rule defines the number and type of certificates that the CA can issue. ' enum: - CERTIFICATE_AUTHORITY_ISSUANCE_EXPIRY_RULE - CERTIFICATE_AUTHORITY_ISSUANCE_RULE type: string required: - ruleType type: object x-example: "{\n \"ruleType\": \"CERTIFICATE_AUTHORITY_ISSUANCE_EXPIRY_RULE\"\n}\n" CertificateAuthorityVersion: description: The metadata details of the certificate authority (CA) version. This object does not contain the CA contents. properties: certificateAuthorityId: description: The OCID of the CA. maxLength: 255 minLength: 1 type: string csrPem: default: null description: The certificate signing request (in PEM format). maxLength: 10240 minLength: 1 type: string issuerCaVersionNumber: description: The version number of the issuing CA. format: int64 minimum: 1 type: integer revocationStatus: $ref: '#/components/schemas/RevocationStatus' serialNumber: description: 'A unique certificate identifier used in certificate revocation tracking, formatted as octets. Example: `03 AC FC FA CC B3 CB 02 B8 F8 DE F5 85 E7 7B FF` ' maxLength: 59 minLength: 2 type: string stages: description: A list of rotation states for this CA version. items: $ref: '#/components/schemas/VersionStage' type: array subjectAlternativeNames: default: null description: A list of subject alternative names. A subject alternative name specifies the domain names, including subdomains, and IP addresses covered by the certificates issued by this CA. items: $ref: '#/components/schemas/CertificateSubjectAlternativeName' maxItems: 100 type: array timeCreated: description: 'A optional property indicating when the CA version was created, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. Example: `2019-04-03T21:10:29.600Z` ' format: date-time type: string timeOfDeletion: default: null description: 'An optional property indicating when to delete the CA version, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. Example: `2019-04-03T21:10:29.600Z` ' format: date-time type: string validity: $ref: '#/components/schemas/Validity' versionName: default: null description: 'The name of the CA version. When the value is not null, a name is unique across versions for a given CA. ' maxLength: 50 minLength: 1 type: string versionNumber: description: The version number of this CA. format: int64 minimum: 1 type: integer required: - certificateAuthorityId - timeCreated - versionNumber - stages type: object x-example: "{\n \"certificateAuthorityId\": \"ocid1.certificateauthority.oc1.iad.exampleae47ajxyaovlvo7eycvb6jgblgmvdaixez2rrfauxov2v6wplhjiq\",\n \"issuerCaVersionNumber\": null,\n \"serialNumber\": \"1234567894183178072847116123235304931087123456789\",\n \"timeCreated\": \"2021-04-06T22:11:58.288Z\",\n \"versionNumber\": 1,\n \"versionName\": null,\n \"timeOfDeletion\": null,\n \"validity\": {\n \"timeOfValidityNotBefore\": \"2021-04-06T22:11:58.008Z\",\n \"timeOfValidityNotAfter\": \"2031-05-06T00:00:00.000Z\"\n },\n \"stages\": [\n \"CURRENT\",\n \"LATEST\"\n ]\n ,\"revocationStatus\": null,\n \"csrPem\": \"-----BEGIN CERTIFICATE REQUEST-----<certificateContents>-----END CERTIFICATE REQUEST-----\"\n }\n" RevokeCertificateAuthorityVersionDetails: description: The details of the request to revoke a certificate authority (CA) version. properties: revocationReason: description: The reason the certificate or certificate authority was revoked. enum: - UNSPECIFIED - KEY_COMPROMISE - CA_COMPROMISE - AFFILIATION_CHANGED - SUPERSEDED - CESSATION_OF_OPERATION - PRIVILEGE_WITHDRAWN - AA_COMPROMISE type: string x-obmcs-top-level-enum: '#/definitions/RevocationReason' type: string AssociationSummary: description: The details of the association. properties: associatedResourceId: description: The OCID of the associated resource. maxLength: 255 minLength: 1 type: string associationType: description: Type of the association. enum: - CERTIFICATE - CERTIFICATE_AUTHORITY - CA_BUNDLE type: string x-obmcs-top-level-enum: '#/definitions/AssociationType' certificatesResourceId: description: The OCID of the certificate-related resource associated with another Oracle Cloud Infrastructure resource. maxLength: 255 minLength: 1 type: string compartmentId: description: The compartment OCID of the association. This is strongly tied to the compartment OCID of the certificate-related resource. maxLength: 255 minLength: 1 type: string id: description: The OCID of the association. maxLength: 255 minLength: 1 type: string lifecycleState: description: The current lifecycle state of the association. enum: - CREATING - ACTIVE - UPDATING - DELETING - FAILED type: string x-obmcs-top-level-enum: '#/definitions/AssociationLifecycleState' name: description: A user-friendly name generated by the service for the association. Name format follows the pattern [certificatesResourceEntityType]-[associatedResourceEntityType]-UUID. maxLength: 255 minLength: 1 type: string timeCreated: description: 'A property indicating when the association was created, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. Example: `2019-04-03T21:10:29.600Z` ' format: date-time type: string required: - id - name - timeCreated - lifecycleState - certificatesResourceId - associatedResourceId - compartmentId - associationType type: object x-example: "{\n \"id\": \"ocid1.certificatesassociation.oc1.iad.exampleae47ajxya7yiifw47nz3x7cvbauo6fauxleb4n2op5p72ms6akrfa\",\n \"name\": \"cabundle-cabundle-9e169a04-e7c2-4d80-a602-7043ea273396\",\n \"timeCreated\": \"2021-03-22T18:05:34.583Z\",\n \"lifecycleState\": \"ACTIVE\",\n \"certificatesResourceId\": \"ocid1.cabundle.oc1.iad.exampleae47ajxyalt3ddil26cvbsyw6k6fbhgwfauxnjdrqbpx3sxb35jzq\",\n \"associatedResourceId\": \"ocid1.cabundle.oc1.iad.exampleae47ajxyalt3ddil26cvbsyw6k6fbhgwfauxnjdrqbpx3sxb35jzq\",\n \"compartmentId\": \"ocid1.compartment.oc1..examplea4haham6vm4uzte4cvb3rwlpw5lmzphodx7o5lfauxwyfpvykngra\",\n \"associationType\": \"CERTIFICATE\"\n}\n" ScheduleCertificateAuthorityDeletionDetails: description: The details of the request to schedule the deletion of the specified certificate authority (CA). properties: timeOfDeletion: description: 'An optional property indicating when to delete the CA, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. Example: `2019-04-03T21:10:29.600Z` ' format: date-time type: string x-default-description: The default is 30 days from the current time. type: object x-example: "{\n \"timeOfDeletion\" : \"2021-05-06T00:00:00.000Z\"\n}\n" ChangeCertificateCompartmentDetails: description: The details of the request to change compartments for the certificate. properties: compartmentId: description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment into which the certificate should move. ' maxLength: 255 minLength: 1 type: string required: - compartmentId type: object x-example: "{\n \"compartmentId\" : \"ocid1.tenancy.oc1..exampleauingds4uwkcvbxv4ijs7zxuqnoewldef4fauxs7vaax2fab4gcsq\"\n}\n" ChangeCertificateAuthorityCompartmentDetails: description: The details of the request to change compartments for the certificate authority (CA). properties: compartmentId: description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment into which the CA should move. ' maxLength: 255 minLength: 1 type: string required: - compartmentId type: object x-example: "{\n \"compartmentId\" : \"ocid1.tenancy.oc1..exampleauingds4uwkcvbxv4ijs7zxuqnoewldef4fauxs7vaax2fab4gcsq\"\n}\n" CertificateSubject: description: 'The subject of the certificate, which is a distinguished name that identifies the entity that owns the public key in the certificate. ' properties: commonName: description: Common name or fully-qualified domain name (RDN CN). maxLength: 64 minLength: 0 type: string country: default: null description: Country name (RDN C). maxLength: 2 minLength: 1 type: string distinguishedNameQualifier: default: null description: Distinguished name qualifier(RDN DNQ). maxLength: 256 minLength: 1 type: string domainComponent: default: null description: Domain component (RDN DC). maxLength: 256 minLength: 1 type: string generationQualifier: default: null description: Personal generational qualifier (for example, Sr., Jr. 3rd, or IV). maxLength: 3 minLength: 1 type: string givenName: default: null description: Personal given name (RDN G or GN). maxLength: 16 minLength: 1 type: string initials: default: null description: Personal initials. maxLength: 5 minLength: 1 type: string localityName: default: null description: Locality (RDN L). maxLength: 128 minLength: 1 type: string organization: default: null description: Organization (RDN O). maxLength: 64 minLength: 1 type: string organizationalUnit: default: null description: Organizational unit (RDN OU). maxLength: 64 minLength: 1 type: string pseudonym: default: null description: Subject pseudonym. maxLength: 128 minLength: 1 type: string serialNumber: default: null description: Unique subject identifier, which is not the same as the certificate serial number (RDN SERIALNUMBER). maxLength: 64 minLength: 1 type: string stateOrProvinceName: default: null description: State or province name (RDN ST or S). maxLength: 128 minLength: 1 type: string street: default: null description: Street address (RDN STREET). maxLength: 256 minLength: 1 type: string surname: default: null description: Personal surname (RDN SN). maxLength: 40 minLength: 1 type: string title: default: null description: Title (RDN T or TITLE). maxLength: 64 minLength: 1 type: string userId: default: null description: User ID (RDN UID). maxLength: 256 minLength: 1 type: string required: - commonName type: object x-example: "{\n \"commonName\": \"www.example.com\",\n \"country\": \"US\",\n \"domainComponent\": null,\n \"distinguishedNameQualifier\": null,\n \"generationQualifier\": null,\n \"givenName\": null,\n \"initials\": null,\n \"localityName\": \"Seattle\",\n \"organization\": \"OCI\",\n \"organizationalUnit\": null,\n \"pseudonym\": null,\n \"serialNumber\": null,\n \"stateOrProvinceName\": \"Washington\",\n \"street\": \"123 Main Street\",\n \"surname\": null,\n \"title\": null,\n \"userId\": null,\n}\n" ScheduleCertificateVersionDeletionDetails: description: The details for scheduling the deletion of the specified certificate version. properties: timeOfDeletion: description: 'An optional property that indicates when to delete the certificate version, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. ' format: date-time type: string x-default-description: The default is 30 days from the current time. type: object x-example: "{\n \"timeOfDeletion\" : \"2021-05-06T00:00:00.000Z\"\n}\n" RevocationStatus: description: The current revocation status of the entity. properties: revocationReason: description: The reason the certificate or certificate authority (CA) was revoked. enum: - UNSPECIFIED - KEY_COMPROMISE - CA_COMPROMISE - AFFILIATION_CHANGED - SUPERSEDED - CESSATION_OF_OPERATION - PRIVILEGE_WITHDRAWN - AA_COMPROMISE type: string x-obmcs-top-level-enum: '#/definitions/RevocationReason' timeOfRevocation: description: 'The time when the entity was revoked, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. Example: `2019-04-03T21:10:29.600Z` ' format: date-time type: string required: - timeOfRevocation - revocationReason type: object x-example: "{\n \"timeOfRevocation\": \"2021-04-07T23:03:12.211Z\",\n \"revocationReason\": \"CESSATION_OF_OPERATION\"\n}\n" UpdateCertificateConfigDetails: description: The details of the contents of the certificate and certificate metadata. discriminator: propertyName: configType properties: configType: description: The origin of the certificate. enum: - ISSUED_BY_INTERNAL_CA - MANAGED_EXTERNALLY_ISSUED_BY_INTERNAL_CA - IMPORTED type: string x-obmcs-top-level-enum: '#/definitions/CertificateConfigType' stage: default: CURRENT description: 'The rotation state of the certificate. The default is `CURRENT`, meaning that the certificate is currently in use. A certificate version that you mark as `PENDING` is staged and available for use, but you don''t yet want to rotate it into current, active use. For example, you might update a certificate and mark its rotation state as `PENDING` if you haven''t yet updated the certificate on the target system. ' enum: - CURRENT - PENDING type: string versionName: default: null description: A name for the certificate version. When the value is not null, a name is unique across versions of a given certificate. maxLength: 50 minLength: 1 type: string required: - configType type: object RevokeCertificateVersionDetails: description: The details for revoking a certificate version. properties: revocationReason: description: The reason that the certificate or certificate authority was revoked. enum: - UNSPECIFIED - KEY_COMPROMISE - CA_COMPROMISE - AFFILIATION_CHANGED - SUPERSEDED - CESSATION_OF_OPERATION - PRIVILEGE_WITHDRAWN - AA_COMPROMISE type: string x-obmcs-top-level-enum: '#/definitions/RevocationReason' type: string x-example: '"AFFILIATION_CHANGED" ' parameters: CertificatesResourceIdQueryParam: description: A filter that returns only resources that match the given OCID of a certificate-related resource. in: query name: certificatesResourceId required: false x-default-description: The default value is null. schema: type: string maxLength: 255 minLength: 1 IfMatchHeader: description: 'For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource''s current etag value. ' in: header name: if-match required: false x-default-description: The default value is null. schema: type: string VersionSortByQueryParam: description: 'The field to sort by. You can specify only one sort order. The default order for ''VERSION_NUMBER'' is ascending. ' in: query name: sortBy required: false x-default-description: The default value is `VERSION_NUMBER`. schema: type: string enum: - VERSION_NUMBER CertificateVersionNumberRequiredPathParam: description: The version number of the certificate. in: path name: certificateVersionNumber required: true schema: type: integer format: int64 FilterByNameQueryParam: description: A filter that returns only resources that match the specified name. in: query name: name required: false x-default-description: The default value is null. schema: type: string maxLength: 255 minLength: 1 FilterByCertificateAuthorityIdQueryParam: description: The OCID of the certificate authority (CA). If the parameter is set to null, the service lists all CAs. in: query name: certificateAuthorityId required: false x-default-description: The default value is null. schema: type: string maxLength: 255 minLength: 1 SortOrderQueryParam: description: 'The sort order to use, either ascending (`ASC`) or descending (`DESC`). ' in: query name: sortOrder required: false x-default-description: The default value is `ASC`. schema: type: string enum: - ASC - DESC AssociationIdRequiredPathParam: description: The OCID of an association between a certificate-related resource and another Oracle Cloud Infrastructure resource. in: path name: associationId required: true schema: type: string maxLength: 255 minLength: 1 RequestIdHeader: description: 'Unique Oracle-assigned identifier for the request. If provided, the returned request ID will include this value. Otherwise, a random request ID will be generated by the service. ' in: header name: opc-request-id required: false x-default-description: The default value is null. schema: type: string maxLength: 255 minLength: 1 CertificateSortByQueryParam: description: 'The field to sort by. You can specify only one sort order. The default order for `EXPIRATIONDATE` and ''TIMECREATED'' is descending. The default order for `NAME` is ascending. ' in: query name: sortBy required: false x-default-description: The default value is `TIMECREATED`. schema: type: string enum: - NAME - EXPIRATIONDATE - TIMECREATED SortByQueryParam: description: 'The field to sort by. You can specify only one sort order. The default order for `TIMECREATED` is descending. The default order for `NAME` is ascending. ' in: query name: sortBy required: false x-default-description: The default value is `TIMECREATED`. schema: type: string enum: - NAME - TIMECREATED CaBundleLifecycleStateQueryParam: description: A filter that returns only resources that match the given lifecycle state. The state value is case-insensitive. in: query name: lifecycleState required: false x-default-description: The default value is null. schema: type: string enum: - CREATING - ACTIVE - UPDATING - DELETING - DELETED - FAILED AssociationTypeQueryParam: description: Type of associations to list. If the parameter is set to null, the service lists all types of associations. in: query name: associationType required: false x-default-description: The default value is null. schema: type: string enum: - CERTIFICATE - CERTIFICATE_AUTHORITY - CA_BUNDLE FilterByIssuerCertificateAuthorityIdQueryParam: description: The OCID of the certificate authority (CA). If the parameter is set to null, the service lists all CAs. in: query name: issuerCertificateAuthorityId required: false x-default-description: The default value is null. schema: type: string maxLength: 255 minLength: 1 FilterByCertificateIdQueryParam: description: The OCID of the certificate. If the parameter is set to null, the service lists all certificates. in: query name: certificateId required: false x-default-description: The default value is null. schema: type: string maxLength: 255 minLength: 1 CaBundleIdRequiredPathParam: description: The OCID of the CA bundle. in: path name: caBundleId required: true schema: type: string maxLength: 255 minLength: 1 CertificateAuthoritySortByQueryParam: description: 'The field to sort by. You can specify only one sort order. The default order for `EXPIRATIONDATE` and ''TIMECREATED'' is descending. The default order for `NAME` is ascending. ' in: query name: sortBy required: false x-default-description: The default value is `TIMECREATED`. schema: type: string enum: - NAME - EXPIRATIONDATE - TIMECREATED PaginationTokenQueryParam: description: 'The value of the `opc-next-page` response header from the previous "List" call. ' in: query name: page required: false x-default-description: The default value is null. schema: type: string minLength: 1 AssociatedResourceIdQueryParam: description: A filter that returns only resources that match the given OCID of an associated Oracle Cloud Infrastructure resource. in: query name: associatedResourceId required: false x-default-description: The default value is null. schema: type: string maxLength: 255 minLength: 1 FilterByCaBundleIdQueryParam: description: The OCID of the CA bundle. in: query name: caBundleId required: false x-default-description: The default value is null. schema: type: string maxLength: 255 minLength: 1 FilterByAssociationIdQueryParam: description: The OCID of the association. If the parameter is set to null, the service lists all associations. in: query name: associationId required: false x-default-description: The default value is null. schema: type: string maxLength: 255 minLength: 1 CertificateAuthorityLifecycleStateQueryParam: description: A filter that returns only resources that match the given lifecycle state. The state value is case-insensitive. in: query name: lifecycleState required: false x-default-description: The default value is null. schema: type: string enum: - CREATING - ACTIVE - UPDATING - DELETING - DELETED - SCHEDULING_DELETION - PENDING_DELETION - CANCELLING_DELETION - FAILED - PENDING_ACTIVATION RetryTokenHeader: description: 'A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected). ' in: header name: opc-retry-token required: false x-default-description: The default value is null. schema: type: string maxLength: 64 minLength: 1 CertificateAuthorityIdRequiredPathParam: description: The OCID of the certificate authority (CA). in: path name: certificateAuthorityId required: true schema: type: string maxLength: 255 minLength: 1 CertificateLifecycleStateQueryParam: description: A filter that returns only resources that match the given lifecycle state. The state value is case-insensitive. in: query name: lifecycleState required: false x-default-description: The default value is null. schema: type: string enum: - CREATING - ACTIVE - UPDATING - DELETING - DELETED - SCHEDULING_DELETION - PENDING_DELETION - CANCELLING_DELETION - FAILED CertificateIdRequiredPathParam: description: The OCID of the certificate. in: path name: certificateId required: true schema: type: string maxLength: 255 minLength: 1 CompartmentIdQueryParam: description: A filter that returns only resources that match the given compartment OCID. in: query name: compartmentId required: false x-default-description: The default value is null. schema: type: string maxLength: 255 minLength: 1 PaginationLimitQueryParam: description: 'The maximum number of items to return in a paginated "List" call. ' in: query name: limit required: false x-default-description: 100 schema: type: integer maximum: 1000 minimum: 1 FilterByVersionNumberQueryParam: description: 'A filter that returns only resources that match the specified version number. The default value is 0, which means that this filter is not applied. ' in: query name: versionNumber required: false schema: type: integer format: int64 default: 0 CertificateAuthorityVersionNumberRequiredPathParam: description: The version number of the certificate authority (CA). in: path name: certificateAuthorityVersionNumber required: true schema: type: integer format: int64 responses: DefaultError: description: An error has occurred. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' x-oracle-package: com.oracle.bmc.swagger.ocicerts