components:
  schemas:
    CertificateService_v1_0_2_Actions:
      additionalProperties: false
      description: The available actions for this Resource.
      properties:
        '#CertificateService.GenerateCSR':
          $ref: '#/components/schemas/CertificateService_v1_0_2_GenerateCSR'
        '#CertificateService.ReplaceCertificate':
          $ref: '#/components/schemas/CertificateService_v1_0_2_ReplaceCertificate'
        Oem:
          $ref: '#/components/schemas/CertificateService_v1_0_2_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.
    CertificateService_v1_0_2_CertificateService:
      additionalProperties: false
      description: The CertificateService schema describes a Certificate Service that
        represents the actions available to manage certificates and links to the certificates.
      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/CertificateService_v1_0_2_Actions'
          description: The available actions for this Resource.
          x-longDescription: This property shall contain the available actions for
            this Resource.
        CertificateLocations:
          $ref: http://redfish.dmtf.org/schemas/v1/odata-v4.yaml#/components/schemas/odata-v4_idRef
          description: The information about the location of certificates.
          readOnly: true
          x-longDescription: This property shall contain the link to a Resource of
            type CertificateLocations.
        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
        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.
      required:
      - '@odata.id'
      - '@odata.type'
      - Id
      - Name
      type: object
      x-longDescription: This Resource shall represent the Certificate Service properties
        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.
    CertificateService_v1_0_2_GenerateCSR:
      additionalProperties: false
      description: This action makes 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 make a certificate signing request.  The
        response shall contain a signing request that a certificate authority (CA)
        must sign.  The Service should retain the private key that was generated during
        this request for installation of the certificate.  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.
    CertificateService_v1_0_2_GenerateCSRRequestBody:
      additionalProperties: false
      description: This action makes a certificate signing request.
      properties:
        AlternativeNames:
          description: The additional host names of the component to secure.
          items:
            type: string
          type: array
          x-longDescription: This parameter shall contain an array of additional host
            names of the component to secure, as defined by the RFC5280 'subjectAltName'
            attribute.
        CertificateCollection:
          $ref: http://redfish.dmtf.org/schemas/v1/odata-v4.yaml#/components/schemas/odata-v4_idRef
          description: The URI of the Certificate Resource Collection where the certificate
            is installed after the certificate authority (CA) signs the certificate.
          x-longDescription: This parameter shall contain the URI of the Certificate
            Resource Collection where the certificate is installed after the certificate
            authority (CA) signs the certificate.
        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.
        City:
          description: The city or locality of the organization making the request.
          type: string
          x-longDescription: This parameter shall contain the city or locality of
            the organization making the request, as defined by the RFC5280 'localityName'
            attribute.
        CommonName:
          description: The fully qualified domain name of the component to secure.
          type: string
          x-longDescription: This parameter shall contain the fully qualified domain
            name of the component to secure, as defined by the RFC5280 'commonName'
            attribute.
        ContactPerson:
          description: The name of the user making the request.
          type: string
          x-longDescription: This property shall contain the name of the user making
            the request, as defined by the RFC5280 'name' attribute.
        Country:
          description: The two-letter country code of the organization making the
            request.
          type: string
          x-longDescription: This parameter shall contain the two-letter ISO code
            for the country of the organization making the request, as defined by
            the RFC5280 'countryName' attribute.
        Email:
          description: The email address of the contact within the organization making
            the request.
          type: string
          x-longDescription: This parameter shall contain the email address of the
            contact within the organization making the request, as defined by the
            RFC2985 'emailAddress' attribute.
        GivenName:
          description: The given name of the user making the request.
          type: string
          x-longDescription: This parameter shall contain the given name of the user
            making the request, as defined by the RFC5280 'givenName' attribute.
        Initials:
          description: The initials of the user making the request.
          type: string
          x-longDescription: This parameter shall contain the initials of the user
            making the request, as defined by the RFC5280 'initials' 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'.
        KeyUsage:
          description: The usage of the key contained in the certificate.
          items:
            $ref: http://redfish.dmtf.org/schemas/v1/Certificate.yaml#/components/schemas/Certificate_KeyUsage
          type: array
          x-longDescription: This parameter shall contain the usage of the key contained
            in the certificate.  If the client does not provide this value, the service
            may determine the appropriate key usage settings in the certificate signing
            request.
        Organization:
          description: The name of the organization making the request.
          type: string
          x-longDescription: This parameter shall contain the name of the organization
            making the request, as defined by the RFC5280 'organizationName' attribute.
        OrganizationalUnit:
          description: The name of the unit or division of the organization making
            the request.
          type: string
          x-longDescription: This parameter shall contain the name of the unit or
            division of the organization making the request, as defined by the RFC5280
            'organizationalUnitName' attribute.
        State:
          description: The state, province, or region of the organization making the
            request.
          type: string
          x-longDescription: This parameter shall contain the state, province, or
            region of the organization making the request, as defined by the RFC5280
            'stateOrProvinceName' attribute.
        Surname:
          description: The surname of the user making the request.
          type: string
          x-longDescription: This parameter shall contain the surname of the user
            making the request, as defined by the RFC5280 'surname' attribute.
        UnstructuredName:
          description: The unstructured name of the subject.
          type: string
          x-longDescription: This property shall contain the unstructured name of
            the subject, as defined by the RFC2985 'unstructuredName' attribute.
      required:
      - CertificateCollection
      - City
      - CommonName
      - Country
      - Organization
      - OrganizationalUnit
      - State
      type: object
      x-longDescription: This action shall make a certificate signing request.  The
        response shall contain a signing request that a certificate authority (CA)
        must sign.  The Service should retain the private key that was generated during
        this request for installation of the certificate.  The private key should
        not be part of the response.
    CertificateService_v1_0_2_GenerateCSRResponse:
      additionalProperties: false
      description: The response body for the GenerateCSR action.
      properties:
        CSRString:
          description: The string for the certificate signing request.
          readOnly: true
          type: string
          x-longDescription: This property shall contain the Privacy Enhanced Mail
            (PEM)-encoded string, which contains RFC2986-specified structures, of
            the certificate signing request.  The private key should not be part of
            the string.
        CertificateCollection:
          $ref: http://redfish.dmtf.org/schemas/v1/odata-v4.yaml#/components/schemas/odata-v4_idRef
          description: The link to the Certificate Resource Collection where the certificate
            is installed.
          readOnly: true
          x-longDescription: This property shall contain the URI of the Certificate
            Resource Collection where the certificate is installed after the certificate
            authority (CA) has signed the certificate.
      required:
      - CertificateCollection
      - CSRString
      type: object
      x-longDescription: This type shall contain the properties found in the response
        body for the GenerateCSR 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.
    CertificateService_v1_0_2_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.
    CertificateService_v1_0_2_ReplaceCertificate:
      additionalProperties: false
      description: This action replaces a 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 replace a certificate.  The Location header
        in the response shall contain the URI of the new Certificate 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.
    CertificateService_v1_0_2_ReplaceCertificateRequestBody:
      additionalProperties: false
      description: This action replaces a certificate.
      properties:
        CertificateString:
          description: The string for the certificate.
          type: string
          x-longDescription: This parameter shall contain the string of 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 it 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.
          x-longDescription: This parameter shall contain the format type for the
            certificate.
        CertificateUri:
          $ref: http://redfish.dmtf.org/schemas/v1/odata-v4.yaml#/components/schemas/odata-v4_idRef
          description: The link to the certificate that is being replaced.
          x-longDescription: This parameter shall contain the URI of the Certificate
            Resource that is being replaced.
      required:
      - CertificateString
      - CertificateType
      - CertificateUri
      type: object
      x-longDescription: This action shall replace a certificate.  The Location header
        in the response shall contain the URI of the new Certificate Resource.
title: '#CertificateService.v1_0_2.CertificateService'
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: '2018.3'
