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

The User API Tokens API from APIs.io Engineering Platform — 4 operation(s) for user api tokens.

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

7 operations 4 paths 36 schemas 1 DELETE3 GET1 POST2 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 API Tokens 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 7

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

User API Tokens 7
GET
/user/tokens
APIs.io Engineering Platform List Tokens
user-api-tokens-list-tokens 3 params → 4XX200
POST
/user/tokens
APIs.io Engineering Platform Create Token
user-api-tokens-create-token body → 4XX200
DELETE
/user/tokens/{token_id}
APIs.io Engineering Platform Delete Token
user-api-tokens-delete-token 1 param body → 4XX200
GET
/user/tokens/{token_id}
APIs.io Engineering Platform Token Details
user-api-tokens-token-details 1 param → 4XX200
PUT
/user/tokens/{token_id}
APIs.io Engineering Platform Update Token
user-api-tokens-update-token 1 param body → 4XX200
PUT
/user/tokens/{token_id}/value
APIs.io Engineering Platform Roll Token
user-api-tokens-roll-token 1 param body → 4XX200
GET
/user/tokens/verify
APIs.io Engineering Platform Verify Token
user-api-tokens-verify-token → 4XX200

Schemas 36

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

iam_token_identifier
string
Token identifier tag.
iam_condition
object
1 property
iam_identifier
string
Policy identifier.
iam_permission_groups
array
A set of permission groups that are specified to the policy.
iam_value
string
The token value.
iam_result_info
object
4 properties
iam_api-response-common
object
3 properties 3 required
iam_create_payload
object
5 properties 2 required
iam_api-response-common-failure
object
4 properties 4 required
iam_token_base
object
10 properties
iam_status
string
Status of the token.
iam_request_ip
object
Client IP restrictions.
2 properties
iam_common_components-schemas-identifier
string
Identifier
iam_api-response-collection
object
iam_response_single_segment
iam_name
string
Token name.
iam_last_used_on
string
Last time the token was used.
iam_token_body
iam_resources
object
A list of resource names that the policy applies to.
2 properties
iam_modified_on
string
Last time the token was modified.
iam_token_policies
array
List of access policies assigned to the token.
iam_cidr_list
array
List of IPv4/IPv6 CIDR addresses.
iam_single_token_response
iam_permission_group
object
A named group of permissions that map to a group of operations against resources.
3 properties 1 required
iam_response_single_value
iam_messages
array
iam_single_token_create_response
iam_effect
string
Allow or deny operations against the resources.
iam_expires_on
string
The expiration time on or after which the JWT MUST NOT be accepted for processing.
iam_not_before
string
The time before which the token MUST NOT be accepted for processing.
iam_api-response-single-id
object
iam_collection_tokens_response
iam_policy_with_permission_groups_and_resources
object
4 properties 4 required
iam_issued_on
string
The time on which the token was created.
iam_api-response-single
object
iam_token_with_value

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

engineering-platform-user-api-tokens-api-openapi.yml Raw ↑