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 #Action=GetUser API

The #Action=GetUser API from APIs.io Engineering Platform — 1 operation(s) for #action=getuser.

This API exposes 2 operations across 1 path, 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.

2 operations 1 paths 17 schemas 1 GET1 POST

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 #Action=GetUser 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 2

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

#Action=GetUser 2
GET
/#Action=GetUser
Retrieves information about the specified IAM user, including the user's creation date, path, unique ID, and ARN. If you do not specify a user name, IAM determines the user name implicitly based on t…
GET_GetUser 10 params → 200480481
POST
/#Action=GetUser
Retrieves information about the specified IAM user, including the user's creation date, path, unique ID, and ARN. If you do not specify a user name, IAM determines the user name implicitly based on t…
POST_GetUser 9 params body → 200480481

Schemas 17

The contract defines 17 schemas that model the data the API accepts and returns. The most detailed are User (8 properties), AttachedPermissionsBoundary (2 properties), Tag (2 properties), GetUserRequest (1 property). Each schema is shown below with its type and property counts.

tagListType
array
Tag
object
A structure that represents user-provided metadata that can be associated with an IAM resource. For more information about tagging, see Tagging IAM resources i…
2 properties 2 required
userNameType
string
arnType
string
The Amazon Resource Name (ARN). ARNs are unique identifiers for Amazon Web Services resources. For more information about ARNs, go to Amazon Resource Names (AR…
GetUserResponse
object
Contains the response to a successful GetUser request.
1 property 1 required
GetUserRequest
object
1 property
pathType
string
tagKeyType
string
tagValueType
string
idType
string
AttachedPermissionsBoundary
object
Contains information about an attached permissions boundary. An attached permissions boundary is a managed policy that has been attached to a user or role to s…
2 properties
NoSuchEntityException
dateType
string
ServiceFailureException
existingUserNameType
string
User
object
Contains information about an IAM user entity. This data type is used as a response element in the following operations: CreateUser GetUser ListUsers
8 properties 5 required
PermissionsBoundaryAttachmentType
string

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

engineering-platform-action-getuser-api-openapi.yml Raw ↑