Decube
Try for free
  • 🚀Overview
    • Welcome to decube
    • Getting started
      • How to connect data sources
    • Security and Compliance
    • Data Policy
    • Changelog
    • Public Roadmap
  • Support
  • 🔌Data Warehouses
    • Snowflake
    • Redshift
    • Google Bigquery
    • Databricks
    • Azure Synapse
  • 🔌Relational Databases
    • PostgreSQL
    • MySQL
    • SingleStore
    • Microsoft SQL Server
    • Oracle
  • 🔌Transformation Tools
    • dbt (Cloud Version)
    • dbt Core
    • Fivetran
    • Airflow
    • AWS Glue
    • Azure Data Factory
    • Apache Spark
      • Apache Spark in Azure Synapse
    • OpenLineage (BETA)
    • Additional configurations
  • 🔌Business Intelligence
    • Tableau
    • Looker
    • PowerBI
  • 🔌Data Lake
    • AWS S3
    • Azure Data Lake Storage (ADLS)
      • Azure Function for Metadata
    • Google Cloud Storage (GCS)
  • 🔌Ticketing and Collaboration
    • ServiceNow
    • Jira
  • 🔒Security and Connectivity
    • Enabling VPC Access
    • IP Whitelisting
    • SSH Tunneling
    • AWS Identities
  • ✅Data Quality
    • Incidents Overview
    • Incident model feedback
    • Enable asset monitoring
    • Available Monitor Types
    • Available Monitor Modes
    • Catalog: Add/Modify Monitor
    • Set Up Freshness & Volume Monitors
    • Set Up Field Health Monitors
    • Set Up Custom SQL Monitors
    • Grouped-by Monitors
    • Modify Schema Drift Monitors
    • Modify Job Failure Monitors (Data Job)
    • Custom Scheduling For Monitors
    • Config Settings
  • 📖Catalog
    • Overview of Asset Types
    • Assets Catalog
    • Asset Overview
    • Automated Lineage
      • Lineage Relationship
      • Supported Data Sources and Lineage Types
    • Add lineage relationships manually
    • Add tags and classifications to fields
    • Field Statistcs
    • Preview sample data
  • 📚Glossary
    • Glossary, Category and Terms
    • Adding a new glossary
    • Adding Terms and Linked Assets
  • Moving Terms to Glossary/Category
  • AI Copilot
    • Copilot's Autocomplete
  • 🤝Collaboration
    • Ask Questions
    • Rate an asset
  • 🌐Data Mesh [BETA]
    • Overview on Data Mesh [BETA]
    • Creating and Managing Domains/Sub-domains
    • Adding members to Domain/Sub-domain
    • Linking Entities to Domains/Sub-domains
    • Adding Data Products to Domains/Subdomains
    • Creating a draft Data Asset
    • Adding a Data Contract - Default Settings
    • Adding a Data Contract - Freshness Test
    • Adding a Data Contract - Column Tests
    • Publishing the Data Asset
  • 🏛️Governance
    • Governance module
    • Classification Policies
    • Auto-classify data assets
  • ☑️Approval Workflow
    • What are Change Requests?
    • Initiate a change request
    • What are Access Requests?
    • Initiate an Access Request
  • 📋Reports
    • Overview of Reports
    • Supported sources for Reports
    • Asset Report: Data Quality Scorecard
  • 📊Dashboard
    • Dashboard Overview
    • Incidents
    • Quality
  • ⏰Alert Notifications
    • Get alerts on email
    • Connect your Slack channels
    • Connect to Microsoft Teams
    • Webhooks integration
  • 🏛️Manage Access
    • User Management - Overview
    • Invite users
    • Deactivate or re-activate users
    • Revoke a user invite
  • 🔐Group-based Access Controls
    • Groups Management - Overview
    • Create Groups & Assign Policies
    • Source-based Policies
    • Administrative-based Policies
    • Module-based Policies
    • What is the "Owners" group?
  • 🗄️Org Settings
    • Multi-factor authentication
    • Single Sign-On (SSO) with Microsoft
    • Single Sign-On (SSO) with JumpCloud
  • ❓Support
    • Supported Features by Integration
    • Frequently Asked Questions
    • Supported Browsers and System Requirements
  • Public API (BETA)
    • Overview
      • Data API
        • Glossary
        • Lineage
        • ACL
          • Group
      • Control API
        • Users
    • API Keys
Powered by GitBook
On this page
  1. Public API (BETA)
  2. Overview
  3. Control API

Users

PreviousControl APINextAPI Keys

Last updated 4 months ago

delete

Endpoint to deactivate a user for the organization.

Query parameters
emailstringRequired
Responses
200
User account deactivated successfully.
application/json
403Error
application/json
404
User not found.
application/json
500
An error occurred while handling the request.
application/json
delete
DELETE /api/v1/app/user?email=text HTTP/1.1
Host: connect.<REGION>.decube.io
Accept: */*
{
  "code": "user_account_deactivated_successfully",
  "message": "User account deactivated successfully."
}
get

Endpoint to fetch users for the organization.

Query parameters
pageinteger | nullOptional
page_sizeinteger | nullOptional
Responses
200Success
application/json
500
An error occurred while handling the request.
application/json
get
GET /api/v1/app/users HTTP/1.1
Host: connect.<REGION>.decube.io
Accept: */*
{
  "count": 3,
  "users": [
    {
      "email": "user1@decube.io",
      "id": "0000-USER1",
      "name": "USER1",
      "status": "active"
    },
    {
      "email": "user3@decube.io",
      "id": "0000-USER3",
      "name": "USER3",
      "status": "deactivated"
    },
    {
      "email": "user2@decube.io",
      "id": "0000-USER2",
      "name": "USER2",
      "status": "pending_sign_up"
    }
  ]
}
  • GET/user
  • POST/user
  • DELETE/user
  • GET/users
get

Endpoint to fetch a user for the organization.

Query parameters
idstring | nullOptional
emailstring | nullOptional
Responses
200Success
application/json
404
User not found.
application/json
422
Both the ID and the email are not set.
application/json
500
An error occurred while handling the request.
application/json
get
GET /api/v1/app/user HTTP/1.1
Host: connect.<REGION>.decube.io
Accept: */*
{
  "email": "user1@decube.io",
  "id": "0000-USER1",
  "name": "USER1",
  "status": "active"
}
post

Endpoint to create a user for the organization.

Body
emailstringRequired
namestringRequired
Responses
201Success
application/json
400Error
application/json
500
An error occurred while handling the request.
application/json
post
POST /api/v1/app/user HTTP/1.1
Host: connect.<REGION>.decube.io
Content-Type: application/json
Accept: */*
Content-Length: 30

{
  "email": "text",
  "name": "text"
}
{
  "email": "user1@decube.io",
  "id": "0000-USER1",
  "name": "USER1"
}