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 teams API

The teams API from Chef Software — 6 operation(s) for teams.

Chef Software teams 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 teams. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and authentication docs.

This API exposes 9 operations across 6 paths, and defines 16 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.

9 operations 6 paths 16 schemas 1 DELETE4 GET3 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 9

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

teams 9
GET
/apis/iam/v2/teams
Lists all local teams
Teams_ListTeams → 200default
POST
/apis/iam/v2/teams
Creates a local team
Teams_CreateTeam 1 param → 200default
GET
/apis/iam/v2/teams/{id}
Get a team
Teams_GetTeam 1 param → 200default
DELETE
/apis/iam/v2/teams/{id}
Deletes a local team
Teams_DeleteTeam 1 param → 200default
PUT
/apis/iam/v2/teams/{id}
Updates a local team
Teams_UpdateTeam 2 params → 200default
GET
/apis/iam/v2/teams/{id}/users
Gets local team membership
Teams_GetTeamMembership 1 param → 200default
POST
/apis/iam/v2/teams/{id}/users:add
Adds local team membership
Teams_AddTeamMembers 2 params → 200default
POST
/apis/iam/v2/teams/{id}/users:remove
Removes local team membership
Teams_RemoveTeamMembers 2 params → 200default
GET
/apis/iam/v2/users/{membership_id}/teams
Gets team membership for a user
Teams_GetTeamsForMember 1 param → 200default

Schemas 16

The contract defines 16 schemas that model the data the API accepts and returns. The most detailed are grpc.gateway.runtime.Error (4 properties), chef.automate.api.iam.v2.Team (3 properties), chef.automate.api.iam.v2.CreateTeamReq (3 properties), chef.automate.api.iam.v2.UpdateTeamReq (3 properties). Each schema is shown below with its type and property counts.

chef.automate.api.iam.v2.GetTeamMembershipResp
object
1 property
chef.automate.api.iam.v2.UpdateTeamReq
object
3 properties 2 required
chef.automate.api.iam.v2.RemoveTeamMembersResp
object
1 property
chef.automate.api.iam.v2.AddTeamMembersReq
object
2 properties 2 required
chef.automate.api.iam.v2.CreateTeamResp
object
1 property
chef.automate.api.iam.v2.CreateTeamReq
object
3 properties 2 required
chef.automate.api.iam.v2.Team
object
3 properties
chef.automate.api.iam.v2.ListTeamsResp
object
1 property
chef.automate.api.iam.v2.UpdateTeamResp
object
1 property
chef.automate.api.iam.v2.RemoveTeamMembersReq
object
2 properties 2 required
chef.automate.api.iam.v2.DeleteTeamResp
object
1 property
grpc.gateway.runtime.Error
object
4 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.GetTeamsForMemberResp
object
1 property
chef.automate.api.iam.v2.GetTeamResp
object
1 property
chef.automate.api.iam.v2.AddTeamMembersResp
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

chef-software-teams-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