components:
  schemas:
    Certificate_v1_1_1_Actions:
      additionalProperties: false
      description: The available actions for this Resource.
      properties:
        '#Certificate.Rekey':
          $ref: '#/components/schemas/Certificate_v1_1_1_Rekey'
        '#Certificate.Renew':
          $ref: '#/components/schemas/Certificate_v1_1_1_Renew'
        Oem:
          $ref: '#/components/schemas/Certificate_v1_1_1_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_1_1_Certificate:
      additionalProperties: false
      description: The Certificate schema describes a certificate that proves the
        identify 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_1_1_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.
        CertificateType:
          $ref: http://redfish.dmtf.org/schemas/v1/Certificate.yaml#/components/schemas/Certificate_CertificateType
          description: The format of the certificate.
          nullable: true
          readOnly: true
          x-longDescription: This property shall contain the format type for the certificate.
        Description:
          $ref: http://redfish.dmtf.org/schemas/v1/Resource.yaml#/components/schemas/Resource_Description
          nullable: true
          readOnly: true
        Id:
          $ref: http://redfish.dmtf.org/schemas/v1/Resource.yaml#/components/schemas/Resource_Id
          readOnly: true
        Issuer:
          $ref: '#/components/schemas/Certificate_v1_1_1_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:
            $ref: http://redfish.dmtf.org/schemas/v1/Certificate.yaml#/components/schemas/Certificate_KeyUsage
            nullable: true
          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.
        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.
        Subject:
          $ref: '#/components/schemas/Certificate_v1_1_1_Identifier'
          description: The subject of the certificate.
          x-longDescription: This property shall contain an object containing information
            about the subject of the certificate.
        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 contains 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_1_1_Identifier:
      additionalProperties: false
      description: The identifier information about a certificate.
      properties:
        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.
        CommonName:
          description: The fully qualified domain name of the entity.
          readOnly: true
          type: string
          x-longDescription: This property shall contain the fully qualified domain
            name of the entity.
        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.
        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.
        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.
        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.
        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.
      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_1_1_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_1_1_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) must 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_1_1_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.
          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) must 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.
    Certificate_v1_1_1_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 the URI of the Certificate
            Resource 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_1_1_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) must 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_1_1_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) must 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.
    Certificate_v1_1_1_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 the URI of the Certificate
            Resource 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.
title: '#Certificate.v1_1_1.Certificate'
x-copyright: Copyright 2014-2019 DMTF. For the full DMTF copyright policy, see http://www.dmtf.org/about/policies/copyright
x-owningEntity: DMTF
x-release: '2019.1'
