Broad Institute

Broad Institute Groups API

The Groups API from Broad Institute — 4 operation(s) for groups.

GitHub OpenAPI

Operations 7

GET /api/groups get the list of the groups that the caller is a member of #
GET /api/groups/{groupName} view the members in a group #
POST /api/groups/{groupName} create a new group #
DELETE /api/groups/{groupName} delete a group that the caller owns #
POST /api/groups/{groupName}/requestAccess request access to a group #
PUT /api/groups/{groupName}/{role}/{email} add a user to a group the caller owns #
DELETE /api/groups/{groupName}/{role}/{email} remove a user from a group the caller owns #

Specifications

⚙
OpenAPI
https://artifacts.apis.io/broad-institute/openapi/broad-institute-groups-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://artifacts.apis.io/broad-institute/json-schema/broad-institute-workflow-description-schema.json
📊
JSONSchema
https://artifacts.apis.io/broad-institute/json-schema/broad-institute-workspace-details-schema.json
📊
JSONSchema
https://artifacts.apis.io/broad-institute/json-schema/broad-institute-submission-request-schema.json
📊
JSONSchema
https://artifacts.apis.io/broad-institute/json-schema/broad-institute-submission-schema.json
📊
JSONSchema
https://artifacts.apis.io/broad-institute/json-schema/broad-institute-tool-schema.json
📊
JSONSchema
https://artifacts.apis.io/broad-institute/json-schema/broad-institute-configuration-response-schema.json

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/broad-institute:broad-institute-groups-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

broad-institute-groups-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Terra Groups API
  description: Terra API
  termsOfService: https://app.terra.bio/#terms-of-service
  license:
    name: BSD
    url: http://opensource.org/licenses/BSD-3-Clause
  version: '0.1'
servers:
- url: /
security:
- oidc: []
tags:
- name: Groups
paths:
  /api/groups:
    get:
      tags:
      - Groups
      summary: get the list of the groups that the caller is a member of
      operationId: getGroups
      responses:
        200:
          description: Successfully listed group membership
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ManagedGroupAccessResponse'
        500:
          description: FireCloud Internal Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorReport'
      x-passthrough: false
  /api/groups/{groupName}:
    get:
      tags:
      - Groups
      summary: view the members in a group
      operationId: getGroup
      parameters:
      - name: groupName
        in: path
        description: Group name
        required: true
        schema:
          type: string
      responses:
        200:
          description: Successfully loaded group
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ManagedGroupWithMembers'
        403:
          description: You must be an admin of this group in order to view members
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorReport'
        404:
          description: Group not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorReport'
        500:
          description: FireCloud Internal Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorReport'
      x-passthrough: false
    post:
      tags:
      - Groups
      summary: create a new group
      operationId: createGroup
      parameters:
      - name: groupName
        in: path
        description: Group name
        required: true
        schema:
          type: string
      responses:
        201:
          description: Successfully created group
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ManagedGroupWithMembers'
        409:
          description: Group already exists
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorReport'
        500:
          description: FireCloud Internal Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorReport'
      x-passthrough: false
    delete:
      tags:
      - Groups
      summary: delete a group that the caller owns
      operationId: deleteGroup
      parameters:
      - name: groupName
        in: path
        description: Group name
        required: true
        schema:
          type: string
      responses:
        204:
          description: Successfully Deleted Group
          content: {}
        403:
          description: You must be an admin of this group in order to delete it
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorReport'
        404:
          description: Group not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorReport'
        409:
          description: Group is in use and cannot be deleted
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorReport'
        500:
          description: FireCloud Internal Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorReport'
      x-passthrough: false
  /api/groups/{groupName}/requestAccess:
    post:
      tags:
      - Groups
      summary: request access to a group
      operationId: requestAccessToGroup
      parameters:
      - name: groupName
        in: path
        description: Group name
        required: true
        schema:
          type: string
      responses:
        204:
          description: Successfully requested access
          content: {}
        404:
          description: Group not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorReport'
        500:
          description: FireCloud Internal Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorReport'
      x-passthrough: false
  /api/groups/{groupName}/{role}/{email}:
    put:
      tags:
      - Groups
      summary: add a user to a group the caller owns
      operationId: addUserToGroup
      parameters:
      - name: groupName
        in: path
        description: Group name
        required: true
        schema:
          type: string
      - name: role
        in: path
        description: role of user for group
        required: true
        schema:
          type: string
          enum:
          - member
          - admin
      - name: email
        in: path
        description: email of user or group to add
        required: true
        schema:
          type: string
      responses:
        204:
          description: Successfully Added User To Group
          content: {}
        403:
          description: You must be an admin of this group in order to add members
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorReport'
        404:
          description: User not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorReport'
        500:
          description: FireCloud Internal Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorReport'
      x-passthrough: false
    delete:
      tags:
      - Groups
      summary: remove a user from a group the caller owns
      operationId: removeUserFromGroup
      parameters:
      - name: groupName
        in: path
        description: Group name
        required: true
        schema:
          type: string
      - name: role
        in: path
        description: role of user for group
        required: true
        schema:
          type: string
          enum:
          - member
          - admin
      - name: email
        in: path
        description: email of user or group to add
        required: true
        schema:
          type: string
      responses:
        204:
          description: Successfully Removed User From Group
          content: {}
        403:
          description: You must be an admin of this group in order to remove members
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorReport'
        404:
          description: User not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorReport'
        500:
          description: FireCloud Internal Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorReport'
      x-passthrough: false
components:
  schemas:
    ManagedGroupAccessResponse:
      required:
      - groupEmail
      - groupName
      - role
      type: object
      properties:
        groupName:
          type: string
        groupEmail:
          type: string
        role:
          type: string
      description: an element of a list of groups a user has access to
    ErrorReport:
      required:
      - causes
      - message
      - source
      - stackTrace
      type: object
      properties:
        source:
          type: string
          description: service causing error
        message:
          type: string
          description: what went wrong
        statusCode:
          type: integer
          description: HTTP status code
          format: int32
        causes:
          type: array
          description: errors triggering this one
          items:
            $ref: '#/components/schemas/ErrorReport'
        stackTrace:
          type: array
          description: stack trace
          items:
            $ref: '#/components/schemas/StackTraceElement'
      description: ''
    RawlsGroupShort:
      type: object
      properties:
        groupName:
          type: string
          description: the name of the group
        groupEmail:
          type: string
          description: the email associated with the group
      description: a reference to a group
    ManagedGroupWithMembers:
      required:
      - adminsEmails
      - adminsGroup
      - membersEmails
      - membersGroup
      type: object
      properties:
        membersGroup:
          $ref: '#/components/schemas/RawlsGroupShort'
        adminsGroup:
          $ref: '#/components/schemas/RawlsGroupShort'
        membersEmails:
          type: array
          items:
            type: string
        adminsEmails:
          type: array
          items:
            type: string
      description: a group with all of its members
    StackTraceElement:
      required:
      - className
      - fileName
      - lineNumber
      - methodName
      type: object
      properties:
        className:
          type: string
          description: class name
        methodName:
          type: string
          description: method name
        fileName:
          type: string
          description: source file name
        lineNumber:
          type: integer
          description: line number
          format: int32
      description: ''
  securitySchemes:
    oidc:
      type: oauth2
      x-tokenName: id_token
      flows:
        authorizationCode:
          authorizationUrl: OAUTH_AUTHORIZATION_URL
          scopes: {}
          tokenUrl: OAUTH_TOKEN_URL
    oidc_google_billing_scope:
      type: oauth2
      x-tokenName: id_token
      flows:
        authorizationCode:
          authorizationUrl: OAUTH_AUTHORIZATION_URL_WITH_GOOGLE_BILLING_SCOPE
          scopes: {}
          tokenUrl: OAUTH_TOKEN_URL_WITH_GOOGLE_BILLING_SCOPE