Yoxel User API

openapi: 3.2.0
info:
  contact:
    email: support@aurinko.io
  description: '## Introduction

    The Aurinko API is a unified API platform allowing developers to quickly build integrations with

    many mailbox providers and services like Google, Office 365, Outlook.com, MS Exchange, IMAP.

    The unified API abstracts away differences between many email, calendar, contact, task APIs

    to make it easy to connect and sync the mailbox data.


    The Aurinko API''s focus is convenient and reliable data synchronization for all supported

    data categories (email, calendar, contacts, tasks) so the API provides methods to receive changes/deltas

    and be notified of the changes (through webhooks) in a unified manner. The API''s sync/deltas model

    should allow developers to build reliable event based solutions easily.


    The Aurinko API is built on HTTP. Our API is RESTful. It has predictable resource URLs.

    It returns HTTP response codes to indicate errors. It also accepts and returns JSON in the HTTP body.


    ## API Authentication

    When you sign up for an account, you are given a Client Id and Secret

    for every application that you create. You use those to go through OAuth flows that allow you

    to start syncing remote account data through Aurinko. An account OAuth flow can be started with

    just the Client Id and the Client Secret will be required to obtain an account access token in the

    "authorization code" flow ("implicit grant" flow does is secured by the "trusted domains" setting).


    Aurinko offers two forms of authentication:


    - `Basic ` - used for authentication flows and administrative requests made from the server side.

    - `Bearer ` - used for working with an account data.

    - `Api Key in Cookie` - for in-browser apps that use Aurinko as their backend API with user sessions.

    - `Api Key in Header (X-Aurinko-Session)` - for server side apps that need user sessions


    Never share your client secret or access token. Keep them guarded and secure.


    ## Getting Started Guide

    If you have a use case you would like to implement, please consult us for feedback on the best API operations for the task.


    Click here to visit our API Guides.'
  termsOfService: https://www.aurinko.io/terms-of-service/
  title: Aurinko.io User API
  version: 1.0.0
servers:
- url: https://api.aurinko.io
  description: Production server
security:
- AccountToken: []
- AppAuth: []
  AccountIdHeader: []
- UserSessionHeader: []
  AccountIdHeader: []
- UserSessionCookie: []
  ClientIdHeader: []
  AccountIdHeader: []
- AuthTypeHeader: []
  ExchangeIdToken: []
  ClientIdHeader: []
  AccountIdHeader: []
tags:
- name: User
  x-displayName: User sessions
  description: '`User` is an Aurinko managed entity that your app can leverage to implement user session management. Multiple regular Aurinko accounts can be linked to a `User` however there is always one primary account that acts as the user id-provider. The `User` sessions allow browser apps to store all their account access tokens securely on the Aurinko servers.'
paths:
  /v1/user:
    get:
      operationId: getUserInfo
      tags:
      - User
      summary: Get user info
      security:
      - UserSessionCookie: []
      - ClientIdHeader: []
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EndUserDto'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
      x-codeSamples:
      - lang: cURL
        source: "curl -X GET --cookie \"<END_USER_COOKIE>\" \\\n    -H 'X-Aurinko-ClientId: <CLIENT_ID>' \\\n    https://api.aurinko.io/v1/user"
  /v1/user/settings:
    patch:
      operationId: updateSettings
      tags:
      - User
      summary: Change user settings
      security:
      - UserSessionCookie: []
      - ClientIdHeader: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EndUserSettingsDto'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EndUserDto'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
      x-codeSamples:
      - lang: cURL
        source: "curl -X POST --cookie \"<END_USER_COOKIE>\" \\\n    -H 'X-Aurinko-ClientId: <CLIENT_ID>' \\\n    https://api.aurinko.io/v1/user/settings"
  /v1/user/accounts:
    get:
      operationId: getEndUserAccounts
      tags:
      - User
      summary: Get user accounts
      security:
      - UserSessionCookie: []
      - ClientIdHeader: []
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EndUserAccountsPage'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
      x-codeSamples:
      - lang: cURL
        source: "curl -X GET --cookie \"<END_USER_COOKIE>\" \\\n    -H 'X-Aurinko-ClientId: <CLIENT_ID>' \\\n    https://api.aurinko.io/v1/user/accounts"
  /v1/user/accounts/{id}:
    get:
      operationId: getEndUserAccount
      tags:
      - User
      summary: Get user account by id
      security:
      - UserSessionCookie: []
      - ClientIdHeader: []
      parameters:
      - schema:
          format: int64
          type: integer
        in: path
        name: id
        description: user's account Id
        required: true
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EndUserAccountDto'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
      x-codeSamples:
      - lang: cURL
        source: "curl -X GET --cookie \"<END_USER_COOKIE>\" \\\n    -H 'X-Aurinko-ClientId: <CLIENT_ID>' \\\n    https://api.aurinko.io/v1/user/accounts/<id>"
    delete:
      operationId: logoutAccount
      tags:
      - User
      summary: Delete a user account
      description: Deleting a primary account, also invalidates the user's session cookie (logout).
      security:
      - UserSessionCookie: []
      - ClientIdHeader: []
      parameters:
      - schema:
          format: int64
          type: integer
        in: path
        name: id
        description: user's account Id
        required: true
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OkResponse'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
      x-codeSamples:
      - lang: cURL
        source: "curl -X DELETE --cookie \"<END_USER_COOKIE>\" \\\n    -H 'X-Aurinko-ClientId: <CLIENT_ID>' \\\n    https://api.aurinko.io/v1/user/accounts/<id>"
  /v1/user/accounts/{id}/managed:
    post:
      operationId: copyAsManaged
      tags:
      - User
      summary: Make a user account 'managed'
      security:
      - UserSessionCookie: []
      - ClientIdHeader: []
      parameters:
      - schema:
          format: int64
          type: integer
        in: path
        name: id
        description: user's account Id
        required: true
      - schema:
          type:
          - string
          - 'null'
        in: query
        name: clientOrgId
        required: false
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EndUserAccountDto'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
      x-codeSamples:
      - lang: cURL
        source: "curl -X POST --cookie \"<END_USER_COOKIE>\" \\\n    -H 'X-Aurinko-ClientId: <CLIENT_ID>' \\\n    https://api.aurinko.io/v1/user/accounts/<id>/managed"
  /v1/user/logout:
    post:
      operationId: logout
      tags:
      - User
      summary: Log out a user
      description: Invalidates the user's session cookie
      security:
      - UserSessionCookie: []
      - ClientIdHeader: []
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OkResponse'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
      x-codeSamples:
      - lang: cURL
        source: "curl -X POST --cookie \"<END_USER_COOKIE>\" \\\n    -H 'X-Aurinko-ClientId: <CLIENT_ID>' \\\n    https://api.aurinko.io/v1/user/logout"
components:
  schemas:
    AccountType:
      type: string
      enum:
      - daemon
      - personal
      - managed
    TokenStatus:
      type: string
      enum:
      - active
      - invalid
      - dead
      description: "* active - means the token is active and ready for use\n* invalid - means that Aurinko failed to access provider API with authentication data.\n   Basically it indicates that Aurinko has received a 401 http status from provider and marked this token as non-active.\n* dead - this is a special variant of \"invalid\" status that can occur only with OAuth 2.0 accounts.\n   It means that Aurinko failed to refresh OAuth access token and received \"invalid_grant\" error which indicates\n   that the access/refresh tokens pair cannot be used anymore and is basically dead.\n   The difference between invalid and dead is that with invalid tokens Aurinko will still try to\n   access provider API and with dead Aurinko won't even attempt:\n   trying to use dead token, Aurinko will just return 401 without making calls to the provider.\n"
    EndUserAccountsPage:
      type: object
      properties:
        nextPageToken:
          type: string
        length:
          type: integer
        records:
          type: array
          items:
            $ref: '#/components/schemas/EndUserAccountDto'
    Scope:
      type: string
      enum:
      - Calendar.Read
      - Calendar.ReadWrite
      - Mail.Read
      - Mail.ReadWrite
      - Mail.Send
      - Mail.Drafts
      - Mail.All
      - Contacts.Read
      - Contacts.ReadWrite
      - Tasks.Read
      - Tasks.ReadWrite
      description: Space separated list of scopes
    DayOfWeek:
      type: string
      enum:
      - monday
      - tuesday
      - wednesday
      - thursday
      - friday
      - saturday
      - sunday
    OkResponse:
      type: object
      properties:
        status:
          type: string
          enum:
          - Ok
    ServiceType:
      type: string
      enum:
      - Google
      - GoogleBot
      - Office365
      - EWS
      - IMAP
      - Salesforce
      - Salesflare
      - Repfabric
      - MsTeamsBot
      - Slack
      - SlackBot
      - SugarCRM
      - HighLevel
      - Hubspot
      - Zoom
      - ZoomBot
      - Webex
      - WebexBot
      - Pipedrive
      - EclipseERP
      - AutoQuotes
      - Teamwork
      - NetSuite
      - MCTrade
      - SpecPath
      - Zoho
      - Clientify
      - QuickBooks
      - ActiveCampaign
      - Creatio
      - ConstantContact
      - Fishbowl
      - iCloud
    WeekWorkSchedule:
      type: object
      properties:
        daySchedules:
          type: array
          items:
            $ref: '#/components/schemas/DayWorkSchedule'
        timezone:
          type: string
    EndUserAccountDto:
      type: object
      properties:
        id:
          type: integer
          format: int64
        parentId:
          type: integer
          format: int64
        serviceType:
          $ref: '#/components/schemas/ServiceType'
        userAccountType:
          $ref: '#/components/schemas/UserAccountType'
        type:
          $ref: '#/components/schemas/AccountType'
        active:
          type: boolean
          description: The account is always active in the current API version
        loginString:
          type: string
        email:
          type: string
        name:
          type: string
        serverUrl:
          type: string
        serverUrl2:
          type: string
        clientOrgId:
          type: string
        authUserId:
          type: string
        authOrgId:
          type: string
        timezone:
          type: string
        authObtainedAt:
          type: string
          format: date-time
        organization:
          $ref: '#/components/schemas/OrganizationDto'
        tokenStatus:
          $ref: '#/components/schemas/TokenStatus'
        scopes:
          type: array
          items:
            $ref: '#/components/schemas/Scope'
        authScopes:
          type: array
          items:
            $ref: '#/components/schemas/Scope'
        nativeScopes:
          type: array
          items:
            $ref: '#/components/schemas/NativeScope'
        authNativeScopes:
          type: array
          items:
            $ref: '#/components/schemas/NativeScope'
        hasApiErrors:
          type: boolean
        bookingCount:
          type: integer
        trackingActive:
          type: boolean
        templatesCount:
          type: integer
    EndUserSettingsDto:
      type: object
      properties:
        workHours:
          $ref: '#/components/schemas/WeekWorkSchedule'
    DayWorkSchedule:
      type: object
      properties:
        dayOfWeek:
          $ref: '#/components/schemas/DayOfWeek'
        workingIntervals:
          type: array
          items:
            $ref: '#/components/schemas/WorkingInterval'
    WorkingInterval:
      type: object
      properties:
        start:
          type: string
          pattern: ^\d{2}:\d{2}:\d{2}$
          example: 09:00:00
        end:
          type: string
          pattern: ^\d{2}:\d{2}:\d{2}$
          example: '17:00:00'
    ServiceProvider:
      type: string
      enum:
      - Office365
      - Google
      - Zoho
      - IMAP
      - EWS
      - Yahoo
      - AOL
      - iCloud
      - BigPond
      - Fastmail
      - Repfabric
      - Salesforce
      - Salesflare
      - SugarCRM
      - HighLevel
      - Hubspot
      - Pipedrive
      - AutoQuotes
      - SpecPath
      - Clientify
      - Teamwork
      - EclipseERP
      - NetSuite
      - Fishbowl
      - Slack
      - Zoom
      - Webex
      - MCTrade
      - Creatio
      - QuickBooks
      - ActiveCampaign
      - ConstantContact
      - Yoxel
    NativeScope:
      type: string
      description: Native scope from provider's API.
    OrganizationDto:
      type: object
      properties:
        id:
          type: integer
          format: int64
        serviceProvider:
          $ref: '#/components/schemas/ServiceProvider'
        xid:
          type: string
        domain:
          type: string
        name:
          type: string
        createdAt:
          type: string
          format: date-time
    EndUserDto:
      type: object
      properties:
        id:
          type: string
        appId:
          type: integer
          format: int64
        email:
          type: string
        name:
          type: string
        authOrgId:
          type: string
        createdAt:
          type: string
          format: date-time
        lastActivity:
          type: string
          format: date-time
        trustedIdentity:
          type: boolean
        externalIdType:
          $ref: '#/components/schemas/EndUserExtIdType'
        accounts:
          type: array
          items:
            $ref: '#/components/schemas/EndUserAccountDto'
    EndUserExtIdType:
      type: string
      enum:
      - exchangeIdentity
    UserAccountType:
      type: string
      enum:
      - primary
      - secondary
      description: Type of user account. Required if `userId` is provided.
  responses:
    UnauthorizedError:
      description: Access token is missing or invalid
  securitySchemes:
    AppAuth:
      type: http
      scheme: basic
      description: App-level basic authentication using Client ID and Client Secret that can be obtained at Aurinko Dashboard page.
    AccountToken:
      type: http
      scheme: bearer
      description: Account-level authentication with account token obtained using `/auth/authorize` endpoint.
    UserSessionCookie:
      type: apiKey
      in: cookie
      name: AUR{APPID}
      description: Cookie-based user-level authentication
    UserSessionHeader:
      type: apiKey
      in: header
      name: X-Aurinko-Session
      description: Token-based user-level authentication
    ClientIdHeader:
      type: apiKey
      in: header
      name: X-Aurinko-Client-Id
      description: Client ID that can be obtained at Aurinko Dashboard page
    AccountIdHeader:
      type: apiKey
      in: header
      name: X-Aurinko-Account-Id
      description: User account id
    AuthTypeHeader:
      type: apiKey
      in: header
      name: X-Aurinko-Auth-Type
      description: 'Authentication type. Possible values: default, exchangeIdToken'
    ExchangeIdToken:
      type: http
      scheme: bearer
      bearerFormat: 'Exchange Identity Token (only with `X-Aurinko-Auth-Type: exchangeIdToken` header.)'
      description: 'Authentication using Exchange Identity Token. To use this method `X-Aurinko-Auth-Type: exchangeIdToken` header should be used.'
x-tagGroups:
- name: OAuth Flow
  tags:
  - Auth
  - Account
  - User
- name: Account management
  tags:
  - Accounts
  - Services
  - Managed accounts
- name: Email
  tags:
  - Messages
  - EmailSync
  - Drafts
  - EmailFolders
  - EmailTracking
  - FollowUpRobot
- name: Calendars
  tags:
  - Calendars
  - Events
  - CalSync
  - FreeBusySchedule
- name: Scheduling
  tags:
  - Booking
  - GroupBooking
  - Availability
- name: Contacts
  tags:
  - Contacts
  - ContSync
- name: Tasks
  tags:
  - TaskLists
  - Tasks
  - TaskSync
- name: Webhooks
  tags:
  - Webhooks
- name: Other
  tags:
  - Errors