swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector DeviceRegistrationState API
schemes:
- https
tags:
- name: DeviceRegistrationState
paths:
  /registrations/{id}:
    get:
      tags:
      - DeviceRegistrationState
      summary: Microsoft Azure Gets The Device Registration State
      operationId: microsoftAzureDeviceregistrationstateGet
      consumes: []
      produces:
      - application/json
      parameters:
      - name: id
        in: path
        description: Registration ID.
        required: true
        type: string
      - $ref: '#/parameters/ApiVersionParameter'
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/DeviceRegistrationState'
        default:
          description: Error response
          schema:
            $ref: '#/definitions/ProvisioningServiceErrorDetails'
          headers:
            x-ms-error-code:
              description: The error code for specific error that occurred.
              type: string
      description: Needs a more full description created.
    delete:
      tags:
      - DeviceRegistrationState
      summary: Microsoft Azure Deletes The Device Registration
      operationId: microsoftAzureDeviceregistrationstateDelete
      consumes: []
      produces:
      - application/json
      parameters:
      - name: id
        in: path
        description: Registration ID.
        required: true
        type: string
      - name: If-Match
        in: header
        description: The ETag of the registration status record.
        required: false
        type: string
      - $ref: '#/parameters/ApiVersionParameter'
      responses:
        '204':
          description: Success
        default:
          description: Error response
          schema:
            $ref: '#/definitions/ProvisioningServiceErrorDetails'
          headers:
            x-ms-error-code:
              description: The error code for specific error that occurred.
              type: string
      description: Needs a more full description created.
  /registrations/{id}/query:
    post:
      tags:
      - DeviceRegistrationState
      summary: Microsoft Azure Gets The Registration State Of Devices In This Enrollmentgroup
      operationId: microsoftAzureDeviceregistrationstateQuery
      consumes: []
      produces:
      - application/json
      parameters:
      - name: id
        in: path
        description: Enrollment group ID.
        required: true
        type: string
      - name: x-ms-max-item-count
        in: header
        description: pageSize
        required: false
        type: integer
        format: int32
      - name: x-ms-continuation
        in: header
        description: continuation token
        required: false
        type: string
      - $ref: '#/parameters/ApiVersionParameter'
      responses:
        '200':
          description: Success
          schema:
            type: array
            items:
              $ref: '#/definitions/DeviceRegistrationState'
          headers:
            x-ms-continuation:
              description: The continuation token for getting the next page of results.
              type: string
            x-ms-max-item-count:
              description: The maximum number of items returned in a page.
              type: integer
            x-ms-item-type:
              description: The list of values returned from the query.
              type: string
        default:
          description: Error response
          schema:
            $ref: '#/definitions/ProvisioningServiceErrorDetails'
          headers:
            x-ms-error-code:
              description: The error code for specific error that occurred.
              type: string
      description: Needs a more full description created.
definitions:
  ProvisioningServiceErrorDetails:
    description: Contains the properties of an error returned by the Azure IoT Hub Provisioning Service.
    type: object
    properties:
      errorCode:
        format: int32
        type: integer
      trackingId:
        type: string
      message:
        type: string
      info:
        type: object
        additionalProperties:
          type: string
      timestampUtc:
        format: date-time
        type: string
  DeviceRegistrationState:
    description: Device registration state.
    type: object
    properties:
      registrationId:
        description: "This id is used to uniquely identify a device registration of an enrollment.\r\nA case-insensitive string (up to 128 characters long) of alphanumeric characters plus certain special characters : . _ -. No special characters allowed at start or end."
        type: string
        readOnly: true
      createdDateTimeUtc:
        format: date-time
        description: Registration create date time (in UTC).
        type: string
        readOnly: true
      assignedHub:
        description: Assigned Azure IoT Hub.
        type: string
        readOnly: true
      deviceId:
        description: Device ID.
        type: string
        readOnly: true
      status:
        description: Enrollment status.
        enum:
        - unassigned
        - assigning
        - assigned
        - failed
        - disabled
        type: string
        readOnly: true
      substatus:
        description: 'Substatus for ''Assigned'' devices. Possible values include - ''initialAssignment'': Device has been assigned to an IoT hub for the first time, ''deviceDataMigrated'': Device has been assigned to a different IoT hub and its device data was migrated from the previously assigned IoT hub. Device data was removed from the previously assigned IoT hub, ''deviceDataReset'':  Device has been assigned to a different IoT hub and its device data was populated from the initial state stored in the enrollment. Device data was removed from the previously assigned IoT hub, ''reprovisionedToInitialAssignment'': Device has been re-provisioned to a previously assigned IoT hub.'
        enum:
        - initialAssignment
        - deviceDataMigrated
        - deviceDataReset
        - reprovisionedToInitialAssignment
        type: string
        readOnly: true
      errorCode:
        format: int32
        description: Error code.
        type: integer
        readOnly: true
      errorMessage:
        description: Error message.
        type: string
        readOnly: true
      lastUpdatedDateTimeUtc:
        format: date-time
        description: Last updated date time (in UTC).
        type: string
        readOnly: true
      etag:
        description: The entity tag associated with the resource.
        type: string
        readOnly: true
      payload:
        description: Custom allocation payload returned from the webhook to the device.
        type: object
        readOnly: true
parameters:
  ApiVersionParameter:
    name: api-version
    in: query
    description: 'The API version to use for the request. Supported versions include: 2021-10-01'
    required: true
    type: string
    default: '2021-10-01'
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'