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

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

This API exposes 2 operations across 1 path, and defines 16 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 16 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=ListGroupsForUser 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=ListGroupsForUser 2
GET
/#Action=ListGroupsForUser
Lists the IAM groups that the specified IAM user belongs to. You can paginate the results using the MaxItems and Marker parameters.
GET_ListGroupsForUser 12 params → 200480481
POST
/#Action=ListGroupsForUser
Lists the IAM groups that the specified IAM user belongs to. You can paginate the results using the MaxItems and Marker parameters.
POST_ListGroupsForUser 11 params body → 200480481

Schemas 16

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

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
markerType
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
booleanType
boolean
idType
string
NoSuchEntityException
dateType
string
ListGroupsForUserRequest
object
3 properties 1 required
maxItemsType
integer
ServiceFailureException
existingUserNameType
string
groupListType
array
Contains a list of IAM groups. This data type is used as a response element in the ListGroups operation.
ListGroupsForUserResponse
object
Contains the response to a successful ListGroupsForUser request.
3 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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