components:
  schemas:
    Certificate_v1_10_0_Actions:
      additionalProperties: false
      description: The available actions for this resource.
      properties:
        '#Certificate.Rekey':
          $ref: '#/components/schemas/Certificate_v1_10_0_Rekey'
        '#Certificate.Renew':
          $ref: '#/components/schemas/Certificate_v1_10_0_Renew'
        Oem:
          $ref: '#/components/schemas/Certificate_v1_10_0_OemActions'
          description: The available OEM-specific actions for this resource.
          x-longDescription: This property shall contain the available OEM-specific
            actions for this resource.
      type: object
      x-longDescription: This type shall contain the available actions for this resource.
      x-patternProperties:
        ^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\.[a-zA-Z_][a-zA-Z0-9_]*$:
          description: This property shall specify a valid odata or Redfish property.
    Certificate_v1_10_0_Certificate:
      additionalProperties: false
      description: The `Certificate` schema describes a certificate that proves the
        identity of a component, account, or service.
      properties:
        '@odata.context':
          $ref: http://redfish.dmtf.org/schemas/v1/odata-v4.yaml#/components/schemas/odata-v4_context
        '@odata.etag':
          $ref: http://redfish.dmtf.org/schemas/v1/odata-v4.yaml#/components/schemas/odata-v4_etag
        '@odata.id':
          $ref: http://redfish.dmtf.org/schemas/v1/odata-v4.yaml#/components/schemas/odata-v4_id
        '@odata.type':
          $ref: http://redfish.dmtf.org/schemas/v1/odata-v4.yaml#/components/schemas/odata-v4_type
        Actions:
          $ref: '#/components/schemas/Certificate_v1_10_0_Actions'
          description: The available actions for this resource.
          x-longDescription: This property shall contain the available actions for
            this resource.
        CertificateString:
          description: The string for the certificate.
          nullable: true
          readOnly: true
          type: string
          x-longDescription: This property shall contain the certificate, and the
            format shall follow the requirements specified by the `CertificateType`
            property value.  If the certificate contains any private keys, they shall
            be removed from the string in responses.  If the service does not know
            the private key for the certificate and is needed to use the certificate,
            the client shall provide the private key as part of the string in the
            `POST` request.  For additional property requirements, see the corresponding
            definition in the Redfish Data Model Specification.
        CertificateType:
          description: The format of the certificate.
          oneOf:
          - $ref: http://redfish.dmtf.org/schemas/v1/Certificate.yaml#/components/schemas/Certificate_CertificateType
          - enum:
            - null
          readOnly: true
          x-longDescription: This property shall contain the format type for the certificate.  For
            additional property requirements, see the corresponding definition in
            the Redfish Data Model Specification.
        CertificateUsageTypes:
          description: The types or purposes for this certificate.
          items:
            oneOf:
            - $ref: '#/components/schemas/Certificate_v1_10_0_CertificateUsageType'
            - enum:
              - null
          readOnly: true
          type: array
          x-longDescription: The value of this property shall contain an array describing
            the types or purposes for this certificate.
          x-versionAdded: v1_4_0
        Description:
          oneOf:
          - $ref: http://redfish.dmtf.org/schemas/v1/Resource.yaml#/components/schemas/Resource_Description
          - enum:
            - null
          readOnly: true
        Fingerprint:
          description: The fingerprint of the certificate.
          pattern: ^([0-9A-Fa-f]{2}:){0,}([0-9A-Fa-f]{2})$
          readOnly: true
          type: string
          x-longDescription: The value of this property shall be a string containing
            the ASCII representation of the fingerprint of the certificate.  The hash
            algorithm used to generate this fingerprint shall be specified by the
            `FingerprintHashAlgorithm` property.
          x-versionAdded: v1_3_0
        FingerprintHashAlgorithm:
          description: The hash algorithm for the fingerprint of the certificate.
          readOnly: true
          type: string
          x-longDescription: The value of this property shall be a string containing
            the hash algorithm used for generating the `Fingerprint` property.  The
            value shall be one of the strings in the 'Algorithm Name' field of the
            'TPM_ALG_ID Constants' table within the 'Trusted Computing Group Algorithm
            Registry'.
          x-versionAdded: v1_3_0
        Id:
          $ref: http://redfish.dmtf.org/schemas/v1/Resource.yaml#/components/schemas/Resource_Id
          readOnly: true
        Issuer:
          $ref: '#/components/schemas/Certificate_v1_10_0_Identifier'
          description: The issuer of the certificate.
          x-longDescription: This property shall contain an object containing information
            about the issuer of the certificate.
        KeyUsage:
          description: The key usage extension, which defines the purpose of the public
            keys in this certificate.
          items:
            oneOf:
            - $ref: http://redfish.dmtf.org/schemas/v1/Certificate.yaml#/components/schemas/Certificate_KeyUsage
            - enum:
              - null
          readOnly: true
          type: array
          x-longDescription: This property shall contain the key usage extension,
            which defines the purpose of the public keys in this certificate.
        Links:
          $ref: '#/components/schemas/Certificate_v1_10_0_Links'
          description: The links to other resources that are related to this resource.
          x-longDescription: This property shall contain links to resources that are
            related to but are not contained by, or subordinate to, this resource.
          x-versionAdded: v1_4_0
        Name:
          $ref: http://redfish.dmtf.org/schemas/v1/Resource.yaml#/components/schemas/Resource_Name
          readOnly: true
        Oem:
          $ref: http://redfish.dmtf.org/schemas/v1/Resource.yaml#/components/schemas/Resource_Oem
          description: The OEM extension property.
          x-longDescription: This property shall contain the OEM extensions.  All
            values for properties that this object contains shall conform to the Redfish
            Specification-described requirements.
        Password:
          description: The password for the certificate.
          nullable: true
          readOnly: false
          type: string
          writeOnly: true
          x-longDescription: This property shall contain the password for the certificate
            contained in the `CertificateString` property.  This property shall be
            required in create requests if the `CertificateType` property contains
            `PKCS12` and the client-provided certificate is password protected.  This
            property shall not be present in responses.
          x-versionAdded: v1_10_0
        SPDM:
          $ref: '#/components/schemas/Certificate_v1_10_0_SPDM'
          description: SPDM-related information for the certificate.
          x-longDescription: The value of this property shall contain SPDM-related
            information for the certificate.  This property shall only be present
            for SPDM certificates.
          x-versionAdded: v1_5_0
        SerialNumber:
          description: The serial number of the certificate.
          pattern: ^([0-9A-Fa-f]{2}:){0,}([0-9A-Fa-f]{2})$
          readOnly: true
          type: string
          x-longDescription: The value of this property shall be a string containing
            the ASCII representation of the serial number of the certificate, as defined
            by the RFC5280 'serialNumber' field.
          x-versionAdded: v1_3_0
        SignatureAlgorithm:
          description: The algorithm used for creating the signature of the certificate.
          readOnly: true
          type: string
          x-longDescription: The value of this property shall be a string containing
            the algorithm used for generating the signature of the certificate, as
            defined by the RFC5280 'signatureAlgorithm' field.  The value shall be
            a string representing the ASN.1 OID of the signature algorithm as defined
            in, but not limited to, RFC3279, RFC4055, or RFC4491.
          x-versionAdded: v1_3_0
        Status:
          $ref: http://redfish.dmtf.org/schemas/v1/Resource.yaml#/components/schemas/Resource_Status
          description: The status and health of the resource and its subordinate or
            dependent resources.
          x-longDescription: This property shall contain any status or health properties
            of the resource.
          x-versionAdded: v1_10_0
        Subject:
          $ref: '#/components/schemas/Certificate_v1_10_0_Identifier'
          description: The subject of the certificate.
          x-longDescription: This property shall contain an object containing information
            about the subject of the certificate.
        UefiSignatureOwner:
          description: The UEFI signature owner for this certificate.
          nullable: true
          pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
          readOnly: true
          type: string
          x-longDescription: The value of this property shall contain the GUID of
            the UEFI signature owner for this certificate as defined by the UEFI Specification.  This
            property shall only be present for certificates managed by UEFI.
          x-versionAdded: v1_2_0
        ValidNotAfter:
          description: The date when the certificate is no longer valid.
          format: date-time
          readOnly: true
          type: string
          x-longDescription: This property shall contain the date when the certificate
            validity period ends.
        ValidNotBefore:
          description: The date when the certificate becomes valid.
          format: date-time
          readOnly: true
          type: string
          x-longDescription: This property shall contain the date when the certificate
            validity period begins.
      required:
      - '@odata.id'
      - '@odata.type'
      - Id
      - Name
      type: object
      x-longDescription: This resource shall represent a certificate for a Redfish
        implementation.
      x-patternProperties:
        ^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\.[a-zA-Z_][a-zA-Z0-9_]*$:
          description: This property shall specify a valid odata or Redfish property.
      x-requiredOnCreate:
      - CertificateString
      - CertificateType
    Certificate_v1_10_0_CertificateUsageType:
      enum:
      - User
      - Web
      - SSH
      - Device
      - Platform
      - BIOS
      - IDevID
      - LDevID
      - IAK
      - LAK
      - EK
      type: string
      x-enumDescriptions:
        BIOS: This certificate is a BIOS certificate like those associated with UEFI.
        Device: This certificate is a device type certificate like those associated
          with SPDM and other standards.
        EK: This certificate is an EK certificate like those associated with TCG TPMs.
        IAK: This certificate is an IAK certificate like those associated with TCG
          TPMs.
        IDevID: This certificate is an IDevID certificate like those associated with
          TCG TPMs.
        LAK: This certificate is an LAK certificate like those associated with TCG
          TPMs.
        LDevID: This certificate is an LDevID certificate like those associated with
          TCG TPMs.
        Platform: This certificate is a platform type certificate like those associated
          with SPDM and other standards.
        SSH: This certificate is used for SSH.
        User: This certificate is a user certificate like those associated with a
          manager account.
        Web: This certificate is a web or HTTPS certificate like those used for event
          destinations.
      x-enumVersionAdded:
        EK: v1_9_0
        IAK: v1_8_0
        IDevID: v1_8_0
        LAK: v1_8_0
        LDevID: v1_8_0
    Certificate_v1_10_0_Identifier:
      additionalProperties: false
      description: The identifier information about a certificate.
      properties:
        AdditionalCommonNames:
          description: Additional common names of the entity.
          items:
            nullable: true
            type: string
          readOnly: true
          type: array
          x-longDescription: The value of this property shall contain an array of
            additional common names for the entity, as defined by the RFC5280 'commonName'
            attribute, in array order as they appear in the certificate.  This property
            shall not be present if only one common name is found.  The first common
            name shall not appear in this property.
          x-versionAdded: v1_6_0
        AdditionalOrganizationalUnits:
          description: Additional organizational units of the entity.
          items:
            nullable: true
            type: string
          readOnly: true
          type: array
          x-longDescription: The value of this property shall contain an array of
            additional organizational units for the entity, as defined by the RFC5280
            'organizationalUnitName' attribute, in array order as they appear in the
            certificate.  This property shall not be present if only one organizational
            unit is found.  The first organizational unit shall not appear in this
            property.
          x-versionAdded: v1_6_0
        AlternativeNames:
          description: The additional host names of the entity.
          items:
            nullable: true
            type: string
          readOnly: true
          type: array
          x-longDescription: This property shall contain the additional host names
            of the entity, as defined by the RFC5280 'subjectAltName' attribute.  This
            property shall not be present in the `Issuer` property.
          x-versionAdded: v1_7_0
        City:
          description: The city or locality of the organization of the entity.
          readOnly: true
          type: string
          x-longDescription: This property shall contain the city or locality of the
            organization of the entity, as defined by the RFC5280 'localityName' attribute.
        CommonName:
          description: The common name of the entity.
          readOnly: true
          type: string
          x-longDescription: This property shall contain the common name of the entity,
            as defined by the RFC5280 'commonName' attribute.
        Country:
          description: The country of the organization of the entity.
          readOnly: true
          type: string
          x-longDescription: This property shall contain the two-letter ISO code for
            the country of the organization of the entity, as defined by the RFC5280
            'countryName' attribute.
        DisplayString:
          description: A human-readable string for this identifier.
          nullable: true
          readOnly: true
          type: string
          x-longDescription: The value of this property shall contain a display string
            that represents the entire identifier.  The string should be formatted
            using industry conventions, such as the single-line human-readable string
            described by RFC2253 and preserving the field order as shown in the certificate.
          x-versionAdded: v1_6_0
        DomainComponents:
          description: The domain components of the entity.
          items:
            nullable: true
            type: string
          readOnly: true
          type: array
          x-longDescription: The value of this property shall contain an array of
            domain component fields for the entity, as defined by the RFC4519 'domainComponent'
            attribute, in array order as they appear in the certificate.
          x-versionAdded: v1_6_0
        Email:
          description: The email address of the contact within the organization of
            the entity.
          nullable: true
          readOnly: true
          type: string
          x-longDescription: This property shall contain the email address of the
            contact within the organization of the entity, as defined by the RFC2985
            'emailAddress' attribute.
        Organization:
          description: The name of the organization of the entity.
          readOnly: true
          type: string
          x-longDescription: This property shall contain the name of the organization
            of the entity, as defined by the RFC5280 'organizationName' attribute.
        OrganizationalUnit:
          description: The name of the unit or division of the organization of the
            entity.
          readOnly: true
          type: string
          x-longDescription: This property shall contain the name of the unit or division
            of the organization of the entity, as defined by the RFC5280 'organizationalUnitName'
            attribute.
        State:
          description: The state, province, or region of the organization of the entity.
          readOnly: true
          type: string
          x-longDescription: This property shall contain the state, province, or region
            of the organization of the entity, as defined by the RFC5280 'stateOrProvinceName'
            attribute.
      type: object
      x-longDescription: This type shall contain the properties that identifies the
        issuer or subject of a certificate.
      x-patternProperties:
        ^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\.[a-zA-Z_][a-zA-Z0-9_]*$:
          description: This property shall specify a valid odata or Redfish property.
    Certificate_v1_10_0_Links:
      additionalProperties: false
      description: The links to other resources that are related to this resource.
      properties:
        Issuer:
          description: A link to the certificate of the CA that issued this certificate.
          oneOf:
          - $ref: http://redfish.dmtf.org/schemas/v1/odata-v4.yaml#/components/schemas/odata-v4_idRef
          - enum:
            - null
          readOnly: false
          x-longDescription: This property shall contain a link to a resources of
            type `Certificate` that represents the certificate of the CA that issued
            this certificate.
          x-versionAdded: v1_4_0
        Oem:
          $ref: http://redfish.dmtf.org/schemas/v1/Resource.yaml#/components/schemas/Resource_Oem
          description: The OEM extension property.
          x-longDescription: This property shall contain the OEM extensions.  All
            values for properties contained in this object shall conform to the Redfish
            Specification-described requirements.
        Subjects:
          description: An array of links to certificates that were issued by the CA
            that is represented by this certificate.
          items:
            $ref: http://redfish.dmtf.org/schemas/v1/odata-v4.yaml#/components/schemas/odata-v4_idRef
          readOnly: false
          type: array
          x-longDescription: This property shall contain an array of links to resources
            of type `Certificate` that were issued by the CA that is represented by
            this certificate.
          x-versionAdded: v1_4_0
        Subjects@odata.count:
          $ref: http://redfish.dmtf.org/schemas/v1/odata-v4.yaml#/components/schemas/odata-v4_count
      type: object
      x-longDescription: This Redfish Specification-described type shall contain links
        to resources that are related to but are not contained by, or subordinate
        to, this resource.
      x-patternProperties:
        ^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\.[a-zA-Z_][a-zA-Z0-9_]*$:
          description: This property shall specify a valid odata or Redfish property.
    Certificate_v1_10_0_OemActions:
      additionalProperties: true
      description: The available OEM-specific actions for this resource.
      properties: {}
      type: object
      x-longDescription: This type shall contain the available OEM-specific actions
        for this resource.
      x-patternProperties:
        ^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\.[a-zA-Z_][a-zA-Z0-9_]*$:
          description: This property shall specify a valid odata or Redfish property.
    Certificate_v1_10_0_Rekey:
      additionalProperties: false
      description: This action generates a new key-pair for a certificate and produces
        a certificate signing request.
      properties:
        target:
          description: Link to invoke action
          format: uri-reference
          type: string
        title:
          description: Friendly action name
          type: string
      type: object
      x-longDescription: This action shall use the certificate data to generate a
        new key-pair for a certificate.  The response shall contain a signing request
        that a certificate authority (CA) will sign.  The service should retain the
        private key that generated this request for installation of the certificate.  The
        private key should not be part of the response.  The private key should not
        be part of the response.
      x-patternProperties:
        ^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\.[a-zA-Z_][a-zA-Z0-9_]*$:
          description: This property shall specify a valid odata or Redfish property.
      x-versionAdded: v1_1_0
    Certificate_v1_10_0_RekeyRequestBody:
      additionalProperties: false
      description: This action generates a new key-pair for a certificate and produces
        a certificate signing request.
      properties:
        ChallengePassword:
          description: The challenge password to apply to the certificate for revocation
            requests.
          type: string
          x-longDescription: This property shall contain the challenge password to
            apply to the certificate for revocation requests as defined by the RFC2985
            'challengePassword' attribute.
        KeyBitLength:
          description: The length of the key, in bits, if needed based on the `KeyPairAlgorithm`
            parameter value.
          format: int64
          type: integer
          x-longDescription: This parameter shall contain the length of the key, in
            bits, if needed based on the `KeyPairAlgorithm` parameter value.
        KeyCurveId:
          description: The curve ID to use with the key, if needed based on the `KeyPairAlgorithm`
            parameter value.
          type: string
          x-longDescription: This parameter shall contain the curve ID to use with
            the key, if needed based on the `KeyPairAlgorithm` parameter value.  The
            allowable values for this parameter shall be the strings in the 'Name'
            field of the 'TPM_ECC_CURVE Constants' table within the 'Trusted Computing
            Group Algorithm Registry'.
        KeyPairAlgorithm:
          description: The type of key-pair for use with signing algorithms.
          type: string
          x-longDescription: This parameter shall contain the type of key-pair for
            use with signing algorithms.  The allowable values for this parameter
            shall be the strings in the 'Algorithm Name' field of the 'TPM_ALG_ID
            Constants' table within the 'Trusted Computing Group Algorithm Registry'.
      type: object
      x-longDescription: This action shall use the certificate data to generate a
        new key-pair for a certificate.  The response shall contain a signing request
        that a certificate authority (CA) will sign.  The service should retain the
        private key that generated this request for installation of the certificate.  The
        private key should not be part of the response.  The private key should not
        be part of the response.
      x-patternProperties:
        ^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\.[a-zA-Z_][a-zA-Z0-9_]*$:
          description: This property shall specify a valid odata or Redfish property.
    Certificate_v1_10_0_RekeyResponse:
      additionalProperties: false
      description: The response body for the `Rekey` action.
      properties:
        CSRString:
          description: The string for the certificate signing request.
          readOnly: true
          type: string
          x-longDescription: This property shall contain the certificate signing request
            as a PEM-encoded string, containing structures specified by RFC2986.  The
            private key should not be part of the string.
          x-versionAdded: v1_1_0
        Certificate:
          $ref: http://redfish.dmtf.org/schemas/v1/odata-v4.yaml#/components/schemas/odata-v4_idRef
          description: The link to the certificate being rekeyed.
          readOnly: true
          x-longDescription: This property shall contain a link to a resource of type
            `Certificate` that is replaced after the certificate authority (CA) signs
            the certificate.
          x-versionAdded: v1_1_0
      required:
      - Certificate
      - CSRString
      type: object
      x-longDescription: This type shall contain the properties found in the response
        body for the `Rekey` action.
      x-patternProperties:
        ^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\.[a-zA-Z_][a-zA-Z0-9_]*$:
          description: This property shall specify a valid odata or Redfish property.
    Certificate_v1_10_0_Renew:
      additionalProperties: false
      description: This action generates a certificate signing request by using the
        existing information and key-pair of the certificate.
      properties:
        target:
          description: Link to invoke action
          format: uri-reference
          type: string
        title:
          description: Friendly action name
          type: string
      type: object
      x-longDescription: This action shall generate a certificate signing request
        using the existing information and key-pair of the certificate.  The response
        shall contain a signing request that a certificate authority (CA) will sign.  The
        service should retain the private key that this request generates for when
        the certificate is installed.  The private key should not be part of the response.
      x-patternProperties:
        ^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\.[a-zA-Z_][a-zA-Z0-9_]*$:
          description: This property shall specify a valid odata or Redfish property.
      x-versionAdded: v1_1_0
    Certificate_v1_10_0_RenewRequestBody:
      additionalProperties: false
      description: This action generates a certificate signing request by using the
        existing information and key-pair of the certificate.
      properties:
        ChallengePassword:
          description: The challenge password to apply to the certificate for revocation
            requests.
          type: string
          x-longDescription: This property shall contain the challenge password to
            apply to the certificate for revocation requests as defined by the RFC2985
            'challengePassword' attribute.
      type: object
      x-longDescription: This action shall generate a certificate signing request
        using the existing information and key-pair of the certificate.  The response
        shall contain a signing request that a certificate authority (CA) will sign.  The
        service should retain the private key that this request generates for when
        the certificate is installed.  The private key should not be part of the response.
      x-patternProperties:
        ^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\.[a-zA-Z_][a-zA-Z0-9_]*$:
          description: This property shall specify a valid odata or Redfish property.
    Certificate_v1_10_0_RenewResponse:
      additionalProperties: false
      description: The response body for the `Renew` action.
      properties:
        CSRString:
          description: The string for the certificate signing request.
          readOnly: true
          type: string
          x-longDescription: This property shall contain the certificate signing request
            as a PEM-encoded string, containing structures specified by RFC2986.  The
            private key should not be part of the string.
          x-versionAdded: v1_1_0
        Certificate:
          $ref: http://redfish.dmtf.org/schemas/v1/odata-v4.yaml#/components/schemas/odata-v4_idRef
          description: The link to the certificate being renewed.
          readOnly: true
          x-longDescription: This property shall contain a link to a resource of type
            `Certificate` that is replaced after the certificate authority (CA) signs
            the certificate.
          x-versionAdded: v1_1_0
      required:
      - Certificate
      - CSRString
      type: object
      x-longDescription: This type shall contain the properties found in the response
        body for the `Renew` action.
      x-patternProperties:
        ^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\.[a-zA-Z_][a-zA-Z0-9_]*$:
          description: This property shall specify a valid odata or Redfish property.
    Certificate_v1_10_0_SPDM:
      additionalProperties: false
      description: SPDM-related information for a certificate.
      properties:
        SlotId:
          description: Slot identifier of the certificate.
          format: int64
          nullable: true
          readOnly: true
          type: integer
          x-longDescription: The value of this property shall contain an integer between
            0 and 7, inclusive, that represents the slot identifier for an SPDM-provided
            certificate.
          x-versionAdded: v1_5_0
      type: object
      x-longDescription: This type shall contain SPDM-related information for a certificate.
      x-patternProperties:
        ^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\.[a-zA-Z_][a-zA-Z0-9_]*$:
          description: This property shall specify a valid odata or Redfish property.
title: '#Certificate.v1_10_0.Certificate'
x-copyright: Copyright 2014-2025 DMTF. For the full DMTF copyright policy, see http://www.dmtf.org/about/policies/copyright
x-language: en
x-owningEntity: DMTF
x-release: '2025.2'
