Ayla Networks Token Sign In.json API

openapi: 3.2.0
info:
  title: user-service Token Sign In.json API
  version: '1.0'
servers:
- url: https://user-dev.aylanetworks.com/
security:
- sec0: []
tags:
- name: Token Sign In.json
paths:
  /api/v1/token_sign_in.json:
    post:
      summary: SSO sign in
      description: 'This API is called by the app to log into the Ayla service with the Identity Provider-issued access token.

        Specify the token issued by the identity provider in the ```token``` field.

        Upon successful SSO sign in, continue to validate token.'
      operationId: login
      requestBody:
        content:
          application/json:
            schema:
              type: object
              required:
              - app_id
              - app_secret
              - token
              properties:
                app_id:
                  type: string
                  description: Unique application identifier of the app to which identity provider belongs.
                app_secret:
                  type: string
                  description: Application secret of the app to which identity provider belongs.
                token:
                  type: string
                  description: Unique token of identity provider’s user.
      responses:
        '200':
          description: Ok
          content:
            application/json:
              examples:
                Result:
                  value: "{\n  \"access_token\":\"aea5f45e3bfb45fa8715b6bc2e1039dc\",\n  \"refresh_token\":\"192fd8792ae14fcfa1dec3940b57dd00\",\n  \"expires_in\":86400,\n  \"role\":\"EndUser\"\n}\n"
              schema:
                type: object
                properties:
                  access_token:
                    type: string
                    example: aea5f45e3bfb45fa8715b6bc2e1039dc
                  refresh_token:
                    type: string
                    example: 192fd8792ae14fcfa1dec3940b57dd00
                  expires_in:
                    type: integer
                    example: 86400
                    default: 0
                  role:
                    type: string
                    example: EndUser
        '401':
          content: {}
          description: Unauthorized
        '404':
          content: {}
          description: Not Found
        '422':
          content: {}
          description: Unprocessable Entity
      deprecated: false
      tags:
      - Token Sign In.json
components:
  securitySchemes:
    sec0:
      type: apiKey
      in: header
      name: Authorization
      x-default: auth_token
x-readme-fauxas: true
x-provenance:
  method: searched
  source: https://docs.aylanetworks.com/reference
  harvested: '2026-10-14'
  tool: harvest-readme-openapi.py
  note: Assembled verbatim from the OpenAPI definition ReadMe embeds in each operation page of the provider's developer portal; paths and components merged by API title, nothing authored.
  assembled_from:
  - https://docs.aylanetworks.com/reference/assign-label.md
  - https://docs.aylanetworks.com/reference/assign-role.md
  - https://docs.aylanetworks.com/reference/associate-role-user.md
  - https://docs.aylanetworks.com/reference/configure-properties-based-on-role.md
  - https://docs.aylanetworks.com/reference/confirm-user-account.md
  - https://docs.aylanetworks.com/reference/create-associated-user.md
  - https://docs.aylanetworks.com/reference/create-contact.md
  - https://docs.aylanetworks.com/reference/create-dealer.md
  - https://docs.aylanetworks.com/reference/create-firebase-configuration.md
  - https://docs.aylanetworks.com/reference/create-role-user.md
  - https://docs.aylanetworks.com/reference/create-role.md
  - https://docs.aylanetworks.com/reference/create-share.md
  - https://docs.aylanetworks.com/reference/create-user-account.md
  - https://docs.aylanetworks.com/reference/create-user-contact.md
  - https://docs.aylanetworks.com/reference/create-user-metadatum.md
  - https://docs.aylanetworks.com/reference/delete-contact.md
  - https://docs.aylanetworks.com/reference/delete-firebase-configuration.md
  - https://docs.aylanetworks.com/reference/delete-properties-by-roles.md
  - https://docs.aylanetworks.com/reference/delete-share-by-user-id.md
  - https://docs.aylanetworks.com/reference/delete-share.md
  - https://docs.aylanetworks.com/reference/delete-user-account-1.md
  - https://docs.aylanetworks.com/reference/delete-user-account.md
  - https://docs.aylanetworks.com/reference/delete-user-contact.md
  - https://docs.aylanetworks.com/reference/delete-user-metadatum.md
  - https://docs.aylanetworks.com/reference/disassociate-role-user.md
  - https://docs.aylanetworks.com/reference/disassociate-user.md
  - https://docs.aylanetworks.com/reference/edit-property-permissions.md
  - https://docs.aylanetworks.com/reference/get-clients.md
  - https://docs.aylanetworks.com/reference/get-contact-details.md
  - https://docs.aylanetworks.com/reference/get-contacts.md
  - https://docs.aylanetworks.com/reference/get-end-users.md
  - https://docs.aylanetworks.com/reference/get-oem-users.md
  - https://docs.aylanetworks.com/reference/get-oem.md
  - https://docs.aylanetworks.com/reference/get-oems.md
  - https://docs.aylanetworks.com/reference/get-properties-by-oem-model-and-role.md
  - https://docs.aylanetworks.com/reference/get-received-shares.md
  - https://docs.aylanetworks.com/reference/get-role-users.md
  - https://docs.aylanetworks.com/reference/get-share.md
  - https://docs.aylanetworks.com/reference/get-shares.md
  - https://docs.aylanetworks.com/reference/get-tokens.md
  - https://docs.aylanetworks.com/reference/get-user-by-id.md
  - https://docs.aylanetworks.com/reference/get-user-by-universal-user-id.md
  - https://docs.aylanetworks.com/reference/get-user-contacts.md
  - https://docs.aylanetworks.com/reference/get-user-metadata.md
  - https://docs.aylanetworks.com/reference/get-user-metadatum.md
  - https://docs.aylanetworks.com/reference/get-user-profile-1.md
  - https://docs.aylanetworks.com/reference/get-users-by-label.md
  - https://docs.aylanetworks.com/reference/get-users-by-oem.md
  - https://docs.aylanetworks.com/reference/get-users-by-role.md
  - https://docs.aylanetworks.com/reference/login.md
  - https://docs.aylanetworks.com/reference/refresh-token.md
  - https://docs.aylanetworks.com/reference/reset-password.md
  - https://docs.aylanetworks.com/reference/return-tokens.md
  - https://docs.aylanetworks.com/reference/revoke-label.md
  - https://docs.aylanetworks.com/reference/revoke-role.md
  - https://docs.aylanetworks.com/reference/send-how-to-confirm.md
  - https://docs.aylanetworks.com/reference/send-how-to-reset.md
  - https://docs.aylanetworks.com/reference/update-contact.md
  - https://docs.aylanetworks.com/reference/update-email.md
  - https://docs.aylanetworks.com/reference/update-firebase-configuration-1.md
  - https://docs.aylanetworks.com/reference/update-firebase-configuration.md
  - https://docs.aylanetworks.com/reference/update-share.md
  - https://docs.aylanetworks.com/reference/update-sso-user.md
  - https://docs.aylanetworks.com/reference/update-user-account-1.md
  - https://docs.aylanetworks.com/reference/update-user-contact.md
  - https://docs.aylanetworks.com/reference/update-user-metadatum.md
  merge:
    pages: 66
    deduped: 65
    conflicts_kept_first: 0