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

The Access Service Tokens API from APIs.io Engineering Platform — 4 operation(s) for access service tokens.

This API exposes 7 operations across 4 paths, and defines 17 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 17 schemas 1 DELETE2 GET3 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
Terms of Service
Resource Areas
1

Authentication & Security 1

APIs.io Engineering Platform Access Service 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, 2 GET, 3 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Access Service Tokens 7
GET
/accounts/{account_id}/access/service_tokens
APIs.io Engineering Platform List service tokens
access-service-tokens-list-service-tokens 1 param → 4XX200
POST
/accounts/{account_id}/access/service_tokens
APIs.io Engineering Platform Create a service token
access-service-tokens-create-a-service-token 1 param body → 4XX201
DELETE
/accounts/{account_id}/access/service_tokens/{service_token_id}
APIs.io Engineering Platform Delete a service token
access-service-tokens-delete-a-service-token 2 params → 4XX200
GET
/accounts/{account_id}/access/service_tokens/{service_token_id}
APIs.io Engineering Platform Get a service token
access-service-tokens-get-a-service-token 2 params → 4XX200
PUT
/accounts/{account_id}/access/service_tokens/{service_token_id}
APIs.io Engineering Platform Update a service token
access-service-tokens-update-a-service-token 2 params body → 4XX200
POST
/accounts/{account_id}/access/service_tokens/{service_token_id}/refresh
APIs.io Engineering Platform Refresh a service token
access-service-tokens-refresh-a-service-token 2 params → 4XX200
POST
/accounts/{account_id}/access/service_tokens/{service_token_id}/rotate
APIs.io Engineering Platform Rotate a service token
access-service-tokens-rotate-a-service-token 2 params → 4XX200

Schemas 17

The contract defines 17 schemas that model the data the API accepts and returns. The most detailed are access_service-tokens (7 properties), access_api-response-common-failure (4 properties), access_result_info (4 properties), access_api-response-common (3 properties). Each schema is shown below with its type and property counts.

access_create_response
access_client_id
string
The Client ID for the service token. Access will check for this value in the CF-Access-Client-ID request header.
access_schemas-name
string
The name of the service token.
access_api-response-common
object
3 properties 3 required
access_components-schemas-response_collection
access_result_info
object
4 properties
access_api-response-common-failure
object
4 properties 4 required
access_identifier
string
Identifier
access_messages
array
access_api-response-collection
object
access_service-tokens
object
7 properties
access_uuid
string
UUID
access_client_secret
string
The Client Secret for the service token. Access will check for this value in the CF-Access-Client-Secret request header.
access_duration
string
The duration for how long the service token will be valid. Must be in the format 300ms or 2h45m. Valid time units are: ns, us (or µs), ms, s, m, h. The default…
access_timestamp
string
access_api-response-single
object
access_schemas-single_response

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

engineering-platform-access-service-tokens-api-openapi.yml Raw ↑