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

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

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=ListEntitiesForPolicy 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=ListEntitiesForPolicy 2
GET
/#Action=ListEntitiesForPolicy
Lists all IAM users, groups, and roles that the specified managed policy is attached to. You can use the optional EntityFilter parameter to limit the results to a particular type of entity (users, gr…
GET_ListEntitiesForPolicy 15 params → 200480481482
POST
/#Action=ListEntitiesForPolicy
Lists all IAM users, groups, and roles that the specified managed policy is attached to. You can use the optional EntityFilter parameter to limit the results to a particular type of entity (users, gr…
POST_ListEntitiesForPolicy 11 params body → 200480481482

Schemas 23

The contract defines 23 schemas that model the data the API accepts and returns. The most detailed are ListEntitiesForPolicyRequest (6 properties), ListEntitiesForPolicyResponse (5 properties), PolicyGroup (2 properties), PolicyRole (2 properties). Each schema is shown below with its type and property counts.

PolicyGroup
object
Contains information about a group that a managed policy is attached to. This data type is used as a response element in the ListEntitiesForPolicy operation. F…
2 properties
InvalidInputException
EntityType
string
PolicyUserListType
array
PolicyRole
object
Contains information about a role that a managed policy is attached to. This data type is used as a response element in the ListEntitiesForPolicy operation. Fo…
2 properties
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
markerType
string
PolicyUsageType
string
The policy usage type that indicates whether the policy is used as a permissions policy or as the permissions boundary for an entity. For more information abou…
booleanType
boolean
idType
string
ListEntitiesForPolicyRequest
object
6 properties 1 required
PolicyRoleListType
array
NoSuchEntityException
ListEntitiesForPolicyResponse
object
Contains the response to a successful ListEntitiesForPolicy request.
5 properties
roleNameType
string
maxItemsType
integer
ServiceFailureException
PolicyGroupListType
array
PolicyUser
object
Contains information about a user that a managed policy is attached to. This data type is used as a response element in the ListEntitiesForPolicy operation. Fo…
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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