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 User's Account Memberships API

The User's Account Memberships API from APIs.io Engineering Platform — 2 operation(s) for user's account memberships.

This API exposes 4 operations across 2 paths, and defines 32 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.

4 operations 2 paths 32 schemas 1 DELETE2 GET1 PUT

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 User's Account Memberships 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 4

Across 2 paths, the API surfaces 4 operations — 1 DELETE, 2 GET, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

User's Account Memberships 4
GET
/memberships
APIs.io Engineering Platform List Memberships
user'-s-account-memberships-list-memberships 7 params → 4XX200
DELETE
/memberships/{membership_id}
APIs.io Engineering Platform Delete Membership
user'-s-account-memberships-delete-membership 1 param body → 4XX200
GET
/memberships/{membership_id}
APIs.io Engineering Platform Membership Details
user'-s-account-memberships-membership-details 1 param → 4XX200
PUT
/memberships/{membership_id}
APIs.io Engineering Platform Update Membership
user'-s-account-memberships-update-membership 1 param body → 4XX200

Schemas 32

The contract defines 32 schemas that model the data the API accepts and returns. The most detailed are iam_permissions (12 properties), iam_membership-with-policies (7 properties), iam_membership (6 properties), iam_result_info (4 properties). Each schema is shown below with its type and property counts.

iam_scope
object
A scope is a combination of scope objects which provides additional context.
2 properties 2 required
iam_scope_key
This is a combination of pre-defined resource name and identifier (like Account ID etc.)
iam_permission_groups
array
A set of permission groups that are specified to the policy.
iam_identifier
string
Policy identifier.
iam_account
object
4 properties 2 required
iam_result_info
object
4 properties
iam_api-response-common
object
3 properties 3 required
iam_api-response-common-failure
object
4 properties 4 required
iam_scope_object_key
This is a combination of pre-defined resource name and identifier (like Zone ID etc.)
iam_api_access_enabled
boolean
Enterprise only. Indicates whether or not API access is enabled specifically for this user on a given account.
iam_grants
object
2 properties
iam_membership-with-policies
object
7 properties
iam_common_components-schemas-identifier
string
Identifier
iam_membership_components-schemas-identifier
string
Membership identifier tag.
iam_api-response-collection
object
iam_collection_membership_response_with_policies
iam_roles
array
List of role names for the user at the account.
iam_schemas-account
iam_schemas-status
string
Status of this membership.
iam_access
string
Allow or deny operations against the resources.
iam_resource_group
object
A group of scoped resources.
4 properties 2 required
iam_properties-name
string
Account name
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
iam_scope_object
object
A scope object represents any resource that can have actions applied against invite.
1 property 1 required
iam_resource_groups
array
A list of resource groups that the policy applies to.
iam_list_member_policy
object
4 properties
iam_permissions
object
12 properties
iam_collection_membership_response
iam_membership
object
6 properties
iam_api-response-single
object
iam_single_membership_response_with_policies

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

engineering-platform-user-s-account-memberships-api-openapi.yml Raw ↑