Chef Software users 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 users. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and authentication docs.
This API exposes
6 operations
across 3 paths,
and defines 12 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.
6 operations3 paths12 schemas1 DELETE2 GET1 POST2 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 6
Across 3 paths, the API surfaces 6 operations — 1 DELETE, 2 GET, 1 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.
users 6
PUT
/apis/iam/v2/self/{id}
Update self (as user)
Users_UpdateSelf2 params→ 200default
GET
/apis/iam/v2/users
List all users
Users_ListUsers→ 200default
POST
/apis/iam/v2/users
Create a user
Users_CreateUser1 param→ 200default
GET
/apis/iam/v2/users/{id}
Get a user
Users_GetUser1 param→ 200default
DELETE
/apis/iam/v2/users/{id}
Delete a user
Users_DeleteUser1 param→ 200default
PUT
/apis/iam/v2/users/{id}
Update a user
Users_UpdateUser2 params→ 200default
Schemas 12
The contract defines 12 schemas that model the data the API accepts and returns. The most detailed are chef.automate.api.iam.v2.UpdateSelfReq (4 properties), grpc.gateway.runtime.Error (4 properties), chef.automate.api.iam.v2.CreateUserReq (3 properties), chef.automate.api.iam.v2.User (3 properties). Each schema is shown below with its type and property counts.
chef.automate.api.iam.v2.CreateUserReq
object
3 properties3 required
chef.automate.api.iam.v2.UpdateUserResp
object
1 property
chef.automate.api.iam.v2.UpdateSelfResp
object
1 property
chef.automate.api.iam.v2.ListUsersResp
object
1 property
chef.automate.api.iam.v2.User
object
3 properties
google.protobuf.Any
object
Any contains an arbitrary serialized protocol buffer message along with a URL that describes the type of the serialized message. Protobuf library provides supp…
2 properties
chef.automate.api.iam.v2.GetUserResp
object
1 property
chef.automate.api.iam.v2.DeleteUserResp
object
grpc.gateway.runtime.Error
object
4 properties
chef.automate.api.iam.v2.UpdateSelfReq
object
4 properties1 required
chef.automate.api.iam.v2.CreateUserResp
object
1 property
chef.automate.api.iam.v2.UpdateUserReq
object
3 properties1 required
Specification
The full machine-readable OpenAPI contract behind this narrative.
