Chef Software UserSettingsService API

The UserSettingsService API from Chef Software — 1 operation(s) for usersettingsservice.

Documentation GitHub OpenAPI

Operations 3

GET /api/v0/user-settings/{user.name}/{user.connector} GetUserSettings returns all of the preferences for a given user #

DELETE /api/v0/user-settings/{user.name}/{user.connector} DeleteUserSettings deletes all settings for a given user #

PUT /api/v0/user-settings/{user.name}/{user.connector} PutUserSettings upserts all of the preferences for a given user #

Documentation

📖

Documentation

https://docs.chef.io/automate/api/

📖

Authentication

https://docs.chef.io/automate/api_tokens/

Specifications

⚙

OpenAPI

https://raw.githubusercontent.com/api-evangelist/chef-software/refs/heads/main/openapi/chef-software-usersettingsservice-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/chef-software-usersettingsservice-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 email required.

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: external/applications/applications.proto ApplicationsService User Settings Service API
  version: version not set
servers:
- url: https://automate.chef.io/api/v0
tags:
- name: UserSettingsService
paths:
  /api/v0/user-settings/{user.name}/{user.connector}:
    get:
      summary: GetUserSettings returns all of the preferences for a given user
      operationId: UserSettingsService_GetUserSettings
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/chef.automate.api.user_settings.GetUserSettingsResponse'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/grpc.gateway.runtime.Error'
      parameters:
      - name: user.name
        in: path
        required: true
        schema:
          type: string
      - name: user.connector
        in: path
        required: true
        schema:
          type: string
      tags:
      - UserSettingsService
    delete:
      summary: DeleteUserSettings deletes all settings for a given user
      operationId: UserSettingsService_DeleteUserSettings
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                properties: {}
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/grpc.gateway.runtime.Error'
      parameters:
      - name: user.name
        in: path
        required: true
        schema:
          type: string
      - name: user.connector
        in: path
        required: true
        schema:
          type: string
      tags:
      - UserSettingsService
    put:
      summary: PutUserSettings upserts all of the preferences for a given user
      operationId: UserSettingsService_PutUserSettings
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/chef.automate.api.user_settings.PutUserSettingsResponse'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/grpc.gateway.runtime.Error'
      parameters:
      - name: user.name
        in: path
        required: true
        schema:
          type: string
      - name: user.connector
        in: path
        required: true
        schema:
          type: string
      tags:
      - UserSettingsService
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/chef.automate.api.user_settings.PutUserSettingsRequest'
        required: true
components:
  schemas:
    chef.automate.api.user_settings.PutUserSettingsResponse:
      type: object
      properties:
        user:
          $ref: '#/components/schemas/chef.automate.api.user_settings.User'
    chef.automate.api.user_settings.GetUserSettingsResponse:
      type: object
      properties:
        user:
          $ref: '#/components/schemas/chef.automate.api.user_settings.User'
        settings:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/chef.automate.api.user_settings.UserSettingValue'
    google.protobuf.Any:
      type: object
      properties:
        type_url:
          type: string
        value:
          type: string
          format: byte
    grpc.gateway.runtime.Error:
      type: object
      properties:
        error:
          type: string
        code:
          type: integer
          format: int32
        message:
          type: string
        details:
          type: array
          items:
            $ref: '#/components/schemas/google.protobuf.Any'
    chef.automate.api.user_settings.PutUserSettingsRequest:
      type: object
      properties:
        user:
          $ref: '#/components/schemas/chef.automate.api.user_settings.User'
          description: ID of the user. Cannot be changed. Used to sign in.
        settings:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/chef.automate.api.user_settings.UserSettingValue'
          description: The user settings to persist.
    chef.automate.api.user_settings.UserSettingValue:
      type: object
      properties:
        default_value:
          type: string
          description: Default value for this setting.
        value:
          type: string
          description: Value for this setting.
        enabled:
          type: boolean
          title: Enabled
        valid_values:
          type: array
          items:
            type: string
          description: Valid values for this setting.
    chef.automate.api.user_settings.User:
      type: object
      properties:
        name:
          type: string
        connector:
          type: string