Chef Software roles 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 roles. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and authentication docs.
This API exposes
5 operations
across 2 paths,
and defines 11 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.
5 operations2 paths11 schemas1 DELETE2 GET1 POST1 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 5
Across 2 paths, the API surfaces 5 operations — 1 DELETE, 2 GET, 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.
roles 5
GET
/apis/iam/v2/roles
Lists all roles
Policies_ListRoles→ 200default
POST
/apis/iam/v2/roles
Creates a custom role
Policies_CreateRole1 param→ 200default
GET
/apis/iam/v2/roles/{id}
Gets a role
Policies_GetRole1 param→ 200default
DELETE
/apis/iam/v2/roles/{id}
Deletes a custom role
Policies_DeleteRole1 param→ 200default
PUT
/apis/iam/v2/roles/{id}
Updates a custom role
Policies_UpdateRole2 params→ 200default
Schemas 11
The contract defines 11 schemas that model the data the API accepts and returns. The most detailed are chef.automate.api.iam.v2.Role (5 properties), chef.automate.api.iam.v2.UpdateRoleReq (4 properties), chef.automate.api.iam.v2.CreateRoleReq (4 properties), grpc.gateway.runtime.Error (4 properties). Each schema is shown below with its type and property counts.
chef.automate.api.iam.v2.Role
object
5 properties
chef.automate.api.iam.v2.UpdateRoleReq
object
4 properties3 required
chef.automate.api.iam.v2.ListRolesResp
object
1 property
chef.automate.api.iam.v2.CreateRoleReq
object
Does not contain type as the enduser can only create 'custom' roles.
4 properties3 required
chef.automate.api.iam.v2.DeleteRoleResp
object
chef.automate.api.iam.v2.GetRoleResp
object
1 property
chef.automate.api.iam.v2.Type
string
grpc.gateway.runtime.Error
object
4 properties
chef.automate.api.iam.v2.UpdateRoleResp
object
1 property
chef.automate.api.iam.v2.CreateRoleResp
object
1 property
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
Specification
The full machine-readable OpenAPI contract behind this narrative.
