Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Chef Software UserSettingsService API

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

Chef Software UserSettingsService API is one of 30 APIs that Chef Software publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include UserSettingsService. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and authentication docs.

This API exposes 3 operations across 1 path, and defines 7 schemas. It is described by OpenAPI 2.0, at version version not set.

Requests are made against the base URL https://automate.chef.io/api/v0.

3 operations 1 paths 7 schemas 1 DELETE1 GET1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 2.0
API Version
version not set
Base URL
https://automate.chef.io/api/v0
Resource Areas
1

Paths & Operations 3

Across 1 path, the API surfaces 3 operations — 1 DELETE, 1 GET, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

UserSettingsService 3
GET
/api/v0/user-settings/{user.name}/{user.connector}
GetUserSettings returns all of the preferences for a given user
UserSettingsService_GetUserSettings 2 params → 200default
DELETE
/api/v0/user-settings/{user.name}/{user.connector}
DeleteUserSettings deletes all settings for a given user
UserSettingsService_DeleteUserSettings 2 params → 200default
PUT
/api/v0/user-settings/{user.name}/{user.connector}
PutUserSettings upserts all of the preferences for a given user
UserSettingsService_PutUserSettings 3 params → 200default

Schemas 7

The contract defines 7 schemas that model the data the API accepts and returns. The most detailed are grpc.gateway.runtime.Error (4 properties), chef.automate.api.user_settings.UserSettingValue (4 properties), chef.automate.api.user_settings.User (2 properties), google.protobuf.Any (2 properties). Each schema is shown below with its type and property counts.

chef.automate.api.user_settings.UserSettingValue
object
4 properties
chef.automate.api.user_settings.PutUserSettingsResponse
object
1 property
chef.automate.api.user_settings.GetUserSettingsResponse
object
2 properties
chef.automate.api.user_settings.PutUserSettingsRequest
object
2 properties
google.protobuf.Any
object
2 properties
grpc.gateway.runtime.Error
object
4 properties
chef.automate.api.user_settings.User
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

chef-software-usersettingsservice-api-openapi.yml Raw ↑

Other APIs Chef Software publishes across the network.

Chef Software ApplicationsService API
Chef Software Authorization API
Chef Software Cds API
Chef Software ChefIngester API
Chef Software Comp_Assets API
Chef Software ConfigMgmt API
Chef Software DatafeedService API
Chef Software DataLifecycle API
Chef Software EventFeedService API
Chef Software hidden API
Chef Software InfraProxy API
Chef Software JobScheduler API