team_admin_account_operations.yaml

openapi: 3.0.0
info:
  title: Account Operations - Team admin
  description: >-
    The official SeaTable API Reference (OpenAPI 3.0).
  version: "4.3"
servers:
  - url: "https://{server}"
    variables:
      server:
        default: cloud.seatable.io

x-readme:
  explorer-enabled: true
  metrics-enabled: false
  proxy-enabled: false

# the error messages, if query params are missing, are strange and misleading.

components:
  securitySchemes:
    AccountTokenAuth:
      type: http
      scheme: bearer
      description: This is the [Account-Token](/reference/authentication).

  parameters:
    #=======================Query parameters=======================#
    page:
      name: page
      description: The page number you want to start showing the entries. If no value is provided, 1 will be used.
      in: query
      schema:
        type: integer
        minimum: 1
      example: 1
      required: false
    per_page:
      name: per_page
      in: query
      schema:
        type: integer
        minimum: 1
      description: The number of results that should be returned. If no value is provided, 25 results will be returned.
      example: 25
      required: false
    query_base_name:
      name: query
      in: query
      schema:
        type: string
      description: Exact name or a part of the name of the base, case insensitive.
      example: "Example"
    ignore_asset:
      name: ignore_asset
      in: query
      schema:
        type: boolean
      example: "false"
      description: Set this to `true` to export the base without assets. Default is `false`.

    #=======================Path parameters=======================#
    org_id:
      name: org_id
      in: path
      schema:
        type: integer
        minimum: 1
      required: true
      description: >-
        The ID of your team/organization. Numeric. Get it from [Get Team](/reference/get-team-info). Contact your team admin, if you
        are not the admin.
      example: 1
    base_id:
      name: base_id
      in: path
      schema:
        type: string
      required: true
      description: The ID of the base. Don't mix this up with the base_uuid!
      example: "000"
    base_uuid:
      name: base_uuid
      in: path
      schema:
        type: string
        pattern: '^[0-9a-fA-F]{8}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{12}$'
      required: true
      description: The unique identifier of a base. Sometimes also called dtable_uuid.
      example: 5c264e76-0e5a-448a-9f34-580b551364ca
    external_link_token:
      name: external_link_token
      in: path
      schema:
        type: string
        pattern: "^[0-9a-f]{20}$"
      required: true
      example: "d6d006b319ca4d2aa060"
    view_external_link_token:
      name: view_external_link_token
      in: path
      schema:
        type: string
        pattern: "^[0-9a-f]{20}$"
      required: true
      example: "d6d006b319ca4d2aa060"
    invite_link_token:
      name: invite_link_token
      in: path
      schema:
        type: string
        pattern: "^[0-9a-f]{20}$"
      required: true
      example: "0366b8995d7f47d8eu3t"
    group_id:
      name: group_id
      in: path
      schema:
        type: integer
        minimum: 1
      required: true
      description: >-
        The ID of the group to query. Can be retrieved from the call [List Groups in Your Team](/reference/list-groups-team).
      example: "1"
    user_id:
      name: user_id
      description: The unique user id in the form ...@auth.local. This is not the email address of the user.
      in: path
      schema:
        type: string
        pattern: "^[a-f0-9]{32}(@auth.local)$"
      required: true
      example: 123456789f1e4c8d8e1c31415867317c@auth.local

  schemas:
    permission:
      type: string
      enum: ["", "r", "rw"]
    password:
      type: string
      description: User's password to login.
      example: "pw12345678"
    expire_days:
      type: integer
      example: 20
    group_name:
      type: string
      description: The name of the group.
      example: "Sample Group"
      required:
        - group_name
    group_owner:
      type: string
      description: >-
        The `user_id` of the owner of the group. Optional. If left
        blank, the newly added group will not be visible to anyone
        but still operatable.
      example: "123abc456def789ghi123jkl456mno789@auth.local"
    user_id:
      type: string
      description: The `user_id`
      example: "123abc456def789ghi123jkl456mno789@auth.local"
    user_ids:
      type: string
      example: "123abc456def789ghi123jkl456mno789@auth.local, mno789ghi123jkl456mno789pqr123stu@auth.local"
    email:
      type: string
      description: User's contact email to login.
      example: mai@example.com
    name:
      type: string
      description: User's full name.
      example: Mai Thai
    contact_email:
      type: string
      description: User's contact email.
      example: mai@example.com
    is_active:
      type: boolean
      description: Determines the current status of this account. An inactive account can not login anymore.
    is_staff:
      type: boolean
      description: Determines if the user account has access to the system administration area.
    with_workspace:
      type: boolean
      description: >-
        If a workspace should be automatically created for the user.
        Optional. `false` by default.
      example: "true"
    id_in_org:
      type: string
      description: >-
        The team ID of the user, could be a student's ID or employee
        ID. String.
      example: Student001
    quota_total:
      type: integer
      description: Update their total quota in MB.
      example: "3"
    group_id:
      type: string
      description: The ID of the group you'd like to move.
      example: "1"
    anchor_group_id:
      type: string
      description: >-
        The ID of the group where you'd like your group to be moved
        under.
      example: "1"
    to_last:
      type: boolean
      description: >-
        Whether you'd like to move your group to the bottom of the
        list (`true`). `false` by default.
      example: "true"
    enable_force_2fa:
      type: boolean
      description: >-
        if the 2-factor-authentication is forced (`true` or
        `false`).
      example: "true"
    enable_new_user_email:
      type: boolean
      description: >-
        if newly added users will get a system email (`true` or
        `false`).
      example: "true"
    enable_external_user_access_invite_link:
      type: boolean
      description: >-
        if external users can access bases via invite links (`true`
        or `false`).
      example: "false"
    enable_member_modify_name:
      type: boolean
      description: >-
        if members are allowed to change their names (`true` or
        `false`).
      example: "false"
    upload_file:
      type: object
      properties:
        file:
          type: string
          description: >-
            The image you'd like to upload from your local drive. Only .jpg, .jpeg, .gif or .png are allowed.
          format: binary
    new_org_name:
      type: string
      description: The new name of your team.
      example: SeaTable GmbH
    force_2fa:
      type: integer
      enum: [0, 1]
    metadata_url:
      type: string
      description: "URL pointing to the metadata of your Identity Provider (IdP)."
      example: "https://<URL-of-your-idp>/metadata.yml"
    domain:
      type: string
      description: "Domain that should be connected to your SeaTable Team. Only email addresses with this domain will be redirected to your Identity Provider (IdP)."
      example: "example.com"
    idp_certificate:
      type: string
      description: "Provide the certificate from your IdP for this service."
      example: "-----BEGIN CERTIFICATE-----xxxxxxxxxxxxxxxxxxxx-----END CERTIFICATE-----"

paths:
  # Users
  /api/v2.1/org/{org_id}/admin/users/:
    get:
      tags:
        - Users
      summary: List Users (Team)
      description: List all the users in the organization, or only the admins/non-admins.
      security:
        - AccountTokenAuth: []
      parameters:
        - $ref: "#/components/parameters/page"
        - $ref: "#/components/parameters/per_page"
        - $ref: "#/components/parameters/org_id"
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
              example:
                user_list:
                  - email: 1234567a6569491ba42905bf1647fd3f@auth.local
                    name: Jasmin Tee
                    contact_email: jasmin@example.com
                    quota_usage: 0
                    quota_total: -2
                    id_in_org: ""
                    last_login: "2021-03-02T12:58:29+00:00"
                    id: 123
                    is_active: true
                    ctime: "2020-11-18T12:30:31+00:00"
                    self_usage: 0
                    quota: -2
                    is_org_admin: true
    post:
      tags:
        - Users
      summary: Add User
      description: >-
        Add a new user in the team (organization).


        In the request body, define the new user's `email`, `name` and
        `password`. 


        SeaTable does not automatically create a workspace for a newly added
        user: the `with_workspace` parameter is `false` by default. If you would
        like your new user to have a workspace when they are added (so that they
        can start operating workspaces and bases right away with API requests),
        make sure you set `true` for this parameter.


        Otherwise, their workspace will only be created when they login to the
        SeaTable web interface for the first time.
      requestBody:
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                email:
                  $ref: "#/components/schemas/email"
                name:
                  $ref: "#/components/schemas/name"
                password:
                  $ref: "#/components/schemas/password"
                with_workspace:
                  $ref: "#/components/schemas/with_workspace"
      security:
        - AccountTokenAuth: []
      parameters:
        - $ref: "#/components/parameters/org_id"
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
              example:
                id: 125
                is_active: true
                ctime: "2021-03-02T13:02:46+00:00"
                name: Mai Thai
                email: 12345671bc384ab2b7adbec984948390@auth.local
                contact_email: mai@example.com
                last_login: null
                self_usage: 0
                quota: -2
                workspace_id: 999

  /api/v2.1/org/{org_id}/admin/users/{user_id}/:
    put:
      tags:
        - Users
      summary: Update User
      description: >-
        Update a user's details. See the parameter list for the detailed
        description of each entry.
      requestBody:
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                name:
                  $ref: "#/components/schemas/name"
                contact_email:
                  $ref: "#/components/schemas/contact_email"
                is_staff:
                  $ref: "#/components/schemas/is_staff"
                is_active:
                  $ref: "#/components/schemas/is_active"
                quota_total:
                  $ref: "#/components/schemas/quota_total"
                id_in_org:
                  $ref: "#/components/schemas/id_in_org"
      security:
        - AccountTokenAuth: []
      parameters:
        - $ref: "#/components/parameters/org_id"
        - $ref: "#/components/parameters/user_id"
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
              example:
                email: 23456789d1754bb4afa2c2cb7369d244@auth.local
                name: Stefan
                contact_email: test999@fun-mail.net
                quota_usage: 144328135
                quota_total: 3000000
                is_active: true
                id: 253
                ctime: "2020-11-18T12:43:22+00:00"
                id_in_org: Student001
                last_login: "2022-03-26T15:38:18+00:00"
                self_usage: 144328135
                quota: 3000000
    delete:
      tags:
        - Users
      summary: Delete User
      description: >-
        Delete a user by their `user_id` permanently. When you delete a user,
        their bases are automatically moved into the organization's trash bin.
      security:
        - AccountTokenAuth: []
      parameters:
        - $ref: "#/components/parameters/org_id"
        - $ref: "#/components/parameters/user_id"
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
              example:
                success: true
  /api/v2.1/org/{org_id}/admin/users/{user_id}/set-password/:
    put:
      tags:
        - Users
      summary: Reset User Password
      description: >-
        Reset the password of a user and get a new password. The new password
        will be automatically sent to the user per email.
      security:
        - AccountTokenAuth: []
      parameters:
        - $ref: "#/components/parameters/org_id"
        - $ref: "#/components/parameters/user_id"
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
              example:
                new_password: 4nhCOEU3fl
  /api/v2.1/org/{org_id}/admin/users/{user_id}/two-factor-auth/:
    put:
      tags:
        - Users
      summary: Enforce 2FA
      description: >-
        As the team administrator, you can force each team member to use
        2-factor authentication (2FA).


        When the value of `force_2fa` is `1` in this request, the member will be
        requested to activate 2FA by scanning a QR code next time they log in.
        To cancel enforcing them to use 2FA, change the value to `0` and send
        this request again.


        This request is to be distinguished from the next request, because
        cancelling the enforcement doesn't necesssarily [Disable 2FA for A User
        in Team](/reference/team-admin-users-disable-2fa), which serves a different purpose.
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                force_2fa:
                  $ref: "#/components/schemas/force_2fa"
      security:
        - AccountTokenAuth: []
      parameters:
        - $ref: "#/components/parameters/org_id"
        - $ref: "#/components/parameters/user_id"
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
              example:
                success: true
    delete:
      tags:
        - Users
      summary: Disable 2FA
      description: >-
        If a user in your team has lost their phone or deleted the authenticator
        App by accident, they cannot log in to SeaTable anymore if 2FA is
        enabled for them. In this case, you as the team administrator can
        disable 2FA for them.

        Again, this is to be distinguished from the request [Enforce 2FA for A
        User in Team](/reference/team-admin-users-enforce-2fa) when you use `force_2fa = 0`, which only cancels the
        enforcement of 2FA but doesn't necessarily disable it for them.
      security:
        - AccountTokenAuth: []
      parameters:
        - $ref: "#/components/parameters/org_id"
        - $ref: "#/components/parameters/user_id"
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
              example:
                success: true

  # Bases
  /api/v2.1/org/{org_id}/admin/dtables/:
    get:
      tags:
        - Bases
      summary: List Bases (Team)
      description: >-
        List all the bases in the current organization.


        The returned `id` value is the ID of the base, to be distinguished from
        the base's `base_uuid`. Details see the **SeaTable API Parameter
        Reference**.
      security:
        - AccountTokenAuth: []
      parameters:
        - $ref: "#/components/parameters/page"
        - $ref: "#/components/parameters/per_page"
        - $ref: "#/components/parameters/org_id"
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
              example:
                dtable_list:
                  - id: 158
                    workspace_id: 304
                    uuid: 12345678-7e27-46a8-8b18-6cc6f3db2057
                    name: Test base
                    creator: Jasmin Tee
                    modifier: Jasmin Tee
                    created_at: "2020-11-18T12:31:29+00:00"
                    updated_at: "2021-03-02T10:29:03+00:00"
                    color: null
                    text_color: null
                    icon: null
                    owner: Jasmin Tee
                    rows_count: 72
                  - id: 160
                    workspace_id: 305
                    uuid: 87654321-d895-402f-9718-a85f26c65d99
                    name: Project Tracker
                    creator: Jasmin Tee
                    modifier: Jasmin Tee
                    created_at: "2020-11-18T12:45:06+00:00"
                    updated_at: "2020-11-18T12:45:06+00:00"
                    color: null
                    text_color: null
                    icon: null
                    owner: testgroup (group)
                    rows_count: 46
                count: 16
  /api/v2.1/org/{org_id}/admin/dtables/{base_id}/:
    delete:
      tags:
        - Bases
      summary: Delete Base
      description: >-
        Delete a base. This base will be put into the organization's trash bin,
        and permanently deleted automatically after 30 days.
      security:
        - AccountTokenAuth: []
      parameters:
        - $ref: "#/components/parameters/org_id"
        - $ref: "#/components/parameters/base_id"
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
              example:
                success: true
  /api/v2.1/org/{org_id}/admin/trash-dtables/:
    get:
      tags:
        - Bases
      summary: List Trash Bases
      description: List the bases in the organization's trash bin.
      security:
        - AccountTokenAuth: []
      parameters:
        - $ref: "#/components/parameters/page"
        - $ref: "#/components/parameters/per_page"
        - $ref: "#/components/parameters/org_id"
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
              example:
                dtable_list:
                  - id: 135
                    workspace_id: 304
                    uuid: 98765432-6db6-4950-abb9-28832c7471a0
                    name: Old data
                    creator: Jasmin Tee
                    modifier: Jasmin Tee
                    created_at: "2020-12-28T18:04:05+00:00"
                    updated_at: "2020-12-28T18:04:05+00:00"
                    color: null
                    text_color: null
                    icon: null
                    deleted: true
                    delete_time: "2021-03-02T10:40:44+00:00"
                    owner: Jasmin Tee
                count: 1
    delete:
      tags:
        - Bases
      summary: Clear Team Trash Bin
      description: >-
        Clear the team trash bin. All the bases there will be removed
        permanently and cannot be restored any more.
      security:
        - AccountTokenAuth: []
      parameters:
        - $ref: "#/components/parameters/org_id"
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
              example:
                success: true
  /api/v2.1/org/{org_id}/admin/trash-dtables/{base_id}/:
    put:
      tags:
        - Bases
      summary: Restore Base from Trash
      description: Restore a base from the trash bin.
      security:
        - AccountTokenAuth: []
      parameters:
        - $ref: "#/components/parameters/org_id"
        - $ref: "#/components/parameters/base_id"
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
              example:
                success: true
  /api/v2.1/org/{org_id}/admin/search-dtables/:
    get:
      tags:
        - Bases
      summary: Search Base
      description: >-
        By giving the exact or fuzzy match of the name of a base, you can find a
        base or all the bases that fit to that search criteria. The search is
        case-insensitive.
      security:
        - AccountTokenAuth: []
      parameters:
        - $ref: "#/components/parameters/query_base_name"
        - $ref: "#/components/parameters/org_id"
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
              example:
                results:
                  - id: 724
                    workspace_id: 204
                    uuid: 12345678-ba46-4c07-8116-d237bdeb35a3
                    name: Termine
                    created_at: "2022-01-12T10:30:01+00:00"
                    updated_at: "2022-03-11T12:02:22+00:00"
                    color: "#972CB0"
                    text_color: null
                    icon: icon-leave-record
                    is_encrypted: false
                    org_id: 176
                    email: 876543216569491ba42905bf1647fd3f@auth.local
                    group_id: -1
                    owner: Michael Jackson
                    owner_deleted: false
                    rows_count: 23

  # Groups
  /api/v2.1/org/{org_id}/admin/groups/:
    get:
      tags:
        - Groups
      summary: List Groups (Team)
      description: >-
        List all the groups existing in your team (organization). In the
        response, each group's ID, name, created time, name,creator etc. are
        returned. The `page_next` value indicates if there is a next page or
        not.
      security:
        - AccountTokenAuth: []
      parameters:
        - $ref: "#/components/parameters/page"
        - $ref: "#/components/parameters/per_page"
        - $ref: "#/components/parameters/org_id"
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
              example:
                groups:
                  - id: 51
                    group_name: Sales Group
                    ctime: "2020-11-19T08:14:52+00:00"
                    creator_name: Michael Jackson
                    creator_email: 876543216569491ba42905bf1647fd3f@auth.local
                    creator_contact_email: michael@example.com
                    size: 98842
                  - id: 52
                    group_name: Marketing Group
                    ctime: "2020-11-19T08:18:03+00:00"
                    creator_name: Ginger Ale
                    creator_email: 12345678d1754bb4afa2c2cb7369d244@auth.local
                    creator_contact_email: ginger@example.com
                    size: 162010
                page: 1
                per_page: 2
                page_next: true
    post:
      tags:
        - Groups
      summary: Add Group
      description: >-
        Add a group in the current organization and assign a group name, and a
        group owner.
      requestBody:
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                group_name:
                  $ref: "#/components/schemas/group_name"
                group_owner:
                  $ref: "#/components/schemas/group_owner"
      security:
        - AccountTokenAuth: []
      parameters:
        - $ref: "#/components/parameters/org_id"
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
              example:
                id: 3
                group_name: Test group
                ctime: "2021-03-02T11:10:53+00:00"
                creator_email: 1234567a6569491ba42905bf1647fd3f@auth.local
                creator_name: Jasmin Tee
                creator_contact_email: jasmin@example.com
  /api/v2.1/org/{org_id}/admin/groups/{group_id}/:
    get:
      tags:
        - Groups
      summary: Get Group
      description: Get the specific information of one group by its ID.
      security:
        - AccountTokenAuth: []
      parameters:
        - $ref: "#/components/parameters/org_id"
        - $ref: "#/components/parameters/group_id"
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
              example:
                id: 1
                group_name: Test Group
                ctime: "2020-11-19T08:14:52+00:00"
                creator_email: 876543216569491ba42905bf1647fd3f@auth.local
                creator_name: Michael Jackson
                creator_contact_email: michael@example.com
    put:
      tags:
        - Groups
      summary: Update Group
      description: >-
        Use this request to rename, and/or change owner of a group.

        In the request body, both parameters are optional. Only use the ones
        that you need to update:

        *   `new_owner` is the new owner of the group, include the user's ID
        here. If you don't want to change the owner, remove this parameter
        because if you enter the current owner's ID here, you'll get an error
        "User xxx is already group owner".

        *   `new_group_name` is the new name of your group. If you don't want to
        change the name, remove shi parameter because if you enter the current
        group name here you'll get an error "There is already a group with that
        name".
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                new_owner:
                  $ref: "#/components/schemas/user_id"
                new_group_name:
                  $ref: "#/components/schemas/group_name"
      security:
        - AccountTokenAuth: []
      parameters:
        - $ref: "#/components/parameters/org_id"
        - $ref: "#/components/parameters/group_id"
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
              example:
                id: 1
                group_name: Group New
                ctime: "2020-11-19T08:14:52+00:00"
                creator_email: 123abc456def789ghi123jkl456mno789@auth.local
                creator_name: Michael Jackson
                creator_contact_email: michael@example.com
                size: 98842
    delete:
      tags:
        - Groups
      summary: Delete Group
      description: Delete a group with its ID.
      security:
        - AccountTokenAuth: []
      parameters:
        - $ref: "#/components/parameters/org_id"
        - $ref: "#/components/parameters/group_id"
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
              example:
                success: true
  /api/v2.1/org/{org_id}/admin/groups/{group_id}/dtables/:
    get:
      tags:
        - Groups
      summary: List Group Bases
      description: List all the bases in a specific group in your team.
      security:
        - AccountTokenAuth: []
      parameters:
        - $ref: "#/components/parameters/org_id"
        - $ref: "#/components/parameters/group_id"
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
              example:
                tables:
                  - id: 4
                    workspace_id: 2
                    uuid: 12345678-30d9-48a2-a5d7-09cd8ffdda4b
                    name: CRM & Sales
                    creator: Ginger Ale
                    owner: Group New
                    creator_email: 12345678d1754bb4afa2c2cb7369d244@auth.local
                    modifier: Ginger Ale
                    created_at: "2021-03-08T13:04:50+00:00"
                    updated_at: "2021-03-08T13:04:50+00:00"
                    rows_count: 186
  /api/v2.1/groups/move-group/:
    put:
      tags:
        - Groups
      summary: Re-order Your Groups
      description: >-
        On the **web user interface**, you can have an overview of all the
        groups you are currently in on the left-hand side navigation when you
        click on "Bases".


        Perhaps you'd like to re-order these groups. Besides moving them
        manually with your mouse on the interface, you can also use this API
        request to do the same job.


        Here's how it works: In the request form, give the `group_id` of the
        group you'd like to move and tell the system where to move it to: under
        which group ( `anchor_group_id` ). If you are just moving it to the
        bottom of the list, let `to_last` be `true` .
      requestBody:
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                group_id:
                  $ref: "#/components/schemas/group_id"
                anchor_group_id:
                  $ref: "#/components/schemas/anchor_group_id"
                to_last:
                  $ref: "#/components/schemas/to_last"
      security:
        - AccountTokenAuth: []
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
              example:
                success: true
  /api/v2.1/org/{org_id}/admin/groups/{group_id}/members/:
    get:
      tags:
        - Groups
      summary: List Group Members
      description: List the members of a group in the current team (organization).
      security:
        - AccountTokenAuth: []
      parameters:
        - $ref: "#/components/parameters/org_id"
        - $ref: "#/components/parameters/group_id"
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
              example:
                group_id: 1
                group_name: Sample Group
                members:
                  - group_id: 1
                    name: Jasmin Tee
                    email: 123456786569491ba42905bf1647fd3f@auth.local
                    contact_email: jasmin@example.com
                    login_id: ""
                    avatar_url: https://cloud.seatable.io/media/avatars/default.png
                    is_admin: false
                    role: Member
                  - group_id: 1
                    name: Ginger Ale
                    email: 87654321d1754bb4afa2c2cb7369d244@auth.local
                    contact_email: ginger@example.com
                    login_id: ""
                    avatar_url: https://cloud.seatable.io/media/avatars/default.png
                    is_admin: true
                    role: Owner
    post:
      tags:
        - Groups
      summary: Add Group Members
      description: Add multiple members to a group in one call.
      requestBody:
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                user_id:
                  $ref: "#/components/schemas/user_id"
      security:
        - AccountTokenAuth: []
      parameters:
        - $ref: "#/components/parameters/org_id"
        - $ref: "#/components/parameters/group_id"
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
              example:
                failed:
                  - email: 123456786569491ba42905bf1647fd3f@auth.local
                    error_msg: User Jasmin Tee is already a group member.
                success:
                  - group_id: 1
                    name: Ginger Ale
                    email: 87654321d1754bb4afa2c2cb7369d244@auth.local
                    contact_email: ginger@example.com
                    login_id: ""
                    avatar_url: https://cloud.seatable.io/media/avatars/default.png
                    is_admin: false
                    role: Member
  /api/v2.1/org/{org_id}/admin/groups/{group_id}/members/{user_id}/:
    delete:
      tags:
        - Groups
      summary: Remove Group Members
      description: Move a member out of a group. The group's owner cannot be removed.
      security:
        - AccountTokenAuth: []
      parameters:
        - $ref: "#/components/parameters/org_id"
        - $ref: "#/components/parameters/group_id"
        - $ref: "#/components/parameters/user_id"
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
              example:
                success: true
  /api/v2.1/org/{org_id}/admin/dtables/{base_uuid}/shares:
    get:
      tags:
        - Bases
      summary: List Base Sharings
      description: >-
        Use this request to list all the users and groups that a base is being
        shared with.
      security:
        - AccountTokenAuth: []
      parameters:
        - $ref: "#/components/parameters/org_id"
        - $ref: "#/components/parameters/base_uuid"
      responses:
        "401":
          description: Successful response
          content:
            application/json: {}

  # Sharing Links
  /api/v2.1/org/{org_id}/admin/external-links/:
    get:
      tags:
        - Sharing Links
      summary: List Base External Links
      description: >-
        Use this request to list all the external links generated in the current
        team (organization).
      security:
        - AccountTokenAuth: []
      parameters:
        - $ref: "#/components/parameters/org_id"
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
              example:
                external_link_list:
                  - id: 98
                    url: >-
                      https://cloud.seatable.io/dtable/external-links/12345ef2395c415d9d13/
                    token: 12345ef2395c415d9d13
                    permission: read-only
                    creator_name: Michael Jackson
                    creator: 876543216569491ba42905bf1647fd3f@auth.local
                    view_cnt: 337
                    create_at: "2021-08-25T07:04:02+00:00"
                    from_dtable: All types
                    expire_date: ""
                    is_protected: false
                    from_base_uuid: abcdefg-fd55-48e4-8c4a-5fd6f2549765
                count: 5
  /api/v2.1/org/{org_id}/admin/external-links/{external_link_token}/:
    delete:
      tags:
        - Sharing Links
      summary: Delete External Link
      description: Delete an external link with its token.
      security:
        - AccountTokenAuth: []
      parameters:
        - $ref: "#/components/parameters/org_id"
        - $ref: "#/components/parameters/external_link_token"
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
              example:
                success: true
  /api/v2.1/org/{org_id}/admin/view-external-links/:
    get:
      tags:
        - Sharing Links
      summary: List View External Links
      description: >-
        Use this request to list all the view external links generated in the
        current team (organization).
      security:
        - AccountTokenAuth: []
      parameters:
        - $ref: "#/components/parameters/org_id"
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
              example:
                external_link_list:
                  - id: 25
                    from_dtable: Test Base
                    creator: 8e02ebc52ff0484d9f15b50904a98d2f@auth.local
                    creator_name: Jason
                    token: 20fcc48ea99a47459952
                    permission: r
                    create_at: "2021-03-30T09:30:36+00:00"
                    view_cnt: 0
                    table_id: "0000"
                    view_id: Dn16
                    url: >-
                      https://cloud.seatable.io/dtable/view-external-links/20fcc48ea99a47459952/
                    is_custom: false
                    expire_date: ""
                  - id: 26
                    from_dtable: Test Base
                    creator: 8e02ebc52ff0484d9f15b50904a98d2f@auth.local
                    creator_name: Jason
                    token: 6388e4fc44eb4296aa41
                    permission: r
                    create_at: "2021-03-30T09:30:49+00:00"
                    view_cnt: 0
                    table_id: "0000"
                    view_id: Dn16
                    url: >-
                      https://cloud.seatable.io/dtable/view-external-links/6388e4fc44eb4296aa41/
                    is_custom: false
                    expire_date: ""
                count: 2
  /api/v2.1/org/{org_id}/admin/view-external-links/{view_external_link_token}/:
    delete:
      tags:
        - Sharing Links
      summary: Delete View External Link
      description: >-
        Use this request to delete an existing view external link with its
        token.
      security:
        - AccountTokenAuth: []
      parameters:
        - $ref: "#/components/parameters/org_id"
        - $ref: "#/components/parameters/view_external_link_token"
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
              example:
                success: true
  /api/v2.1/org/{org_id}/admin/invite-links/:
    get:
      tags:
        - Sharing Links
      summary: List Invite Links
      description: >-
        As administrator of your team, you can use this request to gain a
        overview of all the invite links currently generated in your team,
        regardless which user or group.
      security:
        - AccountTokenAuth: []
      parameters:
        - $ref: "#/components/parameters/page"
        - $ref: "#/components/parameters/per_page"
        - $ref: "#/components/parameters/org_id"
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
              example:
                invite_link_list:
                  - dtable_name: All types
                    username: 876543216569491ba42905bf1647fd3f@auth.local
                    token: >-
                      https://cloud.seatable.io/dtable/links/9167cdbd67574226a72e
                    ctime: "2021-12-15T13:11:54.083636"
                    password: null
                    expire_date: null
                    permission: rw
                    workspace_id: 204
                  - dtable_name: All types
                    username: 876543216569491ba42905bf1647fd3f@auth.local
                    token: >-
                      https://cloud.seatable.io/dtable/links/b7ea0a4269234565998e
                    ctime: "2021-12-15T13:11:55.058965"
                    password: null
                    expire_date: null
                    permission: rw
                    workspace_id: 204
                count: 17
  /api/v2.1/org/{org_id}/admin/invite-links/{invite_link_token}/:
    put:
      tags:
        - Sharing Links
      summary: Update Invite Link
      description: "You as team admin can also update an invite link. In the request body:\r\n\r\n- `permission` is the read/write permission of the new invite link, with `r` as read-only and `rw` as read-and-write;\r\n- `password` is the new password of your invite link;\r\n- `expire_days` is the number of days after which the invite link will expire."
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                permission:
                  $ref: "#/components/schemas/permission"
                password:
                  $ref: "#/components/schemas/password"
                expire_days:
                  $ref: "#/components/schemas/expire_days"
      security:
        - AccountTokenAuth: []
      parameters:
        - $ref: "#/components/parameters/org_id"
        - $ref: "#/components/parameters/invite_link_token"
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
              example:
                username: 876543216569491ba42905bf1647fd3f@auth.local
                permission: rw
                token: 9167cdbd67574226a72e
                link: https://cloud.seatable.io/dtable/links/9167cdbd67574226a72e
                dtable: All types
                dtable_id: 2
                workspace_id: 2
                expire_date: ""
                ctime: "2021-12-15T13:11:54.083636"
    delete:
      tags:
        - Sharing Links
      summary: Delete Invite Link
      description: >-
        Delete an invite link with this request. The `invite_link_token` can be
        retrieved from the previous calls, or simply from the URL of the invite
        link, which is the last part of the URL.
      security:
        - AccountTokenAuth: []
      parameters:
        - $ref: "#/components/parameters/org_id"
        - $ref: "#/components/parameters/invite_link_token"
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
              example:
                success: true

  # Base Export (asynchron, deshalb bieten wir das nicht mehr an.)
  #/api/v2.1/org/{org_id}/admin/dtables/{base_uuid}/export-dtable/:
  #  get:
  #    tags: [Export]
  #    summary: Export base
  #    description: |
  #      Use this request to export a base as Team Admin.
  #    security:
  #      - AccountTokenAuth: []
  #    parameters:
  #      - $ref: "#/components/parameters/org_id"
  #      - $ref: "#/components/parameters/base_uuid"
  #      - $ref: "#/components/parameters/ignore_asset"
  #    responses:
  #      "200":
  #        description: OK

  # Info & Settings
  /api/v2.1/org/admin/info/:
    get:
      tags:
        - Info & Settings
      summary: Get Team Info
      description: >-
        Get the basic information (e.g. ID, name, storage quota etc. see example
        response for details) of your team (organization).
      security:
        - AccountTokenAuth: []
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
              example:
                org_id: 1
                org_name: SeaTable GmbH
                storage_quota: 300000000000
                storage_usage: 370721184
                member_quota: 20
                member_usage: 15
                active_members: 15
                row_usage: 6077
                row_total: -1
                role: org_enterprise
                big_data_row_limit: -1
                big_data_total_rows: 0
                big_data_total_storage: 0
                scripts_running_total: -1
                scripts_running_count: 0
    put:
      tags:
        - Info & Settings
      summary: Update Team
      description: Update the infos (e.g. name) of the organization
      requestBody:
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                new_org_name:
                  $ref: "#/components/schemas/new_org_name"
      security:
        - AccountTokenAuth: []
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
              example:
                success: true
  /api/v2.1/org/admin/settings/:
    get:
      tags:
        - Info & Settings
      summary: Get Team Settings
      description: >-
        List the current organization settings.


        **Return Values**


        `enable_force_2fa`: if the 2-factor-authentication is forced (`true` or
        `false`).


        `enable_new_user_email`: if newly added users will get a system email
        (`true` or `false`).


        `enable_external_user_access_invite_link`: if external users can access
        bases via invite links (`true` or `false`).


        `enable_member_modify_name`: if members are allowed to change their
        names (`true` or `false`).
      security:
        - AccountTokenAuth: []
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
              example:
                enable_force_2fa: false
                enable_new_user_email: true
                enable_external_user_access_invite_link: true
    put:
      tags:
        - Info & Settings
      summary: Update Team Settings
      description: Update the settings of the organization.
      requestBody:
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                enable_force_2fa:
                  $ref: "#/components/schemas/enable_force_2fa"
                enable_new_user_email:
                  $ref: "#/components/schemas/enable_new_user_email"
                enable_external_user_access_invite_link:
                  $ref: "#/components/schemas/enable_external_user_access_invite_link"
                enable_member_modify_name:
                  $ref: "#/components/schemas/enable_member_modify_name"
      security:
        - AccountTokenAuth: []
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
              example:
                enable_force_2fa: true
                enable_new_user_email: true
                enable_external_user_access_invite_link: false

  /api/v2.1/org/{org_id}/admin/admin-logs/:
    get:
      tags:
        - Activities & Logs
      summary: List Team Operations
      description: Retrieves the operation log of all team members.
      security:
        - AccountTokenAuth: []
      parameters:
        - $ref: "#/components/parameters/page"
        - $ref: "#/components/parameters/per_page"
        - $ref: "#/components/parameters/org_id"
      responses:
        "200":
          description: OK
          content:
            application/json:
              example:
                {
                  "logs":
                    [
                      {
                        "email": "145504ae043c438cbb55f2afb084d586@auth.local",
                        "name": "Hulk",
                        "operation": "group_delete",
                        "detail":
                          {
                            "id": 98,
                            "name": "wefwefadfadf",
                            "owner": "145504ae043c438cbb55f2afb084d586@auth.local",
                          },
                        "datetime": "2023-03-25T22:09:51+00:00",
                      },
                      {
                        "email": "145504ae043c438cbb55f2afb084d586@auth.local",
                        "name": "Hulk",
                        "operation": "group_create",
                        "detail":
                          {
                            "id": 98,
                            "name": "efaefafe",
                            "owner": "145504ae043c438cbb55f2afb084d586@auth.local",
                          },
                        "datetime": "2023-03-25T22:09:13+00:00",
                      },
                      {
                        "email": "145504ae043c438cbb55f2afb084d586@auth.local",
                        "name": "Hulk",
                        "operation": "user_add",
                        "detail":
                          {
                            "email": "wefafaef@example.local",
                            "username": "f7477ddd49ef46aea4bb09a0bc7d0b3b@auth.local",
                            "nickname": "Stefan",
                          },
                        "datetime": "2023-03-25T21:59:51+00:00",
                      },
                    ],
                  "total_count": 3,
                }
  /api/v2.1/org/{org_id}/admin/login-logs/:
    get:
      tags:
        - Activities & Logs
      summary: List Team Logins
      description: Retrieves the login activities of all team members.
      security:
        - AccountTokenAuth: []
      parameters:
        - $ref: "#/components/parameters/page"
        - $ref: "#/components/parameters/per_page"
        - $ref: "#/components/parameters/org_id"
      responses:
        "200":
          description: OK
          content:
            application/json:
              example:
                {
                  "login_list":
                    [
                      {
                        "login_time": "2023-11-22T09:36:29+01:00",
                        "login_ip": "5.34.111.3",
                        "login_success": true,
                        "email": "145504ae043c438cbb55f2afb084d586@auth.local",
                        "name": "Hulk",
                        "contact_email": "hulk@the-avengers.com",
                      },
                      {
                        "login_time": "2023-11-22T09:31:22+01:00",
                        "login_ip": "5.34.111.3",
                        "login_success": false,
                        "email": "145504ae043c438cbb55f2afb084d586@auth.local",
                        "name": "Hulk",
                        "contact_email": "hulk@the-avengers.com",
                      },
                      {
                        "login_time": "2023-11-21T23:27:12+01:00",
                        "login_ip": "99.12.23.13",
                        "login_success": true,
                        "email": "f2afb0145504ae0438cbb5584c43d586@auth.local",
                        "name": "Tony Starks",
                        "contact_email": "tony@the-avengers.com",
                      },
                    ],
                  "total_count": 70,
                }
  /api/v2.1/org/{org_id}/admin/login-logs/{user_id}:
    get:
      tags:
        - Activities & Logs
      summary: List User Logins
      description: Returns the login activities of one specific team member.
      security:
        - AccountTokenAuth: []
      parameters:
        - $ref: "#/components/parameters/page"
        - $ref: "#/components/parameters/per_page"
        - $ref: "#/components/parameters/org_id"
        - $ref: "#/components/parameters/user_id"
      responses:
        "200":
          description: OK
          content:
            application/json:
              example:
                {
                  "data":
                    [
                      {
                        "login_time": "2023-11-22T09:36:29+01:00",
                        "login_ip": "5.34.111.3",
                        "login_success": true,
                        "email": "145504ae043c438cbb55f2afb084d586@auth.local",
                        "name": "Hulk",
                        "contact_email": "hulk@the-avengers.com",
                      },
                      {
                        "login_time": "2023-11-22T09:31:22+01:00",
                        "login_ip": "5.34.111.3",
                        "login_success": false,
                        "email": "hulk@the-avengers.com",
                        "name": "hulk",
                        "contact_email": null,
                      },
                    ],
                  "total_count": 3,
                }
  /api/v2.1/org/{org_id}/admin/org-logo/:
    post:
      tags:
        - Customizing
      summary: Update Team Logo
      description: Replace the current team logo by uploading a new one.
      security:
        - AccountTokenAuth: []
      parameters:
        - $ref: "#/components/parameters/org_id"
      requestBody:
        content:
          multipart/form-data:
            schema:
              $ref: "#/components/schemas/upload_file"
      responses:
        "200":
          description: OK
          content:
            application/json:
              example:
                {
                  "logo_path": "avatars/org-logo/1/8b4d9bc0-96b3-4b36-bf53-2187b601dfac.png",
                }

    get:
      tags:
        - Customizing
      summary: Get Team Logo
      description: Get the path to the custom team logo.
      security:
        - AccountTokenAuth: []
      parameters:
        - $ref: "#/components/parameters/org_id"
      responses:
        "200":
          description: OK
          content:
            application/json:
              example:
                {
                  "logo_path": "avatars/org-logo/1/8b4d9bc0-96b3-4b36-bf53-2187b601dfac.png",
                }

    delete:
      tags:
        - Customizing
      summary: Delete Team Logo
      description: Restore the team logo to SeaTable's original default by removing the current logo."
      security:
        - AccountTokenAuth: []
      parameters:
        - $ref: "#/components/parameters/org_id"
      responses:
        "200":
          description: OK
          content:
            application/json:
              example: { "success": true }

  /api/v2.1/org/{org_id}/admin/saml-config/:
    get:
      tags:
        - SAML
      summary: Get SAML Config
      description: Retrieve the current configuration details of the team's SAML (Single Sign-On) account.
      security:
        - AccountTokenAuth: []
      parameters:
        - $ref: "#/components/parameters/org_id"
      responses:
        "200":
          description: OK
          content:
            application/json:
              example:
                {
                  "saml_config":
                    {
                      "id": 2,
                      "org_id": 13,
                      "metadata_url": "https://example.com/federationmetadata.xml",
                      "domain": example.com,
                      "dns_txt": "seatable-site-verification=bae21a5f9c65472c88bcd02f724065c8",
                      "domain_verified": true,
                      "idp_certificate",
                      "-----BEGIN CERTIFICATE-----xxxxxxxxxx-----END CERTIFICATE-----",
                    },
                }
        "403":
          description: "Forbidden"
          content:
            application/json:
              example:
                {
                  "detail": "You do not have permission to perform this action.",
                }
    put:
      tags: [SAML]
      summary: Update SAML Config
      description: Update the current team's SAML (Single Sign-On) account. You have to provide at least one of the parameter `metadata_url`, `domain` or `idp_certificate`.
      security:
        - AccountTokenAuth: []
      parameters:
        - $ref: "#/components/parameters/org_id"
      requestBody:
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                metadata_url:
                  $ref: "#/components/schemas/metadata_url"
                domain:
                  $ref: "#/components/schemas/domain"
                idp_certificate:
                  $ref: "#/components/schemas/idp_certificate"
      responses:
        "200":
          description: OK
          content:
            application/json:
              example:
                {
                  "saml_config":
                    {
                      "id": 2,
                      "org_id": 13,
                      "metadata_url": "https://example.com/federationmetadata.xml",
                      "domain": example.com,
                      "dns_txt": "seatable-site-verification=bae21a5f9c65472c88bcd02f724065c8",
                      "domain_verified": true,
                      "idp_certificate": "-----BEGIN CERTIFICATE-----xxxxxxxxxx-----END CERTIFICATE-----",
                    },
                }

  /api/v2.1/org/{org_id}/admin/verify-domain/:
    put:
      tags: [SAML]
      summary: Verify SAML domain
      description: Check for the "seatable-site-verification" value in the DNS entries of the selected domain.
      security:
        - AccountTokenAuth: []
      parameters:
        - $ref: "#/components/parameters/org_id"
      requestBody:
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                domain:
                  $ref: "#/components/schemas/domain"
      responses:
        "200":
          description: OK
          content:
            application/json:
              example: { "domain_verified": true }