swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector enrollmentGroups API
schemes:
- https
tags:
- name: enrollmentGroups
paths:
  /enrollmentGroups:
    get:
      operationId: microsoftAzureEnrollmentgroupsList
      summary: Microsoft Azure Get The List Of Enrollment Groups In An Application
      x-ms-examples:
        List enrollment groups:
          $ref: ./examples/enrollmentgroups_list.json
      parameters:
      - $ref: '#/parameters/Version'
      x-ms-pageable:
        nextLinkName: nextLink
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/EnrollmentGroupCollection'
        default:
          description: An error response received from the IoT Central Service.
          headers:
            x-ms-error-code:
              type: string
              description: Error code for specific error that occurred.
          schema:
            $ref: '#/definitions/Error'
      description: Needs a more full description created.
      tags:
      - enrollmentGroups
  /enrollmentGroups/{enrollmentGroupId}:
    get:
      operationId: microsoftAzureEnrollmentgroupsGet
      summary: Microsoft Azure Get An Enrollment Group By Id
      description: Get details about an enrollment group by ID.
      x-ms-examples:
        Get an enrollment group by ID:
          $ref: ./examples/enrollmentgroups_get.json
      parameters:
      - $ref: '#/parameters/Version'
      - $ref: '#/parameters/EnrollmentGroupId'
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/EnrollmentGroup'
        default:
          description: An error response received from the IoT Central Service.
          headers:
            x-ms-error-code:
              type: string
              description: Error code for specific error that occurred.
          schema:
            $ref: '#/definitions/Error'
      tags:
      - enrollmentGroups
    put:
      operationId: microsoftAzureEnrollmentgroupsCreate
      summary: Microsoft Azure Create An Enrollment Group
      description: Create an enrollment group.
      x-ms-examples:
        Get an enrollment group:
          $ref: ./examples/enrollmentgroups_create.json
      parameters:
      - $ref: '#/parameters/Version'
      - $ref: '#/parameters/EnrollmentGroupId'
      - in: body
        name: body
        description: Enrollment group body.
        schema:
          $ref: '#/definitions/EnrollmentGroup'
        required: true
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/EnrollmentGroup'
        default:
          description: An error response received from the IoT Central Service.
          headers:
            x-ms-error-code:
              type: string
              description: Error code for specific error that occurred.
          schema:
            $ref: '#/definitions/Error'
      tags:
      - enrollmentGroups
    patch:
      operationId: microsoftAzureEnrollmentgroupsUpdate
      summary: Microsoft Azure Update An Enrollment Group
      description: Update an enrollment group.
      x-ms-examples:
        Update an enrollment group by ID:
          $ref: ./examples/enrollmentgroups_update.json
      consumes:
      - application/merge-patch+json
      parameters:
      - $ref: '#/parameters/Version'
      - $ref: '#/parameters/EnrollmentGroupId'
      - in: body
        name: body
        description: Enrollment group patch body.
        schema:
          type: object
        required: true
      - $ref: '#/parameters/IfMatch'
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/EnrollmentGroup'
        default:
          description: An error response received from the IoT Central Service.
          headers:
            x-ms-error-code:
              type: string
              description: Error code for specific error that occurred.
          schema:
            $ref: '#/definitions/Error'
      tags:
      - enrollmentGroups
    delete:
      operationId: microsoftAzureEnrollmentgroupsRemove
      summary: Microsoft Azure Delete An Enrollment Group
      description: Delete an enrollment group by ID.
      x-ms-examples:
        Remove an enrollment group by ID:
          $ref: ./examples/enrollmentgroups_delete.json
      parameters:
      - $ref: '#/parameters/Version'
      - $ref: '#/parameters/EnrollmentGroupId'
      responses:
        '204':
          description: Success
        default:
          description: An error response received from the IoT Central Service.
          headers:
            x-ms-error-code:
              type: string
              description: Error code for specific error that occurred.
          schema:
            $ref: '#/definitions/Error'
      tags:
      - enrollmentGroups
  /enrollmentGroups/{enrollmentGroupId}/certificates/{entry}:
    get:
      operationId: microsoftAzureEnrollmentgroupsGetx509
      summary: Microsoft Azure Get The Primary Or Secondary X509 Certificate Of An Enrollment Group
      description: Get details about the primary or secondary x509 certificate of an enrollment group, if it exists.
      x-ms-examples:
        Get primary or secondary X509:
          $ref: ./examples/enrollmentgroups_getx509.json
      parameters:
      - $ref: '#/parameters/Version'
      - $ref: '#/parameters/EnrollmentGroupId'
      - $ref: '#/parameters/Entry'
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/SigningX509Certificate'
        default:
          description: An error response received from the IoT Central Service.
          headers:
            x-ms-error-code:
              type: string
              description: Error code for specific error that occurred.
          schema:
            $ref: '#/definitions/Error'
      tags:
      - enrollmentGroups
    put:
      operationId: microsoftAzureEnrollmentgroupsCreatex509
      summary: Microsoft Azure Sets The Primary Or Secondary X509 Certificate Of An Enrollment Group
      description: Sets the primary or secondary x509 certificate of an enrollment group.
      x-ms-examples:
        Set primary or secondary X509:
          $ref: ./examples/enrollmentgroups_setx509.json
      parameters:
      - $ref: '#/parameters/Version'
      - $ref: '#/parameters/EnrollmentGroupId'
      - $ref: '#/parameters/Entry'
      - in: body
        name: body
        description: Certificate definition.
        schema:
          $ref: '#/definitions/SigningX509Certificate'
        required: true
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/SigningX509Certificate'
        default:
          description: An error response received from the IoT Central Service.
          headers:
            x-ms-error-code:
              type: string
              description: Error code for specific error that occurred.
          schema:
            $ref: '#/definitions/Error'
      tags:
      - enrollmentGroups
    delete:
      operationId: microsoftAzureEnrollmentgroupsRemovex509
      summary: Microsoft Azure Removes The Primary Or Secondary X509 Certificate Of An Enrollment Group
      description: Removes the primary or secondary x509 certificate of an enrollment group.
      x-ms-examples:
        Remove primary or secondary X509:
          $ref: ./examples/enrollmentgroups_removex509.json
      parameters:
      - $ref: '#/parameters/Version'
      - $ref: '#/parameters/EnrollmentGroupId'
      - $ref: '#/parameters/Entry'
      responses:
        '204':
          description: Success
        default:
          description: An error response received from the IoT Central Service.
          headers:
            x-ms-error-code:
              type: string
              description: Error code for specific error that occurred.
          schema:
            $ref: '#/definitions/Error'
      tags:
      - enrollmentGroups
  /enrollmentGroups/{enrollmentGroupId}/certificates/{entry}/generateVerificationCode:
    post:
      operationId: microsoftAzureEnrollmentgroupsGenerateverificationcodex509
      summary: Microsoft Azure Generate A Verification Code For The Primary Or Secondary X509 Certificate Of An Enrollment Group
      description: Generate a verification code for the primary or secondary x509 certificate of an enrollment group.
      x-ms-examples:
        Generate primary or secondary X509 verification code:
          $ref: ./examples/enrollmentgroups_generateverificationcodex509.json
      parameters:
      - $ref: '#/parameters/Version'
      - $ref: '#/parameters/EnrollmentGroupId'
      - $ref: '#/parameters/Entry'
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/X509VerificationCode'
        default:
          description: An error response received from the IoT Central Service.
          headers:
            x-ms-error-code:
              type: string
              description: Error code for specific error that occurred.
          schema:
            $ref: '#/definitions/Error'
      tags:
      - enrollmentGroups
  /enrollmentGroups/{enrollmentGroupId}/certificates/{entry}/verify:
    post:
      operationId: microsoftAzureEnrollmentgroupsVerifyx509
      summary: Microsoft Azure Verify The Primary Or Secondary X509 Certificate Of An Enrollment Group
      description: Verify the primary or secondary x509 certificate of an enrollment group by providing a certificate with the signed verification code.
      x-ms-examples:
        Verify primary or secondary X509 verification code:
          $ref: ./examples/enrollmentgroups_verifyx509.json
      parameters:
      - $ref: '#/parameters/Version'
      - $ref: '#/parameters/EnrollmentGroupId'
      - $ref: '#/parameters/Entry'
      - in: body
        name: body
        description: Certificate for the signed verification code.
        schema:
          $ref: '#/definitions/X509VerificationCertificate'
        required: true
      responses:
        '204':
          description: Success
        default:
          description: An error response received from the IoT Central Service.
          headers:
            x-ms-error-code:
              type: string
              description: Error code for specific error that occurred.
          schema:
            $ref: '#/definitions/Error'
      tags:
      - enrollmentGroups
definitions:
  SigningX509Certificate:
    description: The X509 certificate definition.
    type: object
    properties:
      verified:
        description: Whether the certificate has been verified.
        type: boolean
        default: false
      certificate:
        description: The string representation of this certificate.
        type: string
      info:
        description: Information about this certificate.
        readOnly: true
        $ref: '#/definitions/X509CertificateInfo'
      etag:
        description: ETag used to prevent conflict across multiple updates
        type: string
  GroupAttestation:
    description: The attestation definition for an enrollment group.
    type: object
    properties:
      type:
        description: Type of the attestation.
        type: string
    required:
    - type
    discriminator: type
  ErrorDetails:
    description: The detail information of the error.
    type: object
    properties:
      code:
        type: string
        description: Error code.
      message:
        type: string
        description: Error message details.
      requestId:
        type: string
        description: Correlation Id for current request.
      time:
        type: string
        format: date-time-rfc1123
        description: The time that error request failed.
    required:
    - code
    - message
  EnrollmentGroupCollection:
    description: The paged results of enrollment groups.
    type: object
    properties:
      value:
        description: The collection of enrollment groups.
        type: array
        items:
          $ref: '#/definitions/EnrollmentGroup'
      nextLink:
        description: URL to get the next page of enrollment groups.
        type: string
    required:
    - value
  X509VerificationCode:
    description: The X509 certificate verification code.
    type: object
    properties:
      verificationCode:
        description: The X509 certificate verification code.
        type: string
        readOnly: true
  EnrollmentGroup:
    description: The enrollment group definition.
    type: object
    properties:
      id:
        description: Unique ID of the enrollment group.
        type: string
        readOnly: true
      displayName:
        description: Display name of the enrollment group.
        type: string
      enabled:
        description: Whether the devices using the group are allowed to connect to IoT Central.
        type: boolean
        default: true
      type:
        description: Type of devices that connect through the group.
        type: string
        enum:
        - iot
        - iotEdge
        x-ms-enum:
          name: EnrollmentGroupType
          modelAsString: false
          values:
          - value: iot
            name: IoT devices
            description: Regular (non-Edge) IoT devices
          - value: iotEdge
            name: IoT Edge devices
            description: IoT Edge devices
      attestation:
        description: The attestation mechanism for the enrollment group.
        $ref: '#/definitions/GroupAttestation'
      etag:
        description: ETag used to prevent conflict in enrollment group updates.
        type: string
      idScope:
        description: ID scope for connecting to the IoT Central application.
        type: string
        readOnly: true
    required:
    - displayName
    - attestation
    - type
  X509VerificationCertificate:
    description: The X509 verification certificate definition.
    type: object
    properties:
      certificate:
        description: The string representation of this certificate.
        type: string
    required:
    - certificate
  X509CertificateInfo:
    description: The X509 certificate info.
    type: object
    properties:
      sha1Thumbprint:
        description: The SHA-1 hash value of the certificate.
        type: string
    required:
    - sha1Thumbprint
  Error:
    description: The response error definition.
    type: object
    properties:
      error:
        description: Error details for current request.
        $ref: '#/definitions/ErrorDetails'
    required:
    - error
parameters:
  Entry:
    in: path
    name: entry
    description: Entry of certificate only support primary and secondary.
    x-ms-parameter-location: method
    type: string
    enum:
    - primary
    - secondary
    x-ms-enum:
      name: CertificateEntry
      modelAsString: false
      values:
      - value: primary
        name: Primary
        description: The entry of primary certificate
      - value: secondary
        name: Secondary
        description: The entry of secondary certificate
    required: true
  EnrollmentGroupId:
    in: path
    name: enrollmentGroupId
    description: Unique ID of the enrollment group.
    x-ms-parameter-location: method
    type: string
    maxLength: 255
    pattern: ^[a-zA-Z0-9-]*$
    required: true
  Version:
    in: query
    name: api-version
    description: The version of the API being called.
    x-ms-parameter-location: client
    type: string
    required: true
  IfMatch:
    in: header
    name: If-Match
    description: Only perform the operation if the entity's etag matches one of the etags provided or * is provided.
    x-ms-parameter-location: method
    type: string
    required: false
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'