Microsoft Azure EnrollmentGroup API

The EnrollmentGroup API from Microsoft Azure — 4 operation(s) for enrollmentgroup.

Documentation GitHub OpenAPI

Operations 6

GET /enrollmentGroups/{id} Microsoft Azure Get A Device Enrollment Group #

PUT /enrollmentGroups/{id} Microsoft Azure Create Or Update A Device Enrollment Group #

DELETE /enrollmentGroups/{id} Microsoft Azure Delete A Device Enrollment Group #

POST /enrollmentGroups/query Microsoft Azure Query The Device Enrollment Groups #

POST /enrollmentGroups/{id}/attestationmechanism Microsoft Azure Get The Attestation Mechanism In The Device Enrollment Group Record #

POST /enrollmentGroups Microsoft Azure Bulk Device Enrollment Group Operation With Maximum Of 10 Groups #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this

find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/microsoft-azure-enrollmentgroup-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector Enrollment Group API
tags:
- name: EnrollmentGroup
paths:
  /enrollmentGroups/{id}:
    get:
      tags:
      - EnrollmentGroup
      summary: Microsoft Azure Get A Device Enrollment Group
      operationId: microsoftAzureEnrollmentgroupGet
      parameters:
      - name: id
        in: path
        description: Enrollment group ID.
        required: true
        schema:
          type: string
      - $ref: '#/components/parameters/ApiVersionParameter'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EnrollmentGroup'
        default:
          description: Error response
          headers:
            x-ms-error-code:
              description: The error code for specific error that occurred.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProvisioningServiceErrorDetails'
      description: Needs a more full description created.
    put:
      tags:
      - EnrollmentGroup
      summary: Microsoft Azure Create Or Update A Device Enrollment Group
      operationId: microsoftAzureEnrollmentgroupCreateorupdate
      parameters:
      - name: id
        in: path
        description: Enrollment group ID.
        required: true
        schema:
          type: string
      - name: If-Match
        in: header
        description: The ETag of the enrollment record.
        required: false
        schema:
          type: string
      - $ref: '#/components/parameters/ApiVersionParameter'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EnrollmentGroup'
        default:
          description: Error response
          headers:
            x-ms-error-code:
              description: The error code for specific error that occurred.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProvisioningServiceErrorDetails'
      description: Needs a more full description created.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EnrollmentGroup'
        description: The device enrollment group.
        required: true
    delete:
      tags:
      - EnrollmentGroup
      summary: Microsoft Azure Delete A Device Enrollment Group
      operationId: microsoftAzureEnrollmentgroupDelete
      parameters:
      - name: id
        in: path
        description: Enrollment group ID.
        required: true
        schema:
          type: string
      - name: If-Match
        in: header
        description: The ETag of the enrollment group record.
        required: false
        schema:
          type: string
      - $ref: '#/components/parameters/ApiVersionParameter'
      responses:
        '204':
          description: Success
        default:
          description: Error response
          headers:
            x-ms-error-code:
              description: The error code for specific error that occurred.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProvisioningServiceErrorDetails'
      description: Needs a more full description created.
  /enrollmentGroups/query:
    post:
      tags:
      - EnrollmentGroup
      summary: Microsoft Azure Query The Device Enrollment Groups
      operationId: microsoftAzureEnrollmentgroupQuery
      parameters:
      - name: x-ms-max-item-count
        in: header
        description: Page size
        required: false
        schema:
          type: integer
          format: int32
      - name: x-ms-continuation
        in: header
        description: Continuation token
        required: false
        schema:
          type: string
      - $ref: '#/components/parameters/ApiVersionParameter'
      responses:
        '200':
          description: Success
          headers:
            x-ms-continuation:
              description: The continuation token for getting the next page of results.
              schema:
                type: string
            x-ms-max-item-count:
              description: The maximum number of items returned in a page.
              schema:
                type: integer
            x-ms-item-type:
              description: The list of values returned from the query.
              schema:
                type: string
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/EnrollmentGroup'
        default:
          description: Error response
          headers:
            x-ms-error-code:
              description: The error code for specific error that occurred.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProvisioningServiceErrorDetails'
      description: Needs a more full description created.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/QuerySpecification'
        description: The query specification.
        required: true
  /enrollmentGroups/{id}/attestationmechanism:
    post:
      tags:
      - EnrollmentGroup
      summary: Microsoft Azure Get The Attestation Mechanism In The Device Enrollment Group Record
      operationId: microsoftAzureEnrollmentgroupGetattestationmechanism
      parameters:
      - name: id
        in: path
        description: Enrollment group ID
        required: true
        schema:
          type: string
      - $ref: '#/components/parameters/ApiVersionParameter'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AttestationMechanism'
        default:
          description: Error response
          headers:
            x-ms-error-code:
              description: The error code for specific error that occurred.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProvisioningServiceErrorDetails'
      description: Needs a more full description created.
  /enrollmentGroups:
    post:
      tags:
      - EnrollmentGroup
      summary: Microsoft Azure Bulk Device Enrollment Group Operation With Maximum Of 10 Groups
      operationId: microsoftAzureEnrollmentgroupRunbulkoperation
      parameters:
      - $ref: '#/components/parameters/ApiVersionParameter'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BulkEnrollmentGroupOperationResult'
        default:
          description: Error response
          headers:
            x-ms-error-code:
              description: The error code for specific error that occurred.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProvisioningServiceErrorDetails'
      description: Needs a more full description created.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BulkEnrollmentGroupOperation'
        description: Bulk operation.
        required: true
components:
  schemas:
    CustomAllocationDefinition:
      description: This tells DPS which webhook to call when using custom allocation.
      required:
      - webhookUrl
      - apiVersion
      type: object
      properties:
        webhookUrl:
          description: The webhook URL used for allocation requests.
          type: string
        apiVersion:
          description: 'The API version of the provisioning service types (such as IndividualEnrollment) sent in the custom allocation request. Minimum supported version: "2018-09-01-preview".'
          type: string
    ReprovisionPolicy:
      description: The behavior of the service when a device is re-provisioned to an IoT hub.
      required:
      - updateHubAssignment
      - migrateDeviceData
      type: object
      properties:
        updateHubAssignment:
          description: When set to true (default), the Device Provisioning Service will evaluate the device's IoT Hub assignment and update it if necessary for any provisioning requests beyond the first from a given device. If set to false, the device will stay assigned to its current IoT hub.
          default: true
          type: boolean
        migrateDeviceData:
          description: When set to true (default), the Device Provisioning Service will migrate the device's data (twin, device capabilities, and device ID) from one IoT hub to another during an IoT hub assignment update. If set to false, the Device Provisioning Service will reset the device's data to the initial desired configuration stored in the corresponding enrollment list.
          default: true
          type: boolean
    Metadata:
      description: Metadata for the TwinCollection
      type: object
      properties:
        lastUpdated:
          format: date-time
          description: Last time the TwinCollection was updated
          type: string
        lastUpdatedVersion:
          format: int64
          description: This is null for reported properties metadata and is not null for desired properties metadata.
          type: integer
    BulkEnrollmentGroupOperation:
      description: Bulk enrollment operation.
      required:
      - enrollmentGroups
      - mode
      type: object
      properties:
        enrollmentGroups:
          description: Enrollment items
          type: array
          items:
            $ref: '#/components/schemas/EnrollmentGroup'
        mode:
          description: Operation mode.
          enum:
          - create
          - update
          - updateIfMatchETag
          - delete
          type: string
    BulkEnrollmentGroupOperationResult:
      description: Results of a bulk enrollment group operation.
      required:
      - isSuccessful
      type: object
      properties:
        errors:
          description: Registration errors
          type: array
          items:
            $ref: '#/components/schemas/BulkEnrollmentGroupOperationError'
        isSuccessful:
          description: Indicates if the operation was successful in its entirety.
          type: boolean
    BulkEnrollmentGroupOperationError:
      description: Bulk enrollment operation error.
      required:
      - enrollmentGroupId
      - errorCode
      - errorStatus
      type: object
      properties:
        enrollmentGroupId:
          description: Enrollment group id.
          type: string
        errorCode:
          format: int32
          description: Error code
          type: integer
        errorStatus:
          description: Error status.
          type: string
    TwinCollection:
      description: Represents a collection of properties within a Twin
      type: object
      properties:
        version:
          format: int64
          description: Version of the TwinCollection
          type: integer
        count:
          description: Number of properties in the TwinCollection
          type: integer
        metadata:
          $ref: '#/components/schemas/Metadata'
          description: Metadata for the TwinCollection
      additionalProperties:
        type: object
    X509Attestation:
      description: Attestation via X509.
      type: object
      properties:
        clientCertificates:
          $ref: '#/components/schemas/X509Certificates'
        signingCertificates:
          $ref: '#/components/schemas/X509Certificates'
        caReferences:
          $ref: '#/components/schemas/X509CAReferences'
    EnrollmentGroup:
      description: Enrollment group record.
      required:
      - enrollmentGroupId
      - attestation
      type: object
      properties:
        enrollmentGroupId:
          description: Enrollment Group ID.
          type: string
        attestation:
          $ref: '#/components/schemas/AttestationMechanism'
          description: Attestation method used by the device.
        capabilities:
          $ref: '#/components/schemas/DeviceCapabilities'
          description: Capabilities of the device.
        iotHubHostName:
          description: The Iot Hub host name.
          type: string
        initialTwin:
          $ref: '#/components/schemas/InitialTwin'
          description: Initial device twin.
        etag:
          description: The entity tag associated with the resource.
          type: string
        provisioningStatus:
          description: The provisioning status.
          default: enabled
          enum:
          - enabled
          - disabled
          type: string
        reprovisionPolicy:
          $ref: '#/components/schemas/ReprovisionPolicy'
          description: The behavior when a device is re-provisioned to an IoT hub.
        createdDateTimeUtc:
          format: date-time
          description: The DateTime this resource was created.
          type: string
          readOnly: true
        lastUpdatedDateTimeUtc:
          format: date-time
          description: The DateTime this resource was last updated.
          type: string
          readOnly: true
        allocationPolicy:
          description: 'The allocation policy of this resource. This policy overrides the tenant level allocation policy for this individual enrollment or enrollment group. Possible values include ''hashed'': Linked IoT hubs are equally likely to have devices provisioned to them, ''geoLatency'':  Devices are provisioned to an IoT hub with the lowest latency to the device.If multiple linked IoT hubs would provide the same lowest latency, the provisioning service hashes devices across those hubs, ''static'' : Specification of the desired IoT hub in the enrollment list takes priority over the service-level allocation policy, ''custom'': Devices are provisioned to an IoT hub based on your own custom logic. The provisioning service passes information about the device to the logic, and the logic returns the desired IoT hub as well as the desired initial configuration. We recommend using Azure Functions to host your logic.'
          enum:
          - hashed
          - geoLatency
          - static
          - custom
          type: string
        iotHubs:
          description: The list of IoT Hub hostnames the device(s) in this resource can be allocated to. Must be a subset of tenant level list of IoT hubs.
          type: array
          items:
            type: string
        customAllocationDefinition:
          $ref: '#/components/schemas/CustomAllocationDefinition'
          description: This tells DPS which webhook to call when using custom allocation.
    X509Certificates:
      description: Primary and secondary certificates
      type: object
      properties:
        primary:
          $ref: '#/components/schemas/X509CertificateWithInfo'
        secondary:
          $ref: '#/components/schemas/X509CertificateWithInfo'
    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
    X509CertificateInfo:
      description: X509 certificate info.
      required:
      - subjectName
      - sha1Thumbprint
      - sha256Thumbprint
      - issuerName
      - notBeforeUtc
      - notAfterUtc
      - serialNumber
      - version
      type: object
      properties:
        subjectName:
          type: string
        sha1Thumbprint:
          type: string
        sha256Thumbprint:
          type: string
        issuerName:
          type: string
        notBeforeUtc:
          format: date-time
          type: string
        notAfterUtc:
          format: date-time
          type: string
        serialNumber:
          type: string
        version:
          format: int32
          type: integer
    TpmAttestation:
      description: Attestation via TPM.
      required:
      - endorsementKey
      type: object
      properties:
        endorsementKey:
          type: string
        storageRootKey:
          type: string
    InitialTwin:
      description: Initial device twin. Contains a subset of the properties of Twin.
      type: object
      properties:
        tags:
          $ref: '#/components/schemas/TwinCollection'
          description: Twin tags.
        properties:
          $ref: '#/components/schemas/InitialTwinProperties'
          description: Twin desired properties.
    QuerySpecification:
      required:
      - query
      type: object
      properties:
        query:
          type: string
    SymmetricKeyAttestation:
      description: Attestation via SymmetricKey.
      type: object
      properties:
        primaryKey:
          description: Primary symmetric key.
          type: string
        secondaryKey:
          description: Secondary symmetric key.
          type: string
    InitialTwinProperties:
      description: Represents the initial properties that will be set on the device twin.
      type: object
      properties:
        desired:
          $ref: '#/components/schemas/TwinCollection'
          description: Gets and sets the InitialTwin desired properties.
    AttestationMechanism:
      description: Attestation mechanism for individualEnrollment as well as enrollmentGroup.
      required:
      - type
      type: object
      properties:
        type:
          description: Attestation Type.
          enum:
          - none
          - tpm
          - x509
          - symmetricKey
          type: string
        tpm:
          $ref: '#/components/schemas/TpmAttestation'
          description: TPM attestation method.
        x509:
          $ref: '#/components/schemas/X509Attestation'
          description: X509 attestation method.
        symmetricKey:
          $ref: '#/components/schemas/SymmetricKeyAttestation'
          description: Symmetric Key attestation method.
    X509CAReferences:
      description: Primary and secondary CA references.
      type: object
      properties:
        primary:
          type: string
        secondary:
          type: string
    X509CertificateWithInfo:
      description: Certificate and Certificate info
      type: object
      properties:
        certificate:
          type: string
        info:
          $ref: '#/components/schemas/X509CertificateInfo'
    DeviceCapabilities:
      description: Device capabilities.
      required:
      - iotEdge
      type: object
      properties:
        iotEdge:
          description: If set to true, this device is an IoTEdge device.
          default: false
          type: boolean
  parameters:
    ApiVersionParameter:
      name: api-version
      in: query
      description: 'The API version to use for the request. Supported versions include: 2021-10-01'
      required: true
      schema:
        type: string
        default: '2021-10-01'
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/components/parameters/Endpoint'