Codefresh

Codefresh Service Users API

The service-users API from Codefresh — 3 operation(s) for service-users.

GitHub OpenAPI

Operations 6

GET /service-users/{id} Get service account with teams #
PATCH /service-users/{id} Updates userName and teams for service account #
DELETE /service-users/{id} Delete service user #
POST /service-users/{id}/setStatus Enables/Disables service account by id #
POST /service-users Create service account #
GET /service-users List service accounts #

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/codefresh/refs/heads/main/openapi/codefresh-service-users-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/codefresh:codefresh-service-users-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

codefresh-service-users-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  contact:
    name: Codefresh
    url: https://www.codefresh.io
  description: Codefresh API openAPI 3.0 specification
  termsOfService: https://codefresh.io/docs/docs/terms-and-privacy-policy/terms-of-service/
  title: Codefresh Service Users API
  version: 0.0.2
  x-logo:
    url: https://g.codefresh.io/modules/cf.resources/codefresh-api-docs-images/codefresh-logo-api.svg
    backgroundColor: '#FFFFFF'
    altText: Codefresh
servers:
- url: https://g.codefresh.io/api
security:
- API-key: []
tags:
- name: service-users
paths:
  /service-users/{id}:
    get:
      responses:
        '200':
          content:
            application/json:
              schema:
                type: object
          description: json
      tags:
      - service-users
      operationId: get-service-user
      summary: Get service account with teams
      parameters:
      - description: The id of the service account
        in: path
        name: id
        required: true
        schema:
          type: string
      x-endpoint:
        isEndpoint: false
        auth:
          middleware:
          - auth.isAuthenticated
          - auth.isAccountAdmin
        postMiddleware:
        - global.iseMiddleware
        handler: service-users.getById
      x-code-samples:
      - lang: curl
        source: "curl  \\\n    -X GET \\\n    -H \"Authorization: ${API_KEY}\" \\\n    \"https://g.codefresh.io/api/service-users/${ID}\""
      - lang: node.js
        source: sdk.undefined({ id })
    patch:
      x-action: updateServiceUser
      responses:
        '200':
          content:
            application/json:
              schema:
                type: object
          description: json
      tags:
      - service-users
      operationId: service-user-patch
      summary: Updates userName and teams for service account
      parameters:
      - description: The id of the service account
        in: path
        name: id
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              x-allowed:
                body:
                - userName
                - teamIds
                - assignAdminRole
      x-endpoint:
        isEndpoint: false
        auth:
          middleware:
          - auth.isAuthenticated
          - auth.isAccountAdmin
        postMiddleware:
        - global.iseMiddleware
        handler: service-users.patch
      x-code-samples:
      - lang: curl
        source: "curl  \\\n    -X PATCH \\\n    -H \"Authorization: ${API_KEY}\" \\\n    -H 'Content-Type: application/json; charset=utf-8' \\\n    -d \"${REQUEST_BODY_OBJ}\" \\\n    \"https://g.codefresh.io/api/service-users/${ID}\""
      - lang: node.js
        source: sdk.undefined({ id }, { ...REQUEST_BODY_OBJ })
    delete:
      x-action: deleteServiceUser
      x-entityId:
        pathId: params.id
      summary: Delete service user
      description: Deletes service user by userId
      parameters:
      - description: The id of the service account
        in: path
        name: id
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                type: object
          description: json
      tags:
      - service-users
      operationId: service-users-delete
      x-endpoint:
        isEndpoint: false
        auth:
          middleware:
          - auth.isAuthenticated
          - auth.isAccountAdmin
        postMiddleware:
        - global.iseMiddleware
        handler: service-users.delete
      x-code-samples:
      - lang: curl
        source: "curl  \\\n    -X DELETE \\\n    -H \"Authorization: ${API_KEY}\" \\\n    \"https://g.codefresh.io/api/service-users/${ID}\""
      - lang: node.js
        source: sdk.undefined({ id })
  /service-users/{id}/setStatus:
    post:
      x-action: setStatusForServiceUser
      responses:
        '200':
          content:
            application/json:
              schema:
                type: object
          description: json
      tags:
      - service-users
      operationId: activate-service-user
      summary: Enables/Disables service account by id
      parameters:
      - description: The id of the service account
        in: path
        name: id
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              x-allowed:
                body:
                - isDisabled
      x-endpoint:
        isEndpoint: false
        auth:
          middleware:
          - auth.isAuthenticated
          - auth.isAccountAdmin
        postMiddleware:
        - global.iseMiddleware
        handler: service-users.setServiceUserStatus
      x-code-samples:
      - lang: curl
        source: "curl  \\\n    -X POST \\\n    -H \"Authorization: ${API_KEY}\" \\\n    -H 'Content-Type: application/json; charset=utf-8' \\\n    -d \"${REQUEST_BODY_OBJ}\" \\\n    \"https://g.codefresh.io/api/service-users/${ID}/setStatus\""
      - lang: node.js
        source: sdk.undefined({ id }, { ...REQUEST_BODY_OBJ })
  /service-users:
    post:
      x-action: createServiceUser
      responses:
        '200':
          content:
            application/json:
              schema:
                type: object
          description: json
      tags:
      - service-users
      operationId: service-users-create
      summary: Create service account
      requestBody:
        content:
          application/json:
            schema:
              type: object
              x-allowed:
                body:
                - userName
                - teamIds
                - assignAdminRole
      parameters: []
      x-endpoint:
        isEndpoint: false
        auth:
          middleware:
          - auth.isAuthenticated
          - auth.isAccountAdmin
        postMiddleware:
        - global.iseMiddleware
        handler: service-users.create
      x-code-samples:
      - lang: curl
        source: "curl  \\\n    -X POST \\\n    -H \"Authorization: ${API_KEY}\" \\\n    -H 'Content-Type: application/json; charset=utf-8' \\\n    -d \"${REQUEST_BODY_OBJ}\" \\\n    \"https://g.codefresh.io/api/service-users\""
      - lang: node.js
        source: sdk.undefined({ ...REQUEST_BODY_OBJ })
    get:
      responses:
        '200':
          content:
            application/json:
              schema:
                type: object
          description: json
      tags:
      - service-users
      operationId: service-users-list
      summary: List service accounts
      parameters: []
      x-endpoint:
        isEndpoint: false
        auth:
          middleware:
          - auth.isAuthenticated
          - auth.isAccountAdmin
        postMiddleware:
        - global.iseMiddleware
        handler: service-users.list
      x-code-samples:
      - lang: curl
        source: "curl  \\\n    -X GET \\\n    -H \"Authorization: ${API_KEY}\" \\\n    \"https://g.codefresh.io/api/service-users\""
      - lang: node.js
        source: sdk.undefined()
components:
  securitySchemes:
    API-key:
      in: header
      name: Authorization
      description: 'An api key got from: User Settings -> API keys -> Generate'
      type: apiKey
x-service-name: api-public
x-base-path: /api
x-internal-services:
- pipeline-manager
- api
x-endpoint-conditions:
- weight: 0
  condition: global.has-general-service-role
  handlerRegex: (.*)
- weight: 1
  condition: global.has-kubernetes-endpoints-service-role
  handlerRegex: kubernetes\.\w+
- weight: 2
  condition: global.has-auth-service-role
  handlerRegex: api-key\.\w+
x-tagGroups:
- name: Pipelines / Builds
  tags:
  - Annotations
  - Builds
  - Execution Contexts
  - Images
  - Pipelines
  - Progress
  - Projects
  - Step-types
  - Triggers
  - Triggers Events
  - Triggers Types
- name: Kubernetes / Helm
  tags:
  - Environments V2
  - Helm Boards
  - Helm Charts
  - Helm Releases
  - Helm Sections
  - Kubernetes
- name: Swarm
  tags:
  - Compositions
  - Environments
- name: Integrations / Contexts
  tags:
  - Clusters
  - Contexts
  - Helm Cluster Configs
  - Helm Repos
  - Registries
  - Repos
- name: Account Management
  tags:
  - Abac
  - Accounts
  - Agents
  - Audit
  - Runtime Environments
  - Teams
  - Tokens
  - Views
- name: User Properties
  tags:
  - favorites
- name: On-Premise
  tags:
  - Features
  - Runtime Environments (Account)
  - Runtime Environments (Plan)
  - Runtime Environments (System)
  - Runtime Environments.
- name: Platform Analytics
  tags:


# --- truncated at 32 KB (134 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/codefresh/refs/heads/main/openapi/codefresh-service-users-api-openapi.yml