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

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

This API exposes 2 operations across 1 path, and defines 16 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 16 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=GetOpenIDConnectProvider 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=GetOpenIDConnectProvider 2
GET
/#Action=GetOpenIDConnectProvider
Returns information about the specified OpenID Connect (OIDC) provider resource object in IAM.
GET_GetOpenIDConnectProvider 10 params → 200480481482
POST
/#Action=GetOpenIDConnectProvider
Returns information about the specified OpenID Connect (OIDC) provider resource object in IAM.
POST_GetOpenIDConnectProvider 9 params body → 200480481482

Schemas 16

The contract defines 16 schemas that model the data the API accepts and returns. The most detailed are GetOpenIDConnectProviderResponse (5 properties), Tag (2 properties), GetOpenIDConnectProviderRequest (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…
GetOpenIDConnectProviderResponse
object
Contains the response to a successful GetOpenIDConnectProvider request.
5 properties
clientIDListType
array
tagKeyType
string
tagValueType
string
thumbprintType
string
Contains a thumbprint for an identity provider's server certificate. The identity provider's server certificate thumbprint is the hex-encoded SHA-1 hash value…
GetOpenIDConnectProviderRequest
object
1 property 1 required
NoSuchEntityException
dateType
string
ServiceFailureException
OpenIDConnectProviderUrlType
string
Contains a URL that specifies the endpoint for an OpenID Connect provider.
thumbprintListType
array
Contains a list of thumbprints of identity provider server certificates.
clientIDType
string

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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