Bigeye

Bigeye User Service API

The UserService API from Bigeye — 4 operation(s) for userservice.

GitHub OpenAPI

Operations 6

POST /api/v1/users/bulk-delete Delete users #
POST /api/v1/users/service-account Create a Service Account #
GET /api/v1/users Get all users #
POST /api/v1/users Invite a new user #
GET /api/v1/users/{userId} Get a user #
PUT /api/v1/users/{userId} Update user name and/or groups #

Documentation

📖
Documentation
https://docs.bigeye.com/docs/api-user-guide
📖
APIReference
https://docs.bigeye.com/reference
📖
Documentation
https://docs.bigeye.com/docs/monitoring
📖
Documentation
https://docs.bigeye.com/docs/getting-started-scanning

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/bigeye/refs/heads/main/openapi/bigeye-userservice-api-openapi.yml

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/bigeye-userservice-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

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

bigeye-userservice-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Metadata User Service API
  version: version not set
servers:
- url: https://app.bigeye.com
security:
- basicAuth: []
- Personal_API_Key: []
tags:
- name: UserService
paths:
  /api/v1/users/bulk-delete:
    post:
      operationId: UserService_BulkDeleteUsers
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/generatedBulkDeleteUsersRequest'
        required: true
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/generatedBulkResponse'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/runtimeError'
      summary: Delete users
      tags:
      - UserService
  /api/v1/users/service-account:
    post:
      operationId: UserService_CreateServiceAccount
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/generatedCreateServiceAccountRequest'
        required: true
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/generatedCreateServiceAccountResponse'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/runtimeError'
      summary: Create a Service Account
      tags:
      - UserService
  /api/v1/users:
    get:
      operationId: UserService_GetAllUsers
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/generatedGetUserListResponse'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/runtimeError'
      summary: Get all users
      tags:
      - UserService
    post:
      operationId: UserService_InviteNewUser
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/generatedUserInviteRequest'
        required: true
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/generatedUser'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/runtimeError'
      summary: Invite a new user
      tags:
      - UserService
  /api/v1/users/{userId}:
    get:
      operationId: UserService_GetUser
      parameters:
      - in: path
        name: userId
        required: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/generatedUser'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/runtimeError'
      summary: Get a user
      tags:
      - UserService
    put:
      operationId: UserService_UpdateUser
      parameters:
      - in: path
        name: userId
        required: true
        schema:
          type: integer
          format: int32
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/generatedUpdateUserRequest'
        required: true
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/generatedUpdateUserResponse'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/runtimeError'
      summary: Update user name and/or groups
      tags:
      - UserService
components:
  schemas:
    generatedUserInviteRequest:
      properties:
        email:
          type: string
        groupIds:
          items:
            format: int32
            type: integer
          type: array
        name:
          type: string
      type: object
    generatedFailedUpdate:
      properties:
        id:
          format: int32
          type: integer
        reason:
          type: string
      type: object
    generatedUpdateUserResponse:
      properties:
        user:
          $ref: '#/components/schemas/generatedUser'
      type: object
    generatedIdAndDisplayName:
      properties:
        displayName:
          type: string
        id:
          format: int32
          type: integer
      type: object
    generatedUpdateUserRequest:
      properties:
        groupIds:
          items:
            format: int32
            type: integer
          type: array
        name:
          type: string
      type: object
    generatedBulkResponse:
      properties:
        failedUpdates:
          items:
            $ref: '#/components/schemas/generatedFailedUpdate'
          type: array
        notRunIds:
          items:
            format: int32
            type: integer
          type: array
        successfulIds:
          items:
            format: int32
            type: integer
          type: array
      type: object
    generatedUser:
      properties:
        email:
          type: string
        groups:
          items:
            $ref: '#/components/schemas/generatedIdAndDisplayName'
          type: array
        id:
          format: int32
          type: integer
        idpGroups:
          items:
            type: string
          type: array
        isServiceAccount:
          type: boolean
        lastLoginAt:
          format: int64
          type: string
        name:
          type: string
        pictureUrl:
          type: string
      type: object
    generatedBulkDeleteUsersRequest:
      properties:
        userIds:
          items:
            format: int32
            type: integer
          type: array
      type: object
    generatedCreateServiceAccountRequest:
      properties:
        groupIds:
          items:
            format: int32
            type: integer
          type: array
        name:
          type: string
      type: object
    runtimeError:
      properties:
        code:
          format: int32
          type: integer
        details:
          items:
            $ref: '#/components/schemas/protobufAny'
          type: array
        error:
          type: string
        message:
          type: string
      type: object
    generatedGetUserListResponse:
      properties:
        users:
          items:
            $ref: '#/components/schemas/generatedUser'
          type: array
      type: object
    protobufAny:
      properties:
        typeUrl:
          type: string
        value:
          format: byte
          type: string
      type: object
    generatedCreateServiceAccountResponse:
      properties:
        user:
          $ref: '#/components/schemas/generatedUser'
      type: object
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic
    Agent_API_Key:
      description: Add 'apikey ' to the beginning of your api key
      in: header
      name: Authorization
      type: apiKey
    Personal_API_Key:
      description: Add 'apikey ' to the beginning of your api key
      in: header
      name: Authorization
      type: apiKey