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

APIs.io Engineering Platform Group Provisioning API

The **Group Provisioning** endpoints enable you to provision and manage your Postman groups.

This API exposes 5 operations across 2 paths, and defines 2 schemas. It is described by OpenAPI 3.0.0, at version 2015-07-09.

Requests are made against 4 base URLs: http://apigateway.{region}.amazonaws.com, https://apigateway.{region}.amazonaws.com, http://apigateway.{region}.amazonaws.com.cn, https://apigateway.{region}.amazonaws.com.cn.

5 operations 2 paths 2 schemas 1 DELETE2 GET1 PATCH1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
2015-07-09
Base URL
https://{bucketname}.s3.amazonaws.com
Authentication
API Key
Terms of Service
Resource Areas
1

Authentication & Security 1

APIs.io Engineering Platform Group Provisioning API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (hmac). By default, every request must be authenticated.

  • hmac — Amazon Signature authorization v4

Paths & Operations 5

Across 2 paths, the API surfaces 5 operations — 1 DELETE, 2 GET, 1 PATCH, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Group Provisioning 5

The Group Provisioning endpoints enable you to provision and manage your Postman groups.

GET
/scim/v2/Groups
APIs.io Engineering Platform Get all group resources
getScimGroupResources 3 params → 200400401403500
POST
/scim/v2/Groups
APIs.io Engineering Platform Create a group
createScimGroup body → 201400401403409500
GET
/scim/v2/Groups/{groupId}
APIs.io Engineering Platform Get a group resource
getScimGroupResource 1 param → 200400401403404500
PATCH
/scim/v2/Groups/{groupId}
APIs.io Engineering Platform Update a group
scimUpdateGroup 1 param body → 200400401403404500
DELETE
/scim/v2/Groups/{groupId}
APIs.io Engineering Platform Delete a group
deleteScimGroup 1 param → 204400401403404500

Schemas 2

The contract defines 2 schemas that model the data the API accepts and returns. The most detailed is scimGroupResource (6 properties). Each schema is shown below with its type and property counts.

scimGroupResource
object
The SCIM group resource object.
6 properties
scimId
string

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

engineering-platform-group-provisioning-api-openapi.yml Raw ↑