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 Account Permission Groups API

The Account Permission Groups API from APIs.io Engineering Platform — 2 operation(s) for account permission groups.

This API exposes 2 operations across 2 paths, and defines 10 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 2 paths 10 schemas 2 GET

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 Account Permission Groups 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 2 paths, the API surfaces 2 operations — 2 GET. Each is listed below with its method, path, parameters, and response codes.

Account Permission Groups 2
GET
/accounts/{account_id}/iam/permission_groups
APIs.io Engineering Platform List Account Permission Groups
account-permission-group-list 6 params → 4XX200
GET
/accounts/{account_id}/iam/permission_groups/{permission_group_id}
APIs.io Engineering Platform Permission Group Details
account-permission-group-details 2 params → 4XX200

Schemas 10

The contract defines 10 schemas that model the data the API accepts and returns. The most detailed are iam_result_info (4 properties), iam_api-response-common-failure (4 properties), iam_permission_group (3 properties), iam_api-response-common (3 properties). Each schema is shown below with its type and property counts.

iam_collection_permission_groups_response
iam_permission_groups
array
A set of permission groups that are specified to the policy.
iam_account_identifier
string
Account identifier tag.
iam_api-response-collection
object
iam_result_info
object
4 properties
iam_permission_group_components-schemas-identifier
string
Permission Group identifier tag.
iam_api-response-common
object
3 properties 3 required
iam_api-response-common-failure
object
4 properties 4 required
iam_permission_group
object
A named group of permissions that map to a group of operations against resources.
3 properties 1 required
iam_messages
array

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

engineering-platform-account-permission-groups-api-openapi.yml Raw ↑