Activeloop Users API

openapi: 3.2.0
info:
  title: Fast Users API
  version: 0.1.0
tags:
- name: Users
paths:
  /api/user/migrate:
    post:
      tags:
      - Users
      summary: Migrate
      description: Attempts an auto migration
      operationId: migrate_api_user_migrate_post
      security:
      - HTTPBearer: []
      parameters:
      - name: Activeloop-Api-Version
        in: header
        required: false
        schema:
          $ref: '#/components/schemas/ApiVersion'
          title: Activeloop API Version
          description: Controls which version of the Activeloop API gets used to execute client Requests. Leaving this out will default to the oldest currently supported API behavior.<br>`2024-02-10` is equivalent to omitting this header entirely as it is the oldest version.
          default: '2024-02-10'
        description: Controls which version of the Activeloop API gets used to execute client Requests. Leaving this out will default to the oldest currently supported API behavior.<br>`2024-02-10` is equivalent to omitting this header entirely as it is the oldest version.
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/user/machine/{machine_user_id}:
    delete:
      tags:
      - Users
      summary: Delete Machine User
      description: Deletes a Machine User
      operationId: delete_machine_user_api_user_machine__machine_user_id__delete
      security:
      - HTTPBearer: []
      parameters:
      - name: machine_user_id
        in: path
        required: true
        schema:
          type: string
          title: Machine User Id
      - name: hard_fail
        in: query
        required: false
        schema:
          type: boolean
          default: true
          title: Hard Fail
      - name: require_profile
        in: query
        required: false
        schema:
          type: boolean
          default: true
          title: Require Profile
      - name: Activeloop-Api-Version
        in: header
        required: false
        schema:
          $ref: '#/components/schemas/ApiVersion'
          title: Activeloop API Version
          description: Controls which version of the Activeloop API gets used to execute client Requests. Leaving this out will default to the oldest currently supported API behavior.<br>`2024-02-10` is equivalent to omitting this header entirely as it is the oldest version.
          default: '2024-02-10'
        description: Controls which version of the Activeloop API gets used to execute client Requests. Leaving this out will default to the oldest currently supported API behavior.<br>`2024-02-10` is equivalent to omitting this header entirely as it is the oldest version.
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/user/machine:
    post:
      tags:
      - Users
      summary: Register Machine User
      description: Registers a Machine User/Workload Identity
      operationId: register_machine_user_api_user_machine_post
      security:
      - HTTPBearer: []
      parameters:
      - name: hard_fail
        in: query
        required: false
        schema:
          type: boolean
          default: true
          title: Hard Fail
      - name: require_profile
        in: query
        required: false
        schema:
          type: boolean
          default: true
          title: Require Profile
      - name: Activeloop-Api-Version
        in: header
        required: false
        schema:
          $ref: '#/components/schemas/ApiVersion'
          title: Activeloop API Version
          description: Controls which version of the Activeloop API gets used to execute client Requests. Leaving this out will default to the oldest currently supported API behavior.<br>`2024-02-10` is equivalent to omitting this header entirely as it is the oldest version.
          default: '2024-02-10'
        description: Controls which version of the Activeloop API gets used to execute client Requests. Leaving this out will default to the oldest currently supported API behavior.<br>`2024-02-10` is equivalent to omitting this header entirely as it is the oldest version.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RegisterMachineUserRequestData'
      responses:
        '201':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/user/register:
    post:
      tags:
      - Users
      summary: Register User
      description: Registers a user with the activeloop cloud platform.
      operationId: register_user_api_user_register_post
      security:
      - HTTPBearer: []
      parameters:
      - name: Activeloop-Api-Version
        in: header
        required: false
        schema:
          $ref: '#/components/schemas/ApiVersion'
          title: Activeloop API Version
          description: Controls which version of the Activeloop API gets used to execute client Requests. Leaving this out will default to the oldest currently supported API behavior.<br>`2024-02-10` is equivalent to omitting this header entirely as it is the oldest version.
          default: '2024-02-10'
        description: Controls which version of the Activeloop API gets used to execute client Requests. Leaving this out will default to the oldest currently supported API behavior.<br>`2024-02-10` is equivalent to omitting this header entirely as it is the oldest version.
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/user/headless-register:
    post:
      tags:
      - Users
      summary: Register User Headless
      description: Creates a new user without being dependent on the Frontend redirect flow to handle the username introduction
      operationId: register_user_headless_api_user_headless_register_post
      parameters:
      - name: Activeloop-Api-Version
        in: header
        required: false
        schema:
          $ref: '#/components/schemas/ApiVersion'
          title: Activeloop API Version
          description: Controls which version of the Activeloop API gets used to execute client Requests. Leaving this out will default to the oldest currently supported API behavior.<br>`2024-02-10` is equivalent to omitting this header entirely as it is the oldest version.
          default: '2024-02-10'
        description: Controls which version of the Activeloop API gets used to execute client Requests. Leaving this out will default to the oldest currently supported API behavior.<br>`2024-02-10` is equivalent to omitting this header entirely as it is the oldest version.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/HeadlessUserRegistrationRequest'
      responses:
        '201':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserDataModel'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/user/delete:
    delete:
      tags:
      - Users
      summary: Delete
      description: Deletes an existing user.
      operationId: delete_api_user_delete_delete
      security:
      - HTTPBearer: []
      parameters:
      - name: hard_fail
        in: query
        required: false
        schema:
          type: boolean
          default: true
          title: Hard Fail
      - name: require_profile
        in: query
        required: false
        schema:
          type: boolean
          default: true
          title: Require Profile
      - name: Activeloop-Api-Version
        in: header
        required: false
        schema:
          $ref: '#/components/schemas/ApiVersion'
          title: Activeloop API Version
          description: Controls which version of the Activeloop API gets used to execute client Requests. Leaving this out will default to the oldest currently supported API behavior.<br>`2024-02-10` is equivalent to omitting this header entirely as it is the oldest version.
          default: '2024-02-10'
        description: Controls which version of the Activeloop API gets used to execute client Requests. Leaving this out will default to the oldest currently supported API behavior.<br>`2024-02-10` is equivalent to omitting this header entirely as it is the oldest version.
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/user/token:
    post:
      tags:
      - Users
      summary: Get Auth Token
      description: Provides a session token for the user.
      operationId: get_auth_token_api_user_token_post
      parameters:
      - name: Activeloop-Api-Version
        in: header
        required: false
        schema:
          $ref: '#/components/schemas/ApiVersion'
          title: Activeloop API Version
          description: Controls which version of the Activeloop API gets used to execute client Requests. Leaving this out will default to the oldest currently supported API behavior.<br>`2024-02-10` is equivalent to omitting this header entirely as it is the oldest version.
          default: '2024-02-10'
        description: Controls which version of the Activeloop API gets used to execute client Requests. Leaving this out will default to the oldest currently supported API behavior.<br>`2024-02-10` is equivalent to omitting this header entirely as it is the oldest version.
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    get:
      tags:
      - Users
      summary: Get Auth Token
      description: Provides a session token for the user.
      operationId: get_auth_token_api_user_token_get
      parameters:
      - name: Activeloop-Api-Version
        in: header
        required: false
        schema:
          $ref: '#/components/schemas/ApiVersion'
          title: Activeloop API Version
          description: Controls which version of the Activeloop API gets used to execute client Requests. Leaving this out will default to the oldest currently supported API behavior.<br>`2024-02-10` is equivalent to omitting this header entirely as it is the oldest version.
          default: '2024-02-10'
        description: Controls which version of the Activeloop API gets used to execute client Requests. Leaving this out will default to the oldest currently supported API behavior.<br>`2024-02-10` is equivalent to omitting this header entirely as it is the oldest version.
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/user/legacy/link:
    post:
      tags:
      - Users
      summary: Legacy Link
      description: Links legacy login with auth0 login
      operationId: legacy_link_api_user_legacy_link_post
      security:
      - HTTPBearer: []
      parameters:
      - name: Activeloop-Api-Version
        in: header
        required: false
        schema:
          $ref: '#/components/schemas/ApiVersion'
          title: Activeloop API Version
          description: Controls which version of the Activeloop API gets used to execute client Requests. Leaving this out will default to the oldest currently supported API behavior.<br>`2024-02-10` is equivalent to omitting this header entirely as it is the oldest version.
          default: '2024-02-10'
        description: Controls which version of the Activeloop API gets used to execute client Requests. Leaving this out will default to the oldest currently supported API behavior.<br>`2024-02-10` is equivalent to omitting this header entirely as it is the oldest version.
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/user/profile:
    get:
      tags:
      - Users
      summary: User Profile Get
      description: Returns a user matching the credentials.
      operationId: user_profile_get_api_user_profile_get
      security:
      - HTTPBearer: []
      parameters:
      - name: Activeloop-Api-Version
        in: header
        required: false
        schema:
          $ref: '#/components/schemas/ApiVersion'
          title: Activeloop API Version
          description: Controls which version of the Activeloop API gets used to execute client Requests. Leaving this out will default to the oldest currently supported API behavior.<br>`2024-02-10` is equivalent to omitting this header entirely as it is the oldest version.
          default: '2024-02-10'
        description: Controls which version of the Activeloop API gets used to execute client Requests. Leaving this out will default to the oldest currently supported API behavior.<br>`2024-02-10` is equivalent to omitting this header entirely as it is the oldest version.
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/user/update:
    put:
      tags:
      - Users
      summary: User Update
      description: Updates a subset of fields in user record.
      operationId: user_update_api_user_update_put
      security:
      - HTTPBearer: []
      parameters:
      - name: hard_fail
        in: query
        required: false
        schema:
          type: boolean
          default: true
          title: Hard Fail
      - name: require_profile
        in: query
        required: false
        schema:
          type: boolean
          default: true
          title: Require Profile
      - name: Activeloop-Api-Version
        in: header
        required: false
        schema:
          $ref: '#/components/schemas/ApiVersion'
          title: Activeloop API Version
          description: Controls which version of the Activeloop API gets used to execute client Requests. Leaving this out will default to the oldest currently supported API behavior.<br>`2024-02-10` is equivalent to omitting this header entirely as it is the oldest version.
          default: '2024-02-10'
        description: Controls which version of the Activeloop API gets used to execute client Requests. Leaving this out will default to the oldest currently supported API behavior.<br>`2024-02-10` is equivalent to omitting this header entirely as it is the oldest version.
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/user/email/resend_verification:
    post:
      tags:
      - Users
      summary: Resend Verification Email
      description: Updates a subset of fields in user record.
      operationId: resend_verification_email_api_user_email_resend_verification_post
      security:
      - HTTPBearer: []
      parameters:
      - name: Activeloop-Api-Version
        in: header
        required: false
        schema:
          $ref: '#/components/schemas/ApiVersion'
          title: Activeloop API Version
          description: Controls which version of the Activeloop API gets used to execute client Requests. Leaving this out will default to the oldest currently supported API behavior.<br>`2024-02-10` is equivalent to omitting this header entirely as it is the oldest version.
          default: '2024-02-10'
        description: Controls which version of the Activeloop API gets used to execute client Requests. Leaving this out will default to the oldest currently supported API behavior.<br>`2024-02-10` is equivalent to omitting this header entirely as it is the oldest version.
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/user/password/forget:
    post:
      tags:
      - Users
      summary: Forget
      description: Activates a reset password email for the user.
      operationId: forget_api_user_password_forget_post
      security:
      - HTTPBearer: []
      parameters:
      - name: Activeloop-Api-Version
        in: header
        required: false
        schema:
          $ref: '#/components/schemas/ApiVersion'
          title: Activeloop API Version
          description: Controls which version of the Activeloop API gets used to execute client Requests. Leaving this out will default to the oldest currently supported API behavior.<br>`2024-02-10` is equivalent to omitting this header entirely as it is the oldest version.
          default: '2024-02-10'
        description: Controls which version of the Activeloop API gets used to execute client Requests. Leaving this out will default to the oldest currently supported API behavior.<br>`2024-02-10` is equivalent to omitting this header entirely as it is the oldest version.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ForgetPasswordRequestData'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/user/password/reset:
    post:
      tags:
      - Users
      summary: Reset Password
      description: Resets password of the user after verifying the code.
      operationId: reset_password_api_user_password_reset_post
      parameters:
      - name: Activeloop-Api-Version
        in: header
        required: false
        schema:
          $ref: '#/components/schemas/ApiVersion'
          title: Activeloop API Version
          description: Controls which version of the Activeloop API gets used to execute client Requests. Leaving this out will default to the oldest currently supported API behavior.<br>`2024-02-10` is equivalent to omitting this header entirely as it is the oldest version.
          default: '2024-02-10'
        description: Controls which version of the Activeloop API gets used to execute client Requests. Leaving this out will default to the oldest currently supported API behavior.<br>`2024-02-10` is equivalent to omitting this header entirely as it is the oldest version.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UserResetPasswordModel'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/user/password/update:
    post:
      tags:
      - Users
      summary: Update Password
      description: Resets the password of the user.
      operationId: update_password_api_user_password_update_post
      security:
      - HTTPBearer: []
      parameters:
      - name: Activeloop-Api-Version
        in: header
        required: false
        schema:
          $ref: '#/components/schemas/ApiVersion'
          title: Activeloop API Version
          description: Controls which version of the Activeloop API gets used to execute client Requests. Leaving this out will default to the oldest currently supported API behavior.<br>`2024-02-10` is equivalent to omitting this header entirely as it is the oldest version.
          default: '2024-02-10'
        description: Controls which version of the Activeloop API gets used to execute client Requests. Leaving this out will default to the oldest currently supported API behavior.<br>`2024-02-10` is equivalent to omitting this header entirely as it is the oldest version.
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    AzureWorkloadIdentityDataModel:
      properties:
        type:
          type: string
          const: azure
          title: Type
          default: azure
        azure_client_id:
          type: string
          title: Azure Client Id
        azure_tenant_id:
          type: string
          title: Azure Tenant Id
      type: object
      required:
      - azure_client_id
      - azure_tenant_id
      title: AzureWorkloadIdentityDataModel
    ApiVersion:
      type: string
      enum:
      - '2024-02-10'
      - '2024-10-01'
      title: ApiVersion
    UserApiTokenModel:
      properties:
        id:
          type: string
          title: Id
        name:
          type: string
          title: Name
        duration:
          type: integer
          title: Duration
        expiration:
          type: number
          title: Expiration
        token:
          type: string
          title: Token
        organization_id:
          anyOf:
          - type: string
          - type: 'null'
          title: Organization Id
        version:
          anyOf:
          - type: integer
          - type: 'null'
          title: Version
      type: object
      required:
      - name
      - duration
      - expiration
      - token
      title: UserApiTokenModel
    HeadlessUserRegistrationRequest:
      properties:
        email:
          type: string
          title: Email
        username:
          type: string
          maxLength: 40
          minLength: 3
          title: Username
        password:
          type: string
          format: password
          title: Password
          writeOnly: true
      type: object
      required:
      - email
      - username
      - password
      title: HeadlessUserRegistrationRequest
    AuthProviderType:
      type: string
      enum:
      - internal
      - google
      - github
      title: AuthProviderType
    RegisterMachineUserRequestData:
      properties:
        name:
          anyOf:
          - type: string
          - type: 'null'
          title: Name
        fullname:
          anyOf:
          - type: string
          - type: 'null'
          title: Fullname
        organization_id:
          type: string
          title: Organization Id
        workload_identity_data:
          $ref: '#/components/schemas/AzureWorkloadIdentityDataModel'
      type: object
      required:
      - organization_id
      - workload_identity_data
      title: RegisterMachineUserRequestData
    UserDataModel:
      properties:
        _id:
          type: string
          title: Id
        uuid:
          type: string
          format: uuid
          title: Uuid
        name:
          type: string
          title: Name
          description: The user's username, matches their id and personal organization's id
        type:
          anyOf:
          - type: string
            const: user
          - type: 'null'
          title: Type
          default: user
        super:
          type: boolean
          title: Super
          description: Denotes if the entity is a 'SuperUser'
          default: false
        do_not_send_emails:
          anyOf:
          - type: boolean
          - type: 'null'
          title: Do Not Send Emails
          default: false
        auth_id:
          anyOf:
          - type: string
          - type: 'null'
          title: Auth Id
        date_joined:
          anyOf:
          - type: number
          - type: 'null'
          title: Date Joined
        organizations:
          items:
            type: string
          type: array
          title: Organizations
        fullname:
          anyOf:
          - type: string
          - type: 'null'
          title: Fullname
        migrated:
          type: boolean
          title: Migrated
          default: false
        email:
          type: string
          format: email
          title: Email
          default: ''
        temp_email:
          anyOf:
          - type: string
            format: email
          - type: 'null'
          title: Temp Email
        temp_email_code:
          anyOf:
          - type: string
          - type: 'null'
          title: Temp Email Code
        temp_email_code_time:
          anyOf:
          - type: number
          - type: 'null'
          title: Temp Email Code Time
        api_tokens:
          items:
            $ref: '#/components/schemas/UserApiTokenModel'
          type: array
          title: Api Tokens
          default: []
        invalid_api_tokens:
          anyOf:
          - items:
              $ref: '#/components/schemas/UserInvalidApiTokenModel'
            type: array
          - type: 'null'
          title: Invalid Api Tokens
          default: []
        profile:
          additionalProperties: true
          type: object
          title: Profile
          default:
            name: ' '
            company: ' '
            location: ' '
            profile_url: ' '
            gravatar_email: ' '
        password_hash:
          anyOf:
          - type: string
          - type: 'null'
          title: Password Hash
          default: ''
        stars:
          anyOf:
          - type: integer
          - type: 'null'
          title: Stars
          default: 0
        about:
          anyOf:
          - type: string
          - type: 'null'
          title: About
          default: ''
        provider:
          anyOf:
          - $ref: '#/components/schemas/AuthProviderType'
          - type: 'null'
          default: internal
        verified:
          anyOf:
          - type: boolean
          - type: 'null'
          title: Verified
          default: false
        verification_code:
          anyOf:
          - type: string
          - type: 'null'
          title: Verification Code
      type: object
      required:
      - _id
      - name
      title: UserDataModel
      example:
        email: support@snark.ai
        id: mnist
        name: mnist
        organizations:
        - test
        - mnist
        - davit
        - public
        profile:
          company: ' '
          gravatar_email: ' '
          location: ' '
          name: ' '
          profile_url: ' '
        verified: false
    ForgetPasswordRequestData:
      properties:
        email:
          type: string
          title: Email
      type: object
      required:
      - email
      title: ForgetPasswordRequestData
    UserResetPasswordModel:
      properties:
        code:
          type: string
          title: Code
        password:
          type: string
          title: Password
      type: object
      required:
      - code
      - password
      title: UserResetPasswordModel
    UserInvalidApiTokenModel:
      properties:
        id:
          type: string
          title: Id
        name:
          type: string
          title: Name
        duration:
          type: integer
          title: Duration
        expiration:
          anyOf:
          - type: number
          - type: 'null'
          title: Expiration
        token:
          type: string
          title: Token
        organization_id:
          anyOf:
          - type: string
          - type: 'null'
          title: Organization Id
        version:
          anyOf:
          - type: integer
          - type: 'null'
          title: Version
      type: object
      required:
      - name
      - duration
      - token
      title: UserInvalidApiTokenModel
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
            - type: string
            - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
      - loc
      - msg
      - type
      title: ValidationError
  securitySchemes:
    HTTPBearer:
      type: http
      scheme: bearer
x-provenance:
  method: harvested
  publisher: Activeloop
  source: https://app.activeloop.ai/api/openapi.json
  note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
    stamped by stamp-openapi-provenance.py (roadmap#793)