Chef

Chef Users API

The Users API from Chef — 1 operation(s) for users.

GitHub OpenAPI

Documentation

📖
Documentation
https://docs.chef.io/server/api_chef_server/
📖
Authentication
https://docs.chef.io/server/server_security/
📖
Documentation
https://docs.chef.io/automate/api/
📖
Authentication
https://docs.chef.io/automate/api_tokens/
📖
Documentation
https://docs.habitat.sh/docs/using-builder/
📖
Authentication
https://docs.habitat.sh/docs/using-builder/

Specifications

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

Other Resources

🔗
Reference
https://docs.chef.io/automate/api_swagger/

OpenAPI Specification

chef-users-api-openapi.yml Raw ↑ 
openapi: 3.1.0
info:
  title: Chef Automate Channels Users API
  description: REST API for Chef Automate providing visibility into infrastructure convergence, compliance scans, and application deployment. Includes endpoints for nodes, profiles, scans, and reports.
  version: '1.0'
  contact:
    name: Chef Software
    url: https://www.chef.io/support
servers:
- url: https://{automate}/api/v0
  description: Chef Automate
  variables:
    automate:
      default: automate.example.com
security:
- apiToken: []
tags:
- name: Users
paths:
  /users:
    get:
      operationId: listUsers
      summary: List users
      tags:
      - Users
      responses:
        '200':
          description: User list
components:
  securitySchemes:
    apiToken:
      type: apiKey
      in: header
      name: api-token
      description: API token issued through the Chef Automate UI or admin API.
externalDocs:
  description: Chef Automate API
  url: https://docs.chef.io/automate/api/