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 Invites API

The User's Invites API from APIs.io Engineering Platform — 2 operation(s) for user's invites.

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

3 operations 2 paths 21 schemas 2 GET1 PATCH

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 Invites 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 3

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

User's Invites 3
GET
/user/invites
APIs.io Engineering Platform List Invitations
user'-s-invites-list-invitations → 4XX200
GET
/user/invites/{invite_id}
APIs.io Engineering Platform Invitation Details
user'-s-invites-invitation-details 1 param → 4XX200
PATCH
/user/invites/{invite_id}
APIs.io Engineering Platform Respond to Invitation
user'-s-invites-respond-to-invitation 1 param body → 4XX200

Schemas 21

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

iam_description
string
Description of role's permissions.
iam_result_info
object
4 properties
iam_schemas-permissions
array
Access permissions for this User.
iam_schemas-invite
object
iam_single_invite_response
iam_api-response-common
object
3 properties 3 required
iam_schemas-role
object
4 properties 4 required
iam_api-response-common-failure
object
4 properties 4 required
iam_api-response-collection
object
iam_invited_on
string
When the invite was sent.
iam_user_invite
iam_role_components-schemas-identifier
string
Role identifier tag.
iam_invite_components-schemas-identifier
string
Invite identifier tag.
iam_invited_member_email
string
Email address of the user to add to the organization.
iam_messages
array
iam_base
object
9 properties 2 required
iam_schemas-expires_on
string
When the invite is no longer active.
iam_schemas-collection_invite_response
iam_components-schemas-name
string
Role Name.
iam_api-response-single
object
iam_invited_by
string
The email address of the user who created the invite.

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

engineering-platform-user-s-invites-api-openapi.yml Raw ↑