swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector CertificateProfiles API
schemes:
- https
tags:
- name: CertificateProfiles
paths:
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CodeSigning/codeSigningAccounts/{accountName}/certificateProfiles
  : get:
      operationId: microsoftAzureCertificateprofilesListbycodesigningaccount
      tags:
      - CertificateProfiles
      description: List certificate profiles under a trusted signing account.
      parameters:
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
      - name: accountName
        in: path
        description: Trusted Signing account name.
        required: true
        type: string
        pattern: ^(?=.{3,24}$)[^0-9][A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$
      responses:
        '200':
          description: Azure operation completed successfully.
          schema:
            $ref: '#/definitions/CertificateProfileListResult'
        default:
          description: An unexpected error response.
          schema:
            $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
      x-ms-examples:
        List certificate profiles under a trusted signing account.:
          $ref: ./examples/CertificateProfiles_ListByCodeSigningAccount.json
      x-ms-pageable:
        nextLinkName: nextLink
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Codesigning Codesigningaccounts Accountname Certificateprofiles
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CodeSigning/codeSigningAccounts/{accountName}/certificateProfiles/{profileName}
  : get:
      operationId: microsoftAzureCertificateprofilesGet
      tags:
      - CertificateProfiles
      description: Get details of a certificate profile.
      parameters:
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
      - name: accountName
        in: path
        description: Trusted Signing account name.
        required: true
        type: string
        pattern: ^(?=.{3,24}$)[^0-9][A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$
      - name: profileName
        in: path
        description: Certificate profile name.
        required: true
        type: string
        pattern: ^(?=.{5,100}$)[^0-9][A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$
      responses:
        '200':
          description: Azure operation completed successfully.
          schema:
            $ref: '#/definitions/CertificateProfile'
        default:
          description: An unexpected error response.
          schema:
            $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
      x-ms-examples:
        Get details of a certificate profile.:
          $ref: ./examples/CertificateProfiles_Get.json
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Codesigning Codesigningaccounts Accountname Certificateprofiles Profilename
    put:
      operationId: microsoftAzureCertificateprofilesCreate
      tags:
      - CertificateProfiles
      description: Create a certificate profile.
      parameters:
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
      - name: accountName
        in: path
        description: Trusted Signing account name.
        required: true
        type: string
        pattern: ^(?=.{3,24}$)[^0-9][A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$
      - name: profileName
        in: path
        description: Certificate profile name.
        required: true
        type: string
        pattern: ^(?=.{5,100}$)[^0-9][A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$
      - name: resource
        in: body
        description: Parameters to create the certificate profile
        required: true
        schema:
          $ref: '#/definitions/CertificateProfile'
      responses:
        '200':
          description: Resource 'CertificateProfile' update operation succeeded
          schema:
            $ref: '#/definitions/CertificateProfile'
        '201':
          description: Resource 'CertificateProfile' create operation succeeded
          schema:
            $ref: '#/definitions/CertificateProfile'
          headers:
            Retry-After:
              type: integer
              format: int32
              description: The Retry-After header can indicate how long the client should wait before polling the operation status.
        default:
          description: An unexpected error response.
          schema:
            $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
      x-ms-examples:
        Create a certificate profile.:
          $ref: ./examples/CertificateProfiles_Create.json
      x-ms-long-running-operation-options:
        final-state-via: azure-async-operation
      x-ms-long-running-operation: true
      summary: Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Codesigning Codesigningaccounts Accountname Certificateprofiles Profilename
    delete:
      operationId: microsoftAzureCertificateprofilesDelete
      tags:
      - CertificateProfiles
      description: Delete a certificate profile.
      parameters:
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
      - name: accountName
        in: path
        description: Trusted Signing account name.
        required: true
        type: string
        pattern: ^(?=.{3,24}$)[^0-9][A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$
      - name: profileName
        in: path
        description: Certificate profile name.
        required: true
        type: string
        pattern: ^(?=.{5,100}$)[^0-9][A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$
      responses:
        '202':
          description: Resource deletion accepted.
          headers:
            Location:
              type: string
              description: The Location header contains the URL where the status of the long running operation can be checked.
            Retry-After:
              type: integer
              format: int32
              description: The Retry-After header can indicate how long the client should wait before polling the operation status.
        '204':
          description: Resource does not exist.
        default:
          description: An unexpected error response.
          schema:
            $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
      x-ms-examples:
        Delete a certificate profile.:
          $ref: ./examples/CertificateProfiles_Delete.json
      x-ms-long-running-operation-options:
        final-state-via: location
      x-ms-long-running-operation: true
      summary: Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Codesigning Codesigningaccounts Accountname Certificateprofiles Profilename
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CodeSigning/codeSigningAccounts/{accountName}/certificateProfiles/{profileName}/revokeCertificate
  : post:
      operationId: microsoftAzureCertificateprofilesRevokecertificate
      tags:
      - CertificateProfiles
      description: Revoke a certificate under a certificate profile.
      parameters:
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
      - name: accountName
        in: path
        description: Trusted Signing account name.
        required: true
        type: string
        pattern: ^(?=.{3,24}$)[^0-9][A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$
      - name: profileName
        in: path
        description: Certificate profile name.
        required: true
        type: string
        pattern: ^(?=.{5,100}$)[^0-9][A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$
      - name: body
        in: body
        description: Parameters to revoke the certificate profile
        required: true
        schema:
          $ref: '#/definitions/RevokeCertificate'
      responses:
        '204':
          description: Action completed successfully.
        default:
          description: An unexpected error response.
          schema:
            $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
      x-ms-examples:
        Revoke a certificate under a certificate profile.:
          $ref: ./examples/CertificateProfiles_RevokeCertificate.json
      summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Codesigning Codesigningaccounts Accountname Certificateprofiles Profilename Revokecertificate
definitions:
  RevokeCertificate:
    type: object
    description: Defines the certificate revocation properties.
    properties:
      serialNumber:
        type: string
        description: Serial number of the certificate.
      thumbprint:
        type: string
        description: Thumbprint of the certificate.
      effectiveAt:
        type: string
        format: date-time
        description: The timestamp when the revocation is effective.
      reason:
        type: string
        description: Reason for the revocation.
      remarks:
        type: string
        description: Remarks for the revocation.
    required:
    - serialNumber
    - thumbprint
    - effectiveAt
    - reason
  CertificateProfileStatus:
    type: string
    description: Status of the certificate profiles.
    enum:
    - Active
    - Disabled
    - Suspended
    x-ms-enum:
      name: CertificateProfileStatus
      modelAsString: true
      values:
      - name: Active
        value: Active
        description: The certificate profile is active.
      - name: Disabled
        value: Disabled
        description: The certificate profile is disabled.
      - name: Suspended
        value: Suspended
        description: The certificate profile is suspended.
  Certificate:
    type: object
    description: Properties of the certificate.
    properties:
      serialNumber:
        type: string
        description: Serial number of the certificate.
      subjectName:
        type: string
        description: Subject name of the certificate.
      thumbprint:
        type: string
        description: Thumbprint of the certificate.
      createdDate:
        type: string
        description: Certificate created date.
      expiryDate:
        type: string
        description: Certificate expiry date.
      status:
        $ref: '#/definitions/CertificateStatus'
        description: Status of the certificate.
      revocation:
        $ref: '#/definitions/Revocation'
        description: Revocations history of a certificate.
        x-ms-client-flatten: true
  ProfileType:
    type: string
    description: Type of the certificate
    enum:
    - PublicTrust
    - PrivateTrust
    - PrivateTrustCIPolicy
    - VBSEnclave
    - PublicTrustTest
    x-ms-enum:
      name: ProfileType
      modelAsString: true
      values:
      - name: PublicTrust
        value: PublicTrust
        description: Used for signing files which are distributed publicly.
      - name: PrivateTrust
        value: PrivateTrust
        description: Used for signing files which are distributed internally within organization or group boundary.
      - name: PrivateTrustCIPolicy
        value: PrivateTrustCIPolicy
        description: Used for signing CI policy files.
      - name: VBSEnclave
        value: VBSEnclave
        description: Used for signing files which are run in secure vbs enclave.
      - name: PublicTrustTest
        value: PublicTrustTest
        description: Used for signing files for testing purpose.
  CertificateStatus:
    type: string
    description: Status of the certificate
    enum:
    - Active
    - Expired
    - Revoked
    x-ms-enum:
      name: CertificateStatus
      modelAsString: true
      values:
      - name: Active
        value: Active
        description: The certificate is active.
      - name: Expired
        value: Expired
        description: The certificate is expired.
      - name: Revoked
        value: Revoked
        description: The certificate is revoked.
  RevocationStatus:
    type: string
    description: Revocation status of the certificate.
    enum:
    - Succeeded
    - InProgress
    - Failed
    x-ms-enum:
      name: RevocationStatus
      modelAsString: true
      values:
      - name: Succeeded
        value: Succeeded
        description: Certificate revocation succeeded.
      - name: InProgress
        value: InProgress
        description: Certificate revocation is in progress.
      - name: Failed
        value: Failed
        description: Certificate revocation failed.
    readOnly: true
  Revocation:
    type: object
    description: Revocation details of the certificate.
    properties:
      requestedAt:
        type: string
        format: date-time
        description: The timestamp when the revocation is requested.
      effectiveAt:
        type: string
        format: date-time
        description: The timestamp when the revocation is effective.
      reason:
        type: string
        description: Reason for revocation.
      remarks:
        type: string
        description: Remarks for the revocation.
      status:
        $ref: '#/definitions/RevocationStatus'
        description: Status of the revocation.
      failureReason:
        type: string
        description: Reason for the revocation failure.
  CertificateProfileListResult:
    type: object
    description: The response of a CertificateProfile list operation.
    properties:
      value:
        type: array
        description: The CertificateProfile items on this page
        items:
          $ref: '#/definitions/CertificateProfile'
      nextLink:
        type: string
        format: uri
        description: The link to the next page of items
    required:
    - value
  ProvisioningState:
    type: string
    description: The status of the current operation.
    enum:
    - Succeeded
    - Failed
    - Canceled
    - Updating
    - Deleting
    - Accepted
    x-ms-enum:
      name: ProvisioningState
      modelAsString: true
      values:
      - name: Succeeded
        value: Succeeded
        description: Resource has been created.
      - name: Failed
        value: Failed
        description: Resource creation failed.
      - name: Canceled
        value: Canceled
        description: Resource creation was canceled.
      - name: Updating
        value: Updating
        description: Updating in progress.
      - name: Deleting
        value: Deleting
        description: Deletion in progress.
      - name: Accepted
        value: Accepted
        description: Resource creation started.
    readOnly: true
  CertificateProfile:
    type: object
    description: Certificate profile resource.
    properties:
      properties:
        $ref: '#/definitions/CertificateProfileProperties'
        description: The resource-specific properties for this resource.
        x-ms-client-flatten: true
        x-ms-mutability:
        - read
        - create
    allOf:
    - $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource
  CertificateProfileProperties:
    type: object
    description: Properties of the certificate profile.
    properties:
      profileType:
        $ref: '#/definitions/ProfileType'
        description: Profile type of the certificate.
      commonName:
        type: string
        description: Used as CN in the certificate subject name.
        readOnly: true
      organization:
        type: string
        description: Used as O in the certificate subject name.
        readOnly: true
      organizationUnit:
        type: string
        description: Used as OU in the private trust certificate subject name.
        readOnly: true
      streetAddress:
        type: string
        description: Used as STREET in the certificate subject name.
        readOnly: true
      includeStreetAddress:
        type: boolean
        description: Whether to include STREET in the certificate subject name.
        default: false
      city:
        type: string
        description: Used as L in the certificate subject name.
        readOnly: true
      includeCity:
        type: boolean
        description: Whether to include L in the certificate subject name. Applicable only for private trust, private trust ci profile types
        default: false
      state:
        type: string
        description: Used as S in the certificate subject name.
        readOnly: true
      includeState:
        type: boolean
        description: Whether to include S in the certificate subject name. Applicable only for private trust, private trust ci profile types
        default: false
      country:
        type: string
        description: Used as C in the certificate subject name.
        readOnly: true
      includeCountry:
        type: boolean
        description: Whether to include C in the certificate subject name. Applicable only for private trust, private trust ci profile types
        default: false
      postalCode:
        type: string
        description: Used as PC in the certificate subject name.
        readOnly: true
      includePostalCode:
        type: boolean
        description: Whether to include PC in the certificate subject name.
        default: false
      enhancedKeyUsage:
        type: string
        description: Enhanced key usage of the certificate.
        readOnly: true
      identityValidationId:
        type: string
        description: Identity validation id used for the certificate subject name.
      provisioningState:
        $ref: '#/definitions/ProvisioningState'
        description: Status of the current operation on certificate profile.
        readOnly: true
      status:
        $ref: '#/definitions/CertificateProfileStatus'
        description: Status of the certificate profile.
        readOnly: true
      certificates:
        type: array
        description: List of renewed certificates.
        items:
          $ref: '#/definitions/Certificate'
        readOnly: true
        x-ms-client-flatten: true
        x-ms-identifiers: []
    required:
    - profileType
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'