mammoth-io Owner user control settings API

openapi: 3.2.0
info:
  title: Mammoth Io Owner user control settings API
  version: 0.1.0
  contact:
    name: Mammoth Analytics
    url: https://mammoth.io
    email: support@mammoth.io
  description: 'Operations tagged Owner user control settings across 2 of this provider''s published API definitions: app.mammoth.io-openapi.json, mammoth-io-openapi.json. Each path carries the servers of the definition it was published in.'
servers:
- url: /api/v2
security:
- bearerAuth: []
- apiKey: []
  apiSecret: []
  workspaceId: []
tags:
- name: Owner user control settings
paths:
  /settings/users:
    get:
      tags:
      - Owner user control settings
      summary: List users of all workspaces
      description: List users of all workspaces where the user is an owner
      operationId: ListUsersOfWorkspaces
      parameters:
      - name: fields
        in: query
        schema:
          type: string
          title: Fields
          description: Fields to be returned in a comma-separated format may include id, name, created_at, updated_at.
          default: id,email,first_name,last_name,created_at,updated_at,last_login_date,last_active_date,profile_link
          examples:
          - id,email
          - __full
          - __standard
          - __min
        description: Fields to be returned in a comma-separated format may include id, name, created_at, updated_at.
        required: false
        deprecated: false
        allowEmptyValue: false
        allowReserved: false
        examples:
          fields-example-1:
            summary: Return only id and email of  users inside workspace
            value: id,email
          fields-example-2:
            summary: Return full representation of users inside workspace. Full representation includes id,email,first_name,last_name,created_at,updated_at,last_login_date,last_active_date,profile_link,user_roles,status
            value: __full
          fields-example-3:
            summary: Return standard representation of users inside workspace. standard representation includes id,email,first_name,last_name,created_at,updated_at,last_login_date,last_active_date,profile_link
            value: __standard
          fields-example-4:
            summary: Return minimal representation of users inside workspace. Minimal representation includes id,email,first_name,last_name,created_at,updated_at
            value: __min
      - name: sort
        in: query
        schema:
          type: string
          title: Sort users
          description: Sort users by id, first_name or email
          default: (email:asc)
          examples:
          - (email:desc), (id:asc)
        description: Sort users by id, first_name or email
        required: false
        deprecated: false
        allowEmptyValue: false
        allowReserved: false
        examples:
          sort-example-1:
            summary: Sort users by email and id
            value: (email:desc), (id:asc)
      - name: offset
        in: query
        schema:
          type: integer
          title: Offset
          description: Offset from the beginning of the users list
          default: 0
          examples:
          - 1
        description: Offset from the beginning of the users list
        required: false
        deprecated: false
        allowEmptyValue: false
        allowReserved: false
        examples:
          offset-example-1:
            summary: Start from 2nd user
            value: 1
      - name: limit
        in: query
        schema:
          type: integer
          maximum: 100.0
          minimum: 1.0
          title: Limit
          description: Max number of users to return
          default: 10
          examples:
          - 10
        description: Max number of users to return
        required: false
        deprecated: false
        allowEmptyValue: false
        allowReserved: false
        examples:
          limit-example-1:
            summary: Limit returned user count to 10
            value: 10
      responses:
        '200':
          description: Request fulfilled, document follows
          headers: {}
          content:
            application/json:
              schema:
                type: object
        '400':
          description: Bad request syntax or unsupported method
          content:
            application/json:
              schema:
                properties:
                  status_code:
                    type: integer
                  detail:
                    type: string
                  extra:
                    additionalProperties: {}
                    type:
                    - 'null'
                    - object
                    - array
                type: object
                required:
                - detail
                - status_code
                description: Validation Exception
                examples:
                - status_code: 400
                  detail: Bad Request
                  extra: {}
      deprecated: false
    patch:
      tags:
      - Owner user control settings
      summary: Transfer ownerships of the workspaces
      operationId: TransferOwnerships
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/WorkspaceUsersSettingsPatch'
        required: true
      responses:
        '200':
          description: Request fulfilled, document follows
          headers: {}
          content:
            application/json:
              schema:
                type: object
        '400':
          description: Bad request syntax or unsupported method
          content:
            application/json:
              schema:
                properties:
                  status_code:
                    type: integer
                  detail:
                    type: string
                  extra:
                    additionalProperties: {}
                    type:
                    - 'null'
                    - object
                    - array
                type: object
                required:
                - detail
                - status_code
                description: Validation Exception
                examples:
                - status_code: 400
                  detail: Bad Request
                  extra: {}
      deprecated: false
    servers:
    - url: /api/v2
components:
  schemas:
    WorkspaceUsersSettingsPatch:
      properties:
        patches:
          items:
            $ref: '#/components/schemas/WorkspaceUsersSettingsPatchOp'
          type: array
      type: object
      required:
      - patches
      title: WorkspaceUsersSettingsPatch
      description: Transfer ownership of workspaces
      examples:
      - patches:
        - op: replace
          path: role
          value:
            workspace_id: 1
            user_id: 29
            new_role: workspace_owner
            remove_role: workspace_member
    TransferOwnership:
      properties:
        workspace_id:
          type: integer
          exclusiveMinimum: 0.0
          title: Workspace id
          description: Workspace id
          examples:
          - summary: Workspace id 1
            value: 1
        user_id:
          type: integer
          exclusiveMinimum: 0.0
          title: User id
          description: User id
          examples:
          - summary: User id 1
            value: 1
        new_role:
          type: string
          enum:
          - workspace_member
          - workspace_admin
          - workspace_owner
          - workspace_guest
          title: Role
          description: New role name
          default: workspace_owner
          examples:
          - summary: Role name
            value: workspace_owner
        remove_role:
          type:
          - 'null'
          - string
          enum:
          - workspace_member
          - workspace_admin
          - workspace_owner
          - workspace_guest
          - null
          title: Remove role
          description: Remove role name
          examples:
          - summary: Role name
            value: workspace_member
      type: object
      required:
      - user_id
      - workspace_id
      title: TransferOwnership
      description: Transfer ownership details
      examples:
      - summary: Transfer ownership details
        value:
          workspace_id: 1
          user_id: 29
          new_role: workspace_owner
          remove_role: workspace_member
    UserSettingsPatchPatchOps:
      type: string
      enum:
      - replace
      title: UserSettingsPatchPatchOps
      description: Operation to be performed
      examples:
      - value: replace
    UserSettingsPatchPatchPaths:
      type: string
      enum:
      - role
      title: UserSettingsPatchPatchPaths
      description: Operation path
      examples:
      - summary: Resend invites
        value: role
    WorkspaceUsersSettingsPatchOp:
      properties:
        op:
          $ref: '#/components/schemas/UserSettingsPatchPatchOps'
        path:
          $ref: '#/components/schemas/UserSettingsPatchPatchPaths'
        value:
          $ref: '#/components/schemas/TransferOwnership'
      type: object
      required:
      - op
      - path
      - value
      title: WorkspaceUsersSettingsPatchOp
  securitySchemes:
    bearerAuth:
      type: http
      description: 'Primary credential. Authorization: Bearer mm_<token>. The token is issued server-side and shown once at creation.'
      scheme: bearer
    apiKey:
      type: apiKey
      description: Deprecated — use bearerAuth.
      name: X-API-KEY
      in: header
    apiSecret:
      type: apiKey
      description: Deprecated — use bearerAuth.
      name: X-API-SECRET
      in: header
    workspaceId:
      type: apiKey
      description: Required with X-API-KEY and X-API-SECRET. Deprecated with them — use bearerAuth.
      name: X-WORKSPACE-ID
      in: header
x-refined-from:
- app.mammoth.io-openapi.json
- mammoth-io-openapi.json