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. Data API
  4. ACL

Group

PreviousACLNextControl API

Last updated 4 months ago

Get Group

get

Fetch group based on group id.

Query parameters
group_idintegerRequired

Id of group

Responses
200
Successful Response
application/json
422
Validation Error
application/json
get
GET /api/v1/data/acl/group?group_id=1 HTTP/1.1
Host: connect.<REGION>.decube.io
Accept: */*
{
  "id": 1,
  "name": "text",
  "description": "text",
  "owner": true,
  "users": [
    "text"
  ],
  "policies": [
    1
  ]
}

List Groups

get

List all groups available in the account.

Query parameters
pageinteger ยท min: 1OptionalDefault: 1
page_sizeinteger ยท min: 1 ยท max: 100OptionalDefault: 10
Responses
200
Successful Response
application/json
422
Validation Error
application/json
get
GET /api/v1/data/acl/group/list HTTP/1.1
Host: connect.<REGION>.decube.io
Accept: */*
[
  {
    "id": 1,
    "name": "text",
    "description": "text",
    "owner": true,
    "users": [
      "text"
    ],
    "policies": [
      1
    ]
  }
]
  • POSTRemove User From Group
  • POSTAdd User To Group
  • GETGet Group
  • GETList Groups

Remove User From Group

post

Remove user from group.

Body
user_idstringRequired
group_idintegerRequired
Responses
200
Successful Response
application/json
Responseany
422
Validation Error
application/json
post
POST /api/v1/data/acl/group/remove_user HTTP/1.1
Host: connect.<REGION>.decube.io
Content-Type: application/json
Accept: */*
Content-Length: 31

{
  "user_id": "text",
  "group_id": 1
}

No content

Add User To Group

post

Add user to group.

Body
user_idstringRequired
group_idintegerRequired
Responses
200
Successful Response
application/json
Responseany
422
Validation Error
application/json
post
POST /api/v1/data/acl/group/add_user HTTP/1.1
Host: connect.<REGION>.decube.io
Content-Type: application/json
Accept: */*
Content-Length: 31

{
  "user_id": "text",
  "group_id": 1
}

No content