Activeloop

Activeloop Authz API

The authz API from Activeloop — 4 operation(s) for authz.

GitHub OpenAPI

Operations 8

GET /api/permissions/{organization_id}/dataset/{dataset_name} Get Dataset Permissions #
PUT /api/permissions/{organization_id}/dataset/{dataset_name} Update Dataset Permissions #
DELETE /api/permissions/{organization_id}/dataset/{dataset_name} Delete Dataset Permissions #
GET /api/permissions/{organization_id}/user/{user_id}/dataset-permissions Get User Dataset Permissions #
PUT /api/permissions/{organization_id}/user/{user_id}/dataset-permissions Update User Dataset Permissions #
DELETE /api/permissions/{organization_id}/user/{user_id}/dataset-permissions Delete User Dataset Permissions #
POST /api/authz/check Authorize Action On Entity #
POST /api/authz/check-feature Authorize Action On Entity #

Documentation

📖
Documentation
https://docs.deeplake.ai/
📖
APIReference
https://docs-v3.activeloop.ai/
📖
Documentation
https://docs-v3.activeloop.ai/examples/tql
📖
Documentation
https://docs-v3.activeloop.ai/examples/rag/tutorials/vector-store-basics
📖
Documentation
https://docs-v3.activeloop.ai/examples/rag/tutorials/vector-search-options/rest-api

Specifications

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

Other Resources

🔗
GitHub
https://github.com/activeloopai/deeplake

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/activeloop:activeloop-authz-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

activeloop-authz-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Fast Authz API
  version: 0.1.0
tags:
- name: authz
paths:
  /api/permissions/{organization_id}/dataset/{dataset_name}:
    get:
      tags:
      - authz
      summary: Get Dataset Permissions
      description: Returns a list of users with corresponding access permission levels for a given dataset.
      operationId: get_dataset_permissions_api_permissions__organization_id__dataset__dataset_name__get
      security:
      - HTTPBearer: []
      parameters:
      - name: organization_id
        in: path
        required: true
        schema:
          type: string
          title: Organization Id
      - name: dataset_name
        in: path
        required: true
        schema:
          type: string
          title: Dataset Name
      - 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'
    put:
      tags:
      - authz
      summary: Update Dataset Permissions
      description: Updates the access permissions for a given dataset.
      operationId: update_dataset_permissions_api_permissions__organization_id__dataset__dataset_name__put
      security:
      - HTTPBearer: []
      parameters:
      - name: organization_id
        in: path
        required: true
        schema:
          type: string
          title: Organization Id
      - name: dataset_name
        in: path
        required: true
        schema:
          type: string
          title: Dataset Name
      - 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:
              type: array
              items:
                $ref: '#/components/schemas/PerUserDatasetPermissionsUpdateEntry'
              title: Body
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    delete:
      tags:
      - authz
      summary: Delete Dataset Permissions
      description: Deletes the access permissions of specified users for a given dataset.
      operationId: delete_dataset_permissions_api_permissions__organization_id__dataset__dataset_name__delete
      security:
      - HTTPBearer: []
      parameters:
      - name: organization_id
        in: path
        required: true
        schema:
          type: string
          title: Organization Id
      - name: dataset_name
        in: path
        required: true
        schema:
          type: string
          title: Dataset Name
      - name: user_ids
        in: query
        required: false
        schema:
          type: array
          items:
            type: string
          default: []
          title: User Ids
      - 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/permissions/{organization_id}/user/{user_id}/dataset-permissions:
    get:
      tags:
      - authz
      summary: Get User Dataset Permissions
      description: Returns a list of datasets with corresponding access permission levels for a given user.
      operationId: get_user_dataset_permissions_api_permissions__organization_id__user__user_id__dataset_permissions_get
      security:
      - HTTPBearer: []
      parameters:
      - name: organization_id
        in: path
        required: true
        schema:
          type: string
          title: Organization Id
      - name: user_id
        in: path
        required: true
        schema:
          type: string
          title: 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'
    put:
      tags:
      - authz
      summary: Update User Dataset Permissions
      description: Updates the dataset access permissions for a given user.
      operationId: update_user_dataset_permissions_api_permissions__organization_id__user__user_id__dataset_permissions_put
      security:
      - HTTPBearer: []
      parameters:
      - name: user_id
        in: path
        required: true
        schema:
          type: string
          title: User Id
      - name: organization_id
        in: path
        required: true
        schema:
          type: string
          title: Organization 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.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/PerDatasetPermissionsUpdateEntry'
              title: Body
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    delete:
      tags:
      - authz
      summary: Delete User Dataset Permissions
      description: Deletes the dataset access permissions of specified datasets for a given user.
      operationId: delete_user_dataset_permissions_api_permissions__organization_id__user__user_id__dataset_permissions_delete
      security:
      - HTTPBearer: []
      parameters:
      - name: user_id
        in: path
        required: true
        schema:
          type: string
          title: User Id
      - name: organization_id
        in: path
        required: true
        schema:
          type: string
          title: Organization Id
      - name: dataset_ids
        in: query
        required: false
        schema:
          type: array
          items:
            type: string
          default: []
          title: Dataset Ids
      - 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/authz/check:
    post:
      tags:
      - authz
      summary: Authorize Action On Entity
      description: Check if a user has access to perform a given action on a specific entity
      operationId: authorize_action_on_entity_api_authz_check_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:
              oneOf:
              - $ref: '#/components/schemas/DatasetAuthzCheckDTO'
              - $ref: '#/components/schemas/OrganizationAuthzCheckDTO'
              - $ref: '#/components/schemas/ManagedCredentialAuthzCheckDTO'
              discriminator:
                propertyName: entity_type
                mapping:
                  dataset: '#/components/schemas/DatasetAuthzCheckDTO'
                  organization: '#/components/schemas/OrganizationAuthzCheckDTO'
                  managed_credential: '#/components/schemas/ManagedCredentialAuthzCheckDTO'
              title: Authz Check
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuthzResultDTO'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/authz/check-feature:
    post:
      tags:
      - authz
      summary: Authorize Action On Entity
      description: Check if an Org has access to a given feature
      operationId: authorize_action_on_entity_api_authz_check_feature_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/AuthzFeatureCheckDTO'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuthzResultDTO'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    FeatureId:
      type: string
      enum:
      - dataset_query
      - managed_query
      - dataset_analytics
      - deepmemory
      - rbac
      - ai_knowledge_agent
      - ai_knowledge_agent_uploads
      title: FeatureId
    AuthzResultDTO:
      properties:
        access:
          type: boolean
          title: Access
      type: object
      required:
      - access
      title: AuthzResultDTO
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    DatasetAuthzCheckDTO:
      properties:
        entity_type:
          type: string
          const: dataset
          title: Entity Type
          default: dataset
        entity_id:
          type: string
          title: Entity Id
        action:
          $ref: '#/components/schemas/DatasetRelation'
      type: object
      required:
      - entity_id
      - action
      title: DatasetAuthzCheckDTO
    ApiVersion:
      type: string
      enum:
      - '2024-02-10'
      - '2024-10-01'
      title: ApiVersion
    OrganizationAuthzCheckDTO:
      properties:
        entity_type:
          type: string
          const: organization
          title: Entity Type
          default: organization
        entity_id:
          type: string
          title: Entity Id
        action:
          $ref: '#/components/schemas/OrganizationRelation'
      type: object
      required:
      - entity_id
      - action
      title: OrganizationAuthzCheckDTO
    PerUserDatasetPermissionsUpdateEntry:
      properties:
        user_id:
          type: string
          title: User Id
        role:
          $ref: '#/components/schemas/DatasetRelation'
      type: object
      required:
      - user_id
      - role
      title: PerUserDatasetPermissionsUpdateEntry
    ManagedCredentialRelation:
      type: string
      enum:
      - parent
      - can_view
      - can_update
      - can_delete
      title: ManagedCredentialRelation
    DatasetRelation:
      type: string
      enum:
      - parent
      - admin
      - writer
      - viewer
      - can_delete
      - can_update
      - can_view
      - can_save_query
      - can_modify_readme
      - can_update_user_access
      title: DatasetRelation
    ManagedCredentialAuthzCheckDTO:
      properties:
        entity_type:
          type: string
          const: managed_credential
          title: Entity Type
          default: managed_credential
        entity_id:
          type: string
          title: Entity Id
        action:
          $ref: '#/components/schemas/ManagedCredentialRelation'
      type: object
      required:
      - entity_id
      - action
      title: ManagedCredentialAuthzCheckDTO
    OrganizationRelation:
      type: string
      enum:
      - contributor
      - viewer
      - writer
      - admin
      - can_remove_admin
      - can_delete
      - can_update
      - can_view
      - can_view_users
      - can_create_managed_credentials
      - can_create_workload_identities
      - can_create_datasets
      - can_update_user_access
      - can_invite_admin_users
      - can_invite_non_admin_users
      - can_modify_billing
      - can_access_ai_knowledge_agent
      - can_delete_workspace
      - can_modify_members
      - can_make_admin
      - can_modify_storage
      - can_modify_assets
      - can_access_assets
      - can_access_members
      title: OrganizationRelation
    PerDatasetPermissionsUpdateEntry:
      properties:
        dataset_id:
          type: string
          title: Dataset Id
        role:
          $ref: '#/components/schemas/DatasetRelation'
      type: object
      required:
      - dataset_id
      - role
      title: PerDatasetPermissionsUpdateEntry
    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
    AuthzFeatureCheckDTO:
      properties:
        org_id:
          type: string
          title: Org Id
          examples:
          - activeloop
        feature_id:
          $ref: '#/components/schemas/FeatureId'
          examples:
          - ai_knowledge_agent
      type: object
      required:
      - org_id
      - feature_id
      title: AuthzFeatureCheckDTO
  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)