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/cfengine:cfengine-user-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

openapi: 3.2.0
info:
  title: Cfengine User API
  version: '2026-10-08'
  description: 'GENERATED FROM DOCUMENTATION by API Evangelist on 2026-10-08: 44 operation(s) read from 8 public documentation page(s) (each operation names its page in x-source). This is not the provider''s published contract; Cfengine has published no machine-readable contract that the pipeline could find. Engine: local.'
  x-evidence-tiers:
    code-example: 42
    documentation: 2
    pages-with-code: 8
    pages-read: 8
  x-generated-from: documentation
  x-provenance: generated
  x-authored-by: API Evangelist
  x-generated: '2026-10-08'
  x-generator: generate-contract-from-docs.py
  x-engine: local
  x-sources:
  - https://docs.cfengine.com/docs/lts/api/enterprise-api-ref
  - https://docs.cfengine.com/docs/lts/api/enterprise-api-ref/host
  - https://docs.cfengine.com/docs/lts/api/enterprise-api-ref/ai-chat
  - https://docs.cfengine.com/docs/lts/api/enterprise-api-ref/cmdb-api
  - https://docs.cfengine.com/docs/lts/api/enterprise-api-ref/web-rbac
  - https://docs.cfengine.com/docs/lts/api/enterprise-api-ref/build-api
  - https://docs.cfengine.com/docs/lts/api/enterprise-api-ref/inventory
  - https://docs.cfengine.com/docs/lts/api/enterprise-api-ref/users-rbac
servers:
- url: https://hub.cfengine.com
security:
- api_token: []
- Basic: []
- Bearer: []
tags:
- name: User
paths:
  /api/user/{username}:
    delete:
      operationId: delete_api_user_username
      tags:
      - User
      summary: Remove internal user
      x-source: https://docs.cfengine.com/docs/lts/api/enterprise-api-ref/users-rbac
      parameters:
      - name: username
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
    get:
      operationId: get_api_user_username
      tags:
      - User
      summary: Get info for a specified user
      x-source: https://docs.cfengine.com/docs/lts/api/enterprise-api-ref/users-rbac
      parameters:
      - name: username
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetApiUserUsernameResponse'
      x-evidence:
        kind: documentation
    post:
      operationId: post_api_user_username
      tags:
      - User
      summary: Update user information
      x-source: https://docs.cfengine.com/docs/lts/api/enterprise-api-ref/users-rbac
      parameters:
      - name: username
        in: path
        required: true
        schema:
          type: string
      requestBody:
        required: false
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostApiUserUsernameRequest'
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
    put:
      operationId: put_api_user_username
      tags:
      - User
      summary: Create a new user
      x-source: https://docs.cfengine.com/docs/lts/api/enterprise-api-ref/users-rbac
      parameters:
      - name: username
        in: path
        required: true
        schema:
          type: string
      requestBody:
        required: false
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PutApiUserUsernameRequest'
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /api/user/{username}/unlock:
    post:
      operationId: post_api_user_username_unlock
      tags:
      - User
      summary: Unlock a user locked out due to two‑factor authentication setup
      x-source: https://docs.cfengine.com/docs/lts/api/enterprise-api-ref/users-rbac
      parameters:
      - name: username
        in: path
        required: true
        schema:
          type: string
      responses:
        '201':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostApiUserUsernameUnlockResponse'
      x-evidence:
        kind: documentation
components:
  schemas:
    PostApiUserUsernameRequest:
      type: object
      properties:
        password:
          type: string
          description: User password
        email:
          type: string
          description: User email
        roles:
          type: string
          description: 'User roles, emp: ["admin", "test"]'
        time_zone:
          type: string
          description: Time zone
    PutApiUserUsernameRequest:
      type: object
      properties:
        password:
          type: string
          description: User password
        email:
          type: string
          description: User email
        roles:
          type: string
          description: 'User roles, emp: ["admin", "test"]'
        time_zone:
          type: string
          description: Time zone
    PostApiUserUsernameUnlockResponse:
      type: object
      properties:
        '202':
          type: string
          description: Accepted – user unlocked and additional 48 hours granted.
    GetApiUserUsernameResponse:
      type: object
      properties:
        id:
          type: string
          description: User name.
        email:
          type: string
          description: Email address.
        roles:
          type: string
          description: List of assigned RBAC roles.
        external:
          type: string
          description: Is user from external source (LDAP/AD).
        time_zone:
          type: string
          description: Time zone
        two_factor_enabled:
          type: string
          description: If a user has enabled two-factor authentication
  securitySchemes:
    api_token:
      type: apiKey
      in: header
      name: Authorization
      x-source: https://docs.cfengine.com/docs/lts/api/enterprise-api-ref/ldap-api/
    Basic:
      type: http
      scheme: basic
      x-source: https://docs.cfengine.com/docs/lts/api/enterprise-api-ref/ldap-api/
    Bearer:
      type: http
      scheme: bearer
      x-source: https://docs.cfengine.com/docs/lts/api/enterprise-api-ref/ldap-api/