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

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

This API exposes 2 operations across 1 path, and defines 23 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 23 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=GetGroup 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=GetGroup 2
GET
/#Action=GetGroup
Returns a list of IAM users that are in the specified IAM group. You can paginate the results using the MaxItems and Marker parameters.
GET_GetGroup 12 params → 200480481
POST
/#Action=GetGroup
Returns a list of IAM users that are in the specified IAM group. You can paginate the results using the MaxItems and Marker parameters.
POST_GetGroup 11 params body → 200480481

Schemas 23

The contract defines 23 schemas that model the data the API accepts and returns. The most detailed are User (8 properties), Group (5 properties), GetGroupResponse (4 properties), GetGroupRequest (3 properties). Each schema is shown below with its type and property counts.

userListType
array
Contains a list of users. This data type is used as a response element in the GetGroup and ListUsers operations.
tagListType
array
Tag
object
A structure that represents user-provided metadata that can be associated with an IAM resource. For more information about tagging, see Tagging IAM resources i…
2 properties 2 required
userNameType
string
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
GetGroupRequest
object
3 properties 1 required
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
tagKeyType
string
tagValueType
string
booleanType
boolean
idType
string
AttachedPermissionsBoundary
object
Contains information about an attached permissions boundary. An attached permissions boundary is a managed policy that has been attached to a user or role to s…
2 properties
NoSuchEntityException
dateType
string
GetGroupResponse
object
Contains the response to a successful GetGroup request.
4 properties 2 required
maxItemsType
integer
ServiceFailureException
User
object
Contains information about an IAM user entity. This data type is used as a response element in the following operations: CreateUser GetUser ListUsers
8 properties 5 required
PermissionsBoundaryAttachmentType
string

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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