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=GetSAMLProvider API

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

This API exposes 2 operations across 1 path, and defines 12 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 12 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=GetSAMLProvider 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=GetSAMLProvider 2
GET
/#Action=GetSAMLProvider
Returns the SAML provider metadocument that was uploaded when the IAM SAML provider resource object was created or updated. This operation requires Signature Version 4 .
GET_GetSAMLProvider 10 params → 200480481482
POST
/#Action=GetSAMLProvider
Returns the SAML provider metadocument that was uploaded when the IAM SAML provider resource object was created or updated. This operation requires Signature Version 4 .
POST_GetSAMLProvider 9 params body → 200480481482

Schemas 12

The contract defines 12 schemas that model the data the API accepts and returns. The most detailed are GetSAMLProviderResponse (4 properties), Tag (2 properties), GetSAMLProviderRequest (1 property). Each schema is shown below with its type and property counts.

InvalidInputException
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
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…
GetSAMLProviderResponse
object
Contains the response to a successful GetSAMLProvider request.
4 properties
tagKeyType
string
tagValueType
string
GetSAMLProviderRequest
object
1 property 1 required
SAMLMetadataDocumentType
string
NoSuchEntityException
dateType
string
ServiceFailureException

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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