swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector apiTokens API
schemes:
- https
tags:
- name: apiTokens
paths:
  /apiTokens:
    get:
      operationId: microsoftAzureApitokensList
      summary: Microsoft Azure Get The List Of Api Tokens In An Application The Token Value Will Never Be Returned For Security Reasons
      x-ms-examples:
        List API tokens:
          $ref: ./examples/apitoken_list.json
      parameters:
      - $ref: '#/parameters/Version'
      x-ms-pageable:
        nextLinkName: nextLink
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/ApiTokenCollection'
        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:
      - apiTokens
  /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: '#/parameters/Version'
      - in: path
        name: tokenId
        description: Unique ID for the API token.
        type: string
        required: true
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/ApiToken'
        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:
      - apiTokens
    put:
      operationId: microsoftAzureApitokensCreate
      summary: Microsoft Azure Create A New Api Token In The Application To Use In The Iot Central Public Api The Token Value Will Be Returned In The Response, And Won T Be Returned Again In Subsequent Requests
      x-ms-examples:
        Create API token:
          $ref: ./examples/apitoken_create.json
      parameters:
      - $ref: '#/parameters/Version'
      - in: path
        name: tokenId
        description: Unique ID for the API token.
        type: string
        required: true
      - in: body
        name: body
        description: API token body.
        schema:
          $ref: '#/definitions/ApiToken'
        required: true
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/ApiToken'
        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:
      - apiTokens
    delete:
      operationId: microsoftAzureApitokensRemove
      summary: Microsoft Azure Delete An Api Token
      x-ms-examples:
        Delete API token:
          $ref: ./examples/apitoken_delete.json
      parameters:
      - $ref: '#/parameters/Version'
      - in: path
        name: tokenId
        description: Unique ID for the API token.
        type: string
        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'
      description: Needs a more full description created.
      tags:
      - apiTokens
definitions:
  ApiToken:
    description: The access token definition.
    allOf:
    - $ref: '#/definitions/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
  ApiTokenCollection:
    description: The paged results of API tokens.
    type: object
    properties:
      value:
        description: The collection of API tokens.
        type: array
        items:
          $ref: '#/definitions/ApiToken'
      nextLink:
        description: URL to get the next page of API tokens.
        type: string
    required:
    - value
  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
  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: '#/definitions/RoleAssignment'
        minItems: 1
    required:
    - roles
  Error:
    description: The response error definition.
    type: object
    properties:
      error:
        description: Error details for current request.
        $ref: '#/definitions/ErrorDetails'
    required:
    - error
parameters:
  Version:
    in: query
    name: api-version
    description: The version of the API being called.
    x-ms-parameter-location: client
    type: string
    required: true
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'