Altinity

Altinity Auth API

The Auth API from Altinity — 8 operation(s) for auth.

GitHub OpenAPI

Documentation

📖
APIReference
https://acm.altinity.cloud/docs/
📖
Authentication
https://raw.githubusercontent.com/api-evangelist/altinity/refs/heads/main/authentication/altinity-authentication.yml

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/altinity/refs/heads/main/openapi/altinity-auth-api-openapi.yml

Other Resources

🔗
ErrorCatalog
https://raw.githubusercontent.com/api-evangelist/altinity/refs/heads/main/errors/altinity-problem-types.yml
🔗
Conventions
https://raw.githubusercontent.com/api-evangelist/altinity/refs/heads/main/conventions/altinity-conventions.yml
🔗
DataModel
https://raw.githubusercontent.com/api-evangelist/altinity/refs/heads/main/data-model/altinity-data-model.yml
🔗
Conformance
https://raw.githubusercontent.com/api-evangelist/altinity/refs/heads/main/conformance/altinity-conformance.yml
🔗
APIsJSON
https://raw.githubusercontent.com/api-evangelist/altinity/refs/heads/main/apis.yml

OpenAPI Specification

altinity-auth-api-openapi.yml Raw ↑ 
openapi: 3.0.0
info:
  version: 26.2.43
  title: Altinity Cloud Manager Auth API
  description: API Reference for Altinity Cloud Manager
  contact:
    name: Altinity
    email: support@altinity.com
  termsOfService: https://altinity.com/wp-content/uploads/2022/09/Altinity.Cloud-Terms-of-Service.pdf
servers:
- url: https://acm.altinity.cloud/api/
  description: Primary API Server
tags:
- name: Auth
paths:
  /login:
    post:
      summary: Provides a token for a pair of users login and password
      tags:
      - Auth
      parameters: []
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema: {}
        '401':
          description: Unauthorized
        '404':
          description: Not found
      operationId: Login
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                login:
                  type: string
                password:
                  type: string
  /login/recover:
    post:
      summary: Sends out an email with password reset link
      tags:
      - Auth
      parameters: []
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema: {}
        '401':
          description: Unauthorized
        '404':
          description: Not found
      operationId: LoginRecovery
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                login:
                  type: string
  /login/reset:
    get:
      summary: Checks whether password reset token is active
      tags:
      - Auth
      parameters:
      - name: code
        in: query
        schema:
          type: string
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema: {}
        '401':
          description: Unauthorized
        '404':
          description: Not found
      operationId: LoginResetCheck
    post:
      summary: Checks whether password reset token is active
      tags:
      - Auth
      parameters: []
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema: {}
        '401':
          description: Unauthorized
        '404':
          description: Not found
      operationId: LoginReset
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                code:
                  type: string
                password:
                  type: string
  /login/verify:
    post:
      summary: Login with 2FA verification code
      tags:
      - Auth
      parameters: []
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema: {}
        '401':
          description: Unauthorized
        '404':
          description: Not found
      operationId: LoginVerify
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                code:
                  type: string
                user:
                  type: string
  /probe:
    get:
      summary: System probe
      tags:
      - Auth
      parameters: []
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema: {}
        '401':
          description: Unauthorized
        '404':
          description: Not found
      operationId: SystemProbe
  /signup-email:
    post:
      summary: Creates a trial account in Altinity.Cloud using only Email
      tags:
      - Auth
      parameters: []
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema: {}
        '401':
          description: Unauthorized
        '404':
          description: Not found
      operationId: SignupQuick
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
                email:
                  type: string
                captcha:
                  type: string
  /signup/confirm:
    get:
      summary: Checks whether signup token is active
      tags:
      - Auth
      parameters:
      - name: code
        in: query
        schema:
          type: string
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema: {}
        '401':
          description: Unauthorized
        '404':
          description: Not found
      operationId: SignupCheck
    post:
      summary: Finishes up signup procedure
      tags:
      - Auth
      parameters: []
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema: {}
        '401':
          description: Unauthorized
        '404':
          description: Not found
      operationId: SignupConfirm
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                code:
                  type: string
                password:
                  type: string
  /singleauth:
    get:
      summary: Provides with a target URL for Auth0
      tags:
      - Auth
      parameters:
      - name: type
        in: query
        schema:
          type: string
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema: {}
        '401':
          description: Unauthorized
        '404':
          description: Not found
      operationId: GetSingleAuth
    post:
      summary: Authenticate user with Auth0 oAuth token
      tags:
      - Auth
      parameters: []
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema: {}
        '401':
          description: Unauthorized
        '404':
          description: Not found
      operationId: DoSingleAuth
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                code:
                  type: string
                state:
                  type: string
                token:
                  type: string
components:
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-Auth-Token