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 #Action=AddUserToGroup API

The #Action=AddUserToGroup API from APIs.io Engineering Platform — 1 operation(s) for #action=addusertogroup.

This API exposes 2 operations across 1 path, and defines 6 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.

2 operations 1 paths 6 schemas 1 GET1 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 #Action=AddUserToGroup 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 2

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

#Action=AddUserToGroup 2
GET
/#Action=AddUserToGroup
Adds the specified user to the specified group.
GET_AddUserToGroup 11 params → 200480481482
POST
/#Action=AddUserToGroup
Adds the specified user to the specified group.
POST_AddUserToGroup 9 params body → 200480481482

Schemas 6

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

existingUserNameType
string
ServiceFailureException
NoSuchEntityException
LimitExceededException
groupNameType
string
AddUserToGroupRequest
object
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

engineering-platform-action-addusertogroup-api-openapi.yml Raw ↑