openapi: 3.0.3
info:
  description: Provides a set of endpoints to manage Devices, Things, Properties and Timeseries
  title: Arduino IoT Cloud binaries_v2 users_v1 API
  version: '2.0'
tags:
- name: users_v1
paths:
  /iot/v1/users/byEmail/{email}:
    get:
      description: Verify if an email belongs to an Arduino Account
      operationId: users_v1#verifyEmail
      parameters:
      - description: The email you want to check
        in: path
        name: email
        required: true
        schema:
          format: email
          type: string
      responses:
        '200':
          content:
            application/vnd.arduino.user+json:
              schema:
                $ref: '#/components/schemas/ArduinoUser'
            application/vnd.goa.error+json:
              schema:
                $ref: '#/components/schemas/ArduinoUser'
          description: OK
        '401':
          content:
            application/vnd.arduino.user+json:
              schema:
                $ref: '#/components/schemas/error'
            application/vnd.goa.error+json:
              schema:
                $ref: '#/components/schemas/error'
          description: Unauthorized
        '404':
          description: Not Found
        '500':
          content:
            application/vnd.arduino.user+json:
              schema:
                $ref: '#/components/schemas/error'
            application/vnd.goa.error+json:
              schema:
                $ref: '#/components/schemas/error'
          description: Internal Server Error
      summary: verifyEmail users_v1
      tags:
      - users_v1
  /iot/v1/users/byId/{user_id}:
    get:
      description: Get user by ID
      operationId: users_v1#getByID
      parameters:
      - description: The uuid of the user you want to get
        in: path
        name: user_id
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/vnd.arduino.user+json:
              schema:
                $ref: '#/components/schemas/ArduinoUser'
            application/vnd.goa.error+json:
              schema:
                $ref: '#/components/schemas/ArduinoUser'
          description: OK
        '401':
          content:
            application/vnd.arduino.user+json:
              schema:
                $ref: '#/components/schemas/error'
            application/vnd.goa.error+json:
              schema:
                $ref: '#/components/schemas/error'
          description: Unauthorized
        '404':
          description: Not Found
        '500':
          content:
            application/vnd.arduino.user+json:
              schema:
                $ref: '#/components/schemas/error'
            application/vnd.goa.error+json:
              schema:
                $ref: '#/components/schemas/error'
          description: Internal Server Error
      summary: getByID users_v1
      tags:
      - users_v1
  /iot/v1/users/byUsername/{username}:
    get:
      description: Returns a list of users that matches the username provided
      operationId: users_v1#byUsername
      parameters:
      - description: The username of the user you want to retrieve
        in: path
        name: username
        required: true
        schema:
          minLength: 3
          type: string
      responses:
        '200':
          content:
            application/vnd.arduino.user+json:
              schema:
                $ref: '#/components/schemas/ArduinoUser'
            application/vnd.goa.error+json:
              schema:
                $ref: '#/components/schemas/ArduinoUser'
          description: OK
        '401':
          content:
            application/vnd.arduino.user+json:
              schema:
                $ref: '#/components/schemas/error'
            application/vnd.goa.error+json:
              schema:
                $ref: '#/components/schemas/error'
          description: Unauthorized
        '404':
          description: Not Found
        '500':
          content:
            application/vnd.arduino.user+json:
              schema:
                $ref: '#/components/schemas/error'
            application/vnd.goa.error+json:
              schema:
                $ref: '#/components/schemas/error'
          description: Internal Server Error
      summary: byUsername users_v1
      tags:
      - users_v1
components:
  schemas:
    error:
      description: Error response media type (default view)
      properties:
        code:
          description: an application-specific error code, expressed as a string value.
          example: invalid_value
          type: string
        detail:
          description: a human-readable explanation specific to this occurrence of the problem.
          example: Value of ID must be an integer
          type: string
        id:
          description: a unique identifier for this particular occurrence of the problem.
          example: 3F1FKVRR
          type: string
        meta:
          additionalProperties: true
          description: a meta object containing non-standard meta-information about the error.
          example:
            timestamp: 1458609066
          type: object
        status:
          description: the HTTP status code applicable to this problem, expressed as a string value.
          example: '400'
          type: string
      title: 'Mediatype identifier: application/vnd.goa.error+json; view=default'
      type: object
    ArduinoUser:
      description: ArduinoUser media type (default view)
      properties:
        id:
          description: The ID of the user
          format: uuid
          type: string
        username:
          description: The username of the user
          type: string
      required:
      - id
      - username
      title: 'Mediatype identifier: application/vnd.arduino.user+json; view=default'
      type: object
externalDocs:
  description: See docs on Confluence
  url: https://arduino.atlassian.net/wiki/spaces/FTWEB/pages/91160610/Arduino+IoT+Cloud