openapi: 3.2.0
info:
  title: Microsoft Azure Azure IoT Central API Tokens API
  description: Azure IoT Central is a service that makes it easy to connect, monitor, and manage your IoT devices at scale.
  version: 2022-10-31-preview
servers:
- url: /api
security:
- azure_auth:
  - user_impersonation
tags:
- name: API Tokens
paths:
  /apiTokens:
    get:
      operationId: microsoftAzureApitokensList
      summary: Microsoft Azure Get The List Of Api Tokens In An Application The Token Value…
      x-ms-examples:
        List API tokens:
          $ref: ./examples/apitoken_list.json
      parameters:
      - $ref: '#/components/parameters/Version'
      x-ms-pageable:
        nextLinkName: nextLink
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiTokenCollection'
        default:
          description: An error response received from the IoT Central Service.
          headers:
            x-ms-error-code:
              description: Error code for specific error that occurred.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      description: Needs a more full description created.
      tags:
      - API Tokens
  /apiTokens/{tokenId}:
    get:
      operationId: microsoftAzureApitokensGet
      summary: Microsoft Azure Get An Api Token By Id
      x-ms-examples:
        Get API token by ID:
          $ref: ./examples/apitoken_get.json
      parameters:
      - $ref: '#/components/parameters/Version'
      - in: path
        name: tokenId
        description: Unique ID for the API token.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiToken'
        default:
          description: An error response received from the IoT Central Service.
          headers:
            x-ms-error-code:
              description: Error code for specific error that occurred.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      description: Needs a more full description created.
      tags:
      - API Tokens
    put:
      operationId: microsoftAzureApitokensCreate
      summary: Microsoft Azure Create A New Api Token In The Application To Use In The Iot…
      x-ms-examples:
        Create API token:
          $ref: ./examples/apitoken_create.json
      parameters:
      - $ref: '#/components/parameters/Version'
      - in: path
        name: tokenId
        description: Unique ID for the API token.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiToken'
        default:
          description: An error response received from the IoT Central Service.
          headers:
            x-ms-error-code:
              description: Error code for specific error that occurred.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      description: Needs a more full description created.
      tags:
      - API Tokens
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ApiToken'
        description: API token body.
        required: true
    delete:
      operationId: microsoftAzureApitokensRemove
      summary: Microsoft Azure Delete An Api Token
      x-ms-examples:
        Delete API token:
          $ref: ./examples/apitoken_delete.json
      parameters:
      - $ref: '#/components/parameters/Version'
      - in: path
        name: tokenId
        description: Unique ID for the API token.
        required: true
        schema:
          type: string
      responses:
        '204':
          description: Success
        default:
          description: An error response received from the IoT Central Service.
          headers:
            x-ms-error-code:
              description: Error code for specific error that occurred.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      description: Needs a more full description created.
      tags:
      - API Tokens
components:
  schemas:
    ApiToken:
      description: The access token definition.
      allOf:
      - $ref: '#/components/schemas/Permission'
      type: object
      properties:
        id:
          description: Unique ID of the API token.
          type: string
          readOnly: true
        token:
          description: Value of the API token.
          type: string
          readOnly: true
        expiry:
          description: String-formatted date representing the time when the token expires.
          type: string
          format: date-time
    RoleAssignment:
      description: The role assignment definition.
      type: object
      properties:
        role:
          description: ID of the role for this role assignment.
          type: string
        organization:
          description: ID of the organization for this role assignment.
          type: string
      required:
      - role
    Error:
      description: The response error definition.
      type: object
      properties:
        error:
          description: Error details for current request.
          $ref: '#/components/schemas/ErrorDetails'
      required:
      - error
    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
    ApiTokenCollection:
      description: The paged results of API tokens.
      type: object
      properties:
        value:
          description: The collection of API tokens.
          type: array
          items:
            $ref: '#/components/schemas/ApiToken'
        nextLink:
          description: URL to get the next page of API tokens.
          type: string
      required:
      - value
    Permission:
      description: The permission definition.
      type: object
      properties:
        roles:
          description: List of role assignments that specify the permissions to access the application.
          type: array
          items:
            $ref: '#/components/schemas/RoleAssignment'
          minItems: 1
      required:
      - roles
  parameters:
    Version:
      in: query
      name: api-version
      description: The version of the API being called.
      x-ms-parameter-location: client
      required: true
      schema:
        type: string
  securitySchemes:
    azure_auth:
      type: oauth2
      flows:
        implicit:
          scopes:
            user_impersonation: impersonate your user account
          authorizationUrl: https://login.microsoftonline.com/common/oauth2/authorize
      description: Azure Active Directory OAuth2 Flow
x-ms-parameterized-host:
  hostTemplate: '{subdomain}.{baseDomain}'
  parameters:
  - $ref: '#/components/parameters/BaseDomain'
  - $ref: '#/components/parameters/Subdomain'