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=ListGroups API

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

This API exposes 2 operations across 1 path, and defines 15 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 15 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=ListGroups 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=ListGroups 2
GET
/#Action=ListGroups
Lists the IAM groups that have the specified path prefix. You can paginate the results using the MaxItems and Marker parameters.
GET_ListGroups 12 params → 200480
POST
/#Action=ListGroups
Lists the IAM groups that have the specified path prefix. You can paginate the results using the MaxItems and Marker parameters.
POST_ListGroups 11 params body → 200480

Schemas 15

The contract defines 15 schemas that model the data the API accepts and returns. The most detailed are Group (5 properties), ListGroupsRequest (3 properties), ListGroupsResponse (3 properties). Each schema is shown below with its type and property counts.

ListGroupsResponse
object
Contains the response to a successful ListGroups request.
3 properties 1 required
responseMarkerType
string
arnType
string
The Amazon Resource Name (ARN). ARNs are unique identifiers for Amazon Web Services resources. For more information about ARNs, go to Amazon Resource Names (AR…
groupNameType
string
pathType
string
Group
object
Contains information about an IAM group entity. This data type is used as a response element in the following operations: CreateGroup GetGroup ListGroups
5 properties 5 required
markerType
string
booleanType
boolean
idType
string
ListGroupsRequest
object
3 properties
dateType
string
maxItemsType
integer
ServiceFailureException
groupListType
array
Contains a list of IAM groups. This data type is used as a response element in the ListGroups operation.
pathPrefixType
string

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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