Secoda Docs
Get Started
  • Getting Started with Secoda
    • Secoda as an Admin
      • Deployment options
      • Sign in options
      • Settings
      • Connect your data
        • Define Service Accounts
        • Choose which schemas to extract
      • Customize the workspace
      • Populate Questions with FAQs
      • Invite your teammates
        • Joining & Navigating between Multiple Workspaces
      • Onboard new users
        • Onboarding email templates
        • Onboarding Homepage template
        • Training session guide
      • User engagement and adoption
        • Tips & Tricks to share with new users
    • Secoda as an Editor
    • Secoda as a Viewer
      • Introduction guide
      • Requesting changes in Secoda
  • Best practices
    • Setting up your workspace
    • Integrating Secoda into existing workflows
    • Documentation best practices
    • Glossary best practices
    • Data governance
    • Data quality
    • Clean up your data
    • Tool migrations using Secoda
    • Slack <> Questions workflow
    • Defining resources workflow
    • Streamline data access: Private and public teams workflow
    • Exposing Secoda to external clients
  • Resource Management
    • Editing Properties
      • AI Description Editor
      • Bulk Editing
      • Propagation
      • Templates
    • Resource Sidesheet
    • Assigning Owners
    • Custom Properties
    • Tags
      • Custom Tags
      • PII Identifier
      • Verified Identifier
    • Import and Export Resources
    • Related Resources
  • User Management
    • Roles
    • Teams
    • Groups
  • Integrations
    • Integration Settings
    • Data Warehouses
      • BigQuery
        • BigQuery Metadata Extracted
      • Databricks
        • Databricks Metadata Extracted
      • Redshift
        • Redshift Metadata Extracted
      • Snowflake
        • Snowflake Metadata Extracted
        • Snowflake Costs
        • Snowflake Native App
      • Apache Hive
        • Apache Hive Metadata Extracted
      • Azure Synapse
        • Azure Synapse Metadata Extracted
      • MotherDuck
        • MotherDuck Metadata Extracted
      • ClickHouse
        • ClickHouse Metadata Extracted
    • Databases
      • Druid
        • Druid Metadata Extracted
      • MySQL
        • MySQL Metadata Extracted
      • Microsoft SQL Server
        • Page
        • Microsoft SQL Server Metadata Extracted
      • Oracle
        • Oracle Metadata Extracted
      • Salesforce
        • Salesforce Metadata Extracted
      • Postgres
        • Postgres Metadata Extracted
      • MongoDB
        • MongoDB Metadata Extracted
      • Azure Cosmos DB
        • Azure Cosmos DB Metadata Extracted
      • SingleStore
        • SingleStore Metadata Extracted
      • DynamoDB
        • DynamoDB Metadata Extracted
    • Data Visualization Tools
      • Amplitude
        • Amplitude Metadata Extracted
      • Looker
        • Looker Metadata Extracted
      • Looker Studio
        • Looker Studio Metadata Extracted
      • Metabase
        • Metabase Metadata Extracted
      • Mixpanel
        • Mixpanel Metadata Extracted
      • Mode
        • Mode Metadata Extracted
      • Power BI
        • Power BI Metadata Extracted
      • QuickSight
        • QuickSight Metadata Extracted
      • Retool
        • Retool Metadata Extracted
      • Redash
        • Redash Metadata Extracted
      • Sigma
        • Sigma Metadata Extracted
      • Tableau
        • Tableau Metadata Extracted
      • ThoughtSpot
        • ThoughtSpot Metadata Extracted
      • Cluvio
        • Cluvio Metadata Extracted
      • Hashboard
        • Hashboard Metadata Extracted
      • Lightdash
        • Lightdash Metadata Extracted
      • Preset
        • Preset Metadata Extracted
      • Superset
        • Superset Metadata Extracted
      • SQL Server Reporting Services
        • SQL Server Reporting Services Metadata Extracted
      • Hex
        • Hex Metadata Extracted
      • Omni
        • Omni Metadata Extracted
    • Data Pipeline Tools
      • Census
        • Census Metadata Extracted
      • Stitch
        • Stitch Metadata Extracted
      • Airflow
        • Airflow Metadata Extracted
      • Dagster
        • Dagster Metadata Extracted
      • Fivetran
        • Fivetran Metadata Extracted
      • Glue
        • Glue Metadata Extracted
      • Hightouch
        • Hightouch Metadata Extracted
      • Apache Kafka
        • Apache Kafka Metadata Extracted
      • Confluent Cloud
        • Confluent Cloud Metadata Extracted
      • Polytomic
        • Polytomic Metadata Extracted
      • Matillion
        • Matillion Metadata Extracted
      • Airbyte
        • Airbyte Extracted Metadata
      • Informatica
        • Informatica Metadata Extracted
      • Azure Data Factory
        • Azure Data Factory Metadata Extracted
    • Data Transformation Tools
      • dbt
        • dbt Cloud
          • dbt Cloud Metadata Extracted
        • dbt Core
          • dbt Core Metadata Extracted
      • Coalesce
        • Coalesce Metadata Extracted
    • Data Quality Tools
      • Cyera
      • Dataplex
        • Dataplex Metadata Extracted
      • Great Expectations
        • Great Expectations Metadata Extracted
      • Monte Carlo
        • Monte Carlo Metadata Extracted
      • Soda
        • Soda Metadata Extracted
    • Data Lakes
      • Google Cloud Storage
        • GCS Metadata Extracted
      • AWS S3
        • S3 Metadata Extracted
    • Query Engines
      • Trino
        • Trino Metadata Extracted
    • Custom Integrations
      • File Upload
        • CSV File Format
        • JSONL File Format
        • Maintain your Resources
      • Marketplace
        • Secoda SDK
        • Upload and Connect your Marketplace Integration
        • Publish the Integration
        • Example Integrations
      • Secoda Fields Explained
    • Security
      • Connecting via Reverse SSH Tunnel
      • Connecting via SSH Tunnel
      • Connecting via VPC Peering
      • Connecting via AWS Cross Account Role
      • Connecting via AWS PrivateLink
        • Snowflake via AWS PrivateLink
        • AWS Service via AWS PrivateLink
      • Recommendations to Improve SSH Tunnel Concurrency on SSH Bastion
    • Push Metadata to Source
  • Extensions
    • Chrome
    • Confluence
      • Confluence Metadata Extracted
      • Confluence best practices
    • Git
    • GitHub
    • Jira
      • Jira Metadata Extracted
    • Linear
    • Microsoft Teams
    • PagerDuty
    • Slack
      • Slack user guide
  • Features
    • Access Requests
    • Activity Log
    • Analytics
    • Announcements
    • Audit Log
    • Automations
      • Automations Use Cases
    • Archive
    • Bookmarks
    • Catalog
    • Collections
    • Column Profiling
    • Data Previews
    • Data Quality Score
    • Documents
      • Comments
      • Embeddings
    • Filters
    • Glossary
    • Homepage
    • Inbox
    • Lineage
      • Manual Lineage
    • Metrics
    • Monitors
      • Monitoring Use Cases
    • Notifications
    • Policies
    • Popularity
    • Publishing
    • Queries
      • Query Blocks
        • Chart Blocks
      • Extracted Queries
    • Questions
    • Search
    • Secoda AI
      • Secoda AI User Guide
      • Secoda AI Use Cases
      • Secoda AI Security FAQs
      • Prompts
    • Sharing
    • Views
  • Enterprise
    • SAML
      • Okta SAML
      • OneLogin SAML
      • Microsoft Azure AD SAML
      • Google SAML
      • SCIM
      • SAML Attributes
    • Self-Hosted
      • Additional Resources
        • Additional Environment Variables
          • PowerBI OAuth Application (on-premise)
          • Google OAuth Application (on-premise)
          • Github Application (on-premise)
          • OpenAI API Key Creation (on-premise)
          • AWS Bucket with Access Keys (on-premise)
        • TLS/SSL (Docker compose)
        • Automatic Updates (Docker compose)
        • Backups (Docker compose)
        • Outbound Connections
      • Self-Hosted Changelog
    • SIEM
      • Google Chronicle
  • API
    • Get Started
    • Authentication
    • Example Workflows
    • API Reference
      • Getting Started
      • Helpful Information
      • Audit Logs
      • Charts
      • Collections
      • Columns
      • Custom Properties
      • Dashboards
      • Databases
      • Documents
      • Events
      • Groups
      • Integrations
      • Lineage
      • Monitors
      • Resources
      • Schemas
      • Tables
      • Tags
      • Teams
      • Users
      • Questions
      • Queries
      • Getting Started
      • Helpful Information
      • Audit Logs
      • Charts
      • Collections
      • Columns
      • Custom Properties
      • Dashboards
      • Databases
      • Documents
      • Events
      • Groups
      • Integrations
      • Lineage
      • Monitors
      • Resources
      • Schemas
      • Tables
      • Tags
      • Teams
      • Users
      • Questions
      • Queries
  • FAQ
  • Policies
    • Terms of Use
    • Secoda AI Terms
    • Master Subscription Agreement
    • Privacy Policy
    • Security Policy
    • Accessibility Statement
    • Data Processing Agreement
    • Subprocessors
    • Service Level Agreement
    • Bug Bounty Program
  • System Status
  • Changelog
Powered by GitBook
On this page

Was this helpful?

  1. API
  2. API Reference

Users

Was this helpful?

Members within the workspace. Learn more about user management .

here

Get User

get

Get a user by their ID.

Authorizations
Path parameters
idstringRequired

The ID of the user to retrieve.

Example: 3131f219-16bb-4c95-853a-894ae12db42a
Responses
200
OK
application/json
404
Not Found
500
Internal Server Error
get
GET /user/{id} HTTP/1.1
Host: api.secoda.co
Authorization: Bearer string
Accept: */*
{
  "id": "3131f219-16bb-4c95-853a-894ae12db42a",
  "first_name": "Sample",
  "last_name": "User",
  "email": "sample@sample.com",
  "role": "editor",
  "workspace_id": "f71585fa-251c-4102-8d81-c97c57c8d435",
  "profile_picture": "image.jpg",
  "pending": "False",
  "user_groups": [
    "f71585fa-251c-4102-8d81-c97c57c8d435"
  ],
  "bookmarks": [
    "f71585fa-251c-4102-8d81-c97c57c8d435"
  ],
  "workspace": "f71585fa-251c-4102-8d81-c97c57c8d435",
  "is_service_account": false,
  "service_account_count_popularity": true,
  "last_login": "None",
  "new_feature_acknowledged": true,
  "disabled": false
}

Delete User

delete

Delete a user by their ID.

Authorizations
Path parameters
idstringRequired

The ID of the user to delete.

Example: 3131f219-16bb-4c95-853a-894ae12db42a
Responses
204
No Content
404
Not Found
500
Internal Server Error
delete
DELETE /user/{id} HTTP/1.1
Host: api.secoda.co
Authorization: Bearer string
Accept: */*

No content

  • GETList Users
  • POSTCreate User
  • GETGet User
  • DELETEDelete User
  • PATCHUpdate User

List Users

get

Get a list of users.

Authorizations
Responses
200
List of users.
application/json
Responseall of
400
Bad Request
500
Internal Server Error
get
GET /user HTTP/1.1
Host: api.secoda.co
Authorization: Bearer string
Accept: */*
{
  "links": {
    "next": "https://api.secoda.co/resource/all/?page=2",
    "previous": "None"
  },
  "meta": {
    "page": 1,
    "previous_page": "None",
    "next_page": 2
  },
  "count": 315,
  "total_pages": 7,
  "results": [
    {
      "id": "3131f219-16bb-4c95-853a-894ae12db42a",
      "first_name": "Sample",
      "last_name": "User",
      "email": "sample@sample.com",
      "role": "editor",
      "workspace_id": "f71585fa-251c-4102-8d81-c97c57c8d435",
      "profile_picture": "image.jpg",
      "pending": "False",
      "user_groups": [
        "f71585fa-251c-4102-8d81-c97c57c8d435"
      ],
      "bookmarks": [
        "f71585fa-251c-4102-8d81-c97c57c8d435"
      ],
      "workspace": "f71585fa-251c-4102-8d81-c97c57c8d435",
      "is_service_account": false,
      "service_account_count_popularity": true,
      "last_login": "None",
      "new_feature_acknowledged": true,
      "disabled": false
    }
  ]
}

Create User

post

Create a new user in the workspace.

Authorizations
Body
first_namestringOptional

Indicates the first name of the user.

Example: Sample
last_namestringOptional

Indicates the last name of the user.

Example: User
emailstringOptional

Indicates the email id of the user.

Example: sample@sample.com
rolestringOptional

Indicates the role of the user. Values can be - Admin Editor Viewer Guest

Example: editor
teamsstring[]Optional

List of team IDs (optional). It is mandatory if the role is guest.

Example: ["33733f42-8ff7-460b-9e20-50a2133d3bb0","c90dedee-40ee-47ec-9c27-96dc3b2ec363"]
user_groupsstring[]Optional

List of group IDs (optional)

Example: ["33733f42-8ff7-460b-9e20-50a2133d3bb0","c90dedee-40ee-47ec-9c27-96dc3b2ec363"]
Responses
201
Created
application/json
400
Bad Request
500
Internal Server Error
post
POST /user HTTP/1.1
Host: api.secoda.co
Authorization: Bearer string
Content-Type: application/json
Accept: */*
Content-Length: 268

{
  "first_name": "Sample",
  "last_name": "User",
  "email": "sample@sample.com",
  "role": "editor",
  "teams": [
    "33733f42-8ff7-460b-9e20-50a2133d3bb0",
    "c90dedee-40ee-47ec-9c27-96dc3b2ec363"
  ],
  "user_groups": [
    "33733f42-8ff7-460b-9e20-50a2133d3bb0",
    "c90dedee-40ee-47ec-9c27-96dc3b2ec363"
  ]
}
{
  "id": "3131f219-16bb-4c95-853a-894ae12db42a",
  "first_name": "Sample",
  "last_name": "User",
  "email": "sample@sample.com",
  "role": "editor",
  "workspace_id": "f71585fa-251c-4102-8d81-c97c57c8d435",
  "profile_picture": "image.jpg",
  "pending": "False",
  "user_groups": [
    "f71585fa-251c-4102-8d81-c97c57c8d435"
  ],
  "bookmarks": [
    "f71585fa-251c-4102-8d81-c97c57c8d435"
  ],
  "workspace": "f71585fa-251c-4102-8d81-c97c57c8d435",
  "is_service_account": false,
  "service_account_count_popularity": true,
  "last_login": "None",
  "new_feature_acknowledged": true,
  "disabled": false
}

Update User

patch

Use this endpoint to update the user. Editable fields include the first name, last name, and role.

Authorizations
Path parameters
idstringRequired

The ID of the user to update.

Example: 3131f219-16bb-4c95-853a-894ae12db42a
Body
first_namestringOptional

Indicates the first name of the user.

Example: Sample
last_namestringOptional

Indicates the last name of the user.

Example: User
Responses
200
User updated successfully
application/json
400
Bad Request
404
User not found
500
Internal Server Error
patch
PATCH /user/{id} HTTP/1.1
Host: api.secoda.co
Authorization: Bearer string
Content-Type: application/json
Accept: */*
Content-Length: 42

{
  "first_name": "Sample",
  "last_name": "User"
}
{
  "id": "3131f219-16bb-4c95-853a-894ae12db42a",
  "first_name": "Sample",
  "last_name": "User",
  "email": "sample@sample.com",
  "role": "editor",
  "workspace_id": "f71585fa-251c-4102-8d81-c97c57c8d435",
  "profile_picture": "image.jpg",
  "pending": "False",
  "user_groups": [
    "f71585fa-251c-4102-8d81-c97c57c8d435"
  ],
  "bookmarks": [
    "f71585fa-251c-4102-8d81-c97c57c8d435"
  ],
  "workspace": "f71585fa-251c-4102-8d81-c97c57c8d435",
  "is_service_account": false,
  "service_account_count_popularity": true,
  "last_login": "None",
  "new_feature_acknowledged": true,
  "disabled": false
}