Codefresh

Codefresh User API

The user API from Codefresh — 6 operation(s) for user.

GitHub OpenAPI

Operations 7

DELETE /admin/user/{userName} Delete #
POST /admin/user/adminRole Change role #
POST /admin/user/account Change account #
GET /admin/user/loginAsUser Login as another user #
POST /admin/user/localProvider Update local provider #
DELETE /admin/user/localProvider Delete local provider #
POST /admin/user/{userId}/activate Activate user #

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/codefresh/refs/heads/main/openapi/codefresh-user-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-user-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-user-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 User 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: User
paths:
  /admin/user/{userName}:
    delete:
      x-action: deleteUser
      x-entityId:
        pathName: params.userName
      responses:
        '200':
          content:
            application/json:
              schema:
                type: object
          description: json
      tags:
      - User
      operationId: user-delete
      parameters:
      - in: path
        name: userName
        schema:
          type: string
        required: true
        description: User name
      summary: Delete
      x-sdk-interface: user.delete
      x-code-samples:
      - lang: curl
        source: "curl  \\\n    -X DELETE \\\n    -H \"Authorization: ${API_KEY}\" \\\n    \"https://g.codefresh.io/api/admin/user/${USER_NAME}\""
      - lang: node.js
        source: sdk.user.delete({ userName })
  /admin/user/adminRole:
    post:
      x-action: changeAdminRole
      x-entityId:
        pathId: body._id
        pathName: body.userName
      responses:
        '200':
          content:
            application/json:
              schema:
                type: object
          description: json
      tags:
      - User
      operationId: user-change-admin-role
      requestBody:
        content:
          application/json:
            schema:
              type: object
      summary: Change role
      x-sdk-interface: user.changeRole
      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/admin/user/adminRole\""
      - lang: node.js
        source: sdk.user.changeRole({ ...REQUEST_BODY_OBJ })
      parameters: []
  /admin/user/account:
    post:
      x-action: changeUserAccount
      x-entityId:
        pathId: body._id
        pathName: body.userName
      responses:
        '200':
          content:
            application/json:
              schema:
                type: object
          description: json
      tags:
      - User
      operationId: user-change-account
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                account:
                  type: array
                  items:
                    type: object
                  x-secure: true
      summary: Change account
      x-sdk-interface: user.changeAccount
      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 \"{\\\"account\\\":[${ACCOUNT_ARR_OBJ}]}\" \\\n    \"https://g.codefresh.io/api/admin/user/account\""
      - lang: node.js
        source: "sdk.user.changeAccount({\n    account: [\n        { ...ACCOUNT_ARR_OBJ }\n    ]\n})"
      parameters: []
  /admin/user/loginAsUser:
    get:
      x-action: loginAsUser
      x-audit:
        id:
          path: query.userId
        name:
          path: user.userName
          source: res
      responses:
        '200':
          content:
            application/json:
              schema:
                type: object
          description: json
      tags:
      - User
      operationId: login-as-user
      summary: Login as another user
      parameters:
      - name: userId
        in: query
        schema:
          type: string
        description: the user id
      x-sdk-interface: user.loginAsUser
      x-code-samples:
      - lang: curl
        source: "curl  \\\n    -X GET \\\n    -H \"Authorization: ${API_KEY}\" \\\n    \"https://g.codefresh.io/api/admin/user/loginAsUser?userId=${USER_ID}\""
      - lang: node.js
        source: sdk.user.loginAsUser({ userId })
  /admin/user/localProvider:
    post:
      x-action: updateLocalProviderPassword
      x-entityId:
        pathName: request.body.userName
      responses:
        '200':
          content:
            application/json:
              schema:
                type: object
          description: json
      tags:
      - User
      operationId: user-update-local-provider
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                password:
                  type: string
                  x-secure: true
      summary: Update local provider
      x-sdk-interface: user.updateLocalProvider
      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 \"{\\\"password\\\":\\\"${PASSWORD_STR}\\\"}\" \\\n    \"https://g.codefresh.io/api/admin/user/localProvider\""
      - lang: node.js
        source: "sdk.user.updateLocalProvider({\n    password: `${PASSWORD_STR}`\n})"
      parameters: []
    delete:
      x-action: deleteLocalProvider
      x-entityId:
        pathName: query.userName
      responses:
        '200':
          content:
            application/json:
              schema:
                type: object
          description: json
      tags:
      - User
      operationId: user-delete-local-provider
      summary: Delete local provider
      x-sdk-interface: user.deleteLocalProvider
      x-code-samples:
      - lang: curl
        source: "curl  \\\n    -X DELETE \\\n    -H \"Authorization: ${API_KEY}\" \\\n    \"https://g.codefresh.io/api/admin/user/localProvider\""
      - lang: node.js
        source: sdk.user.deleteLocalProvider()
      parameters: []
  /admin/user/{userId}/activate:
    post:
      x-action: activateUser
      x-entityId: params.userId
      responses:
        '200':
          content:
            application/json:
              schema:
                type: object
          description: json
      tags:
      - User
      operationId: user-activate-user
      parameters:
      - in: path
        name: userId
        schema:
          type: string
        required: true
        description: User ID
      requestBody:
        content:
          application/json:
            schema:
              type: object
      summary: Activate user
      x-sdk-interface: user.activate.user
      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/admin/user/${USER_ID}/activate\""
      - lang: node.js
        source: sdk.user.activate.user({ userId }, { ...REQUEST_BODY_OBJ })
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-user-api-openapi.yml