APIs.io Engineering Platform Account Members API

The Account Members API from APIs.io Engineering Platform — 2 operation(s) for account members.

Documentation Provider Profile APIs.io OpenAPI GitHub

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

5 operations 2 paths 46 schemas 1 DELETE2 GET1 POST1 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

Contact

Mike Ralphson

License

Apache 2.0 License

View terms

Resource Areas

Authentication & Security 1

APIs.io Engineering Platform Account Members 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 5

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

Account Members 5

GET

/accounts/{account_id}/members

APIs.io Engineering Platform List Members

account-members-list-members 6 params → 4XX200

POST

/accounts/{account_id}/members

APIs.io Engineering Platform Add Member

account-members-add-member 1 param body → 4XX200

DELETE

/accounts/{account_id}/members/{member_id}

APIs.io Engineering Platform Remove Member

account-members-remove-member 2 params body → 4XX200

GET

/accounts/{account_id}/members/{member_id}

APIs.io Engineering Platform Member Details

account-members-member-details 2 params → 4XX200

PUT

/accounts/{account_id}/members/{member_id}

APIs.io Engineering Platform Update Member

account-members-update-member 2 params body → 4XX200

Schemas 46

The contract defines 46 schemas that model the data the API accepts and returns. The most detailed are iam_permissions (12 properties), iam_member_with_policies (5 properties), iam_resource_group (4 properties), iam_create_member_policy (4 properties). Each schema is shown below with its type and property counts.

iam_last_name

string

User's last name

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_description

string

Description of role's permissions.

iam_permission_groups

array

A set of permission groups that are specified to the policy.

iam_identifier

string

Policy identifier.

iam_account_identifier

string

Account identifier tag.

iam_schemas-permissions

array

Access permissions for this User.

iam_result_info

object

4 properties

iam_schemas-role

object

4 properties 4 required

iam_collection_member_response_with_policies

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_grants

object

2 properties

iam_single_member_response_with_policies

iam_member_with_policies

object

5 properties

iam_common_components-schemas-identifier

string

Identifier

iam_membership_components-schemas-identifier

string

Membership identifier tag.

iam_api-response-collection

object

iam_two_factor_authentication_enabled

boolean

Indicates whether two-factor authentication is enabled for the user account. Does not apply to API authentication.

iam_first_name

string

User's first name

iam_member

object

4 properties

iam_member_permission_group

object

A group of permissions.

1 property 1 required

iam_member_resource_groups

array

A list of resource groups that the policy applies to.

iam_role_components-schemas-identifier

string

Role identifier tag.

iam_update-member-with-roles

iam_member_resource_group

object

A group of scoped resources.

1 property 1 required

iam_access

string

Allow or deny operations against the resources.

iam_member_permission_groups

array

A set of permission groups that are specified to the policy.

iam_resource_group

object

A group of scoped resources.

4 properties 2 required

iam_permission_group

object

A named group of permissions that map to a group of operations against resources.

3 properties 1 required

iam_update-member-with-policies

object

1 property 1 required

iam_scope_object

object

A scope object represents any resource that can have actions applied against invite.

1 property 1 required

iam_messages

array

iam_create-member-with-roles

object

3 properties 2 required

iam_resource_groups

array

A list of resource groups that the policy applies to.

iam_email

string

The contact email address of the user.

iam_create-member-with-policies

object

3 properties 2 required

iam_list_member_policy

object

4 properties

iam_permissions

object

12 properties

iam_create_member_policy

object

4 properties 4 required

iam_api-response-single-id

object

iam_components-schemas-name

string

Role Name.

iam_api-response-single

object

iam_role

object

4 properties 4 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

#Account Members

← Back to A APIs

Discovery

Learnings

Guidance

Toolbox

Alignment

API Evangelist LLC

APIs.io Engineering Platform Account Members API

Metadata

Authentication & Security 1

Paths & Operations 5

Schemas 46

Specification

Source

API Details

Provider

Explore more