You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::IAM::Types::CreateOpenIDConnectProviderRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-iam/lib/aws-sdk-iam/types.rb

Overview

Note:

When making an API call, you may pass CreateOpenIDConnectProviderRequest data as a hash:

{
  url: "OpenIDConnectProviderUrlType", # required
  client_id_list: ["clientIDType"],
  thumbprint_list: ["thumbprintType"], # required
}

Instance Attribute Summary collapse

Instance Attribute Details

#client_id_listArray<String>

A list of client IDs (also known as audiences). When a mobile or web app registers with an OpenID Connect provider, they establish a value that identifies the application. (This is the value that's sent as the client_id parameter on OAuth requests.)

You can register multiple client IDs with the same provider. For example, you might have multiple applications that use the same OIDC provider. You cannot register more than 100 client IDs with a single IAM OIDC provider.

There is no defined format for a client ID. The CreateOpenIDConnectProviderRequest action accepts client IDs up to 255 characters long.

Returns:

  • (Array<String>)


833
834
835
836
837
838
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/types.rb', line 833

class CreateOpenIDConnectProviderRequest < Struct.new(
  :url,
  :client_id_list,
  :thumbprint_list)
  include Aws::Structure
end

#thumbprint_listArray<String>

A list of server certificate thumbprints for the OpenID Connect (OIDC) identity provider's server certificate(s). Typically this list includes only one entry. However, IAM lets you have up to five thumbprints for an OIDC provider. This lets you maintain multiple thumbprints if the identity provider is rotating certificates.

The server certificate thumbprint is the hex-encoded SHA-1 hash value of the X.509 certificate used by the domain where the OpenID Connect provider makes its keys available. It is always a 40-character string.

You must provide at least one thumbprint when creating an IAM OIDC provider. For example, if the OIDC provider is server.example.com and the provider stores its keys at "https://keys.server.example.com/openid-connect", the thumbprint string would be the hex-encoded SHA-1 hash value of the certificate used by https://keys.server.example.com.

For more information about obtaining the OIDC provider's thumbprint, see Obtaining the Thumbprint for an OpenID Connect Provider in the IAM User Guide.

Returns:

  • (Array<String>)


833
834
835
836
837
838
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/types.rb', line 833

class CreateOpenIDConnectProviderRequest < Struct.new(
  :url,
  :client_id_list,
  :thumbprint_list)
  include Aws::Structure
end

#urlString

The URL of the identity provider. The URL must begin with "https://" and should correspond to the iss claim in the provider's OpenID Connect ID tokens. Per the OIDC standard, path components are allowed but query parameters are not. Typically the URL consists of only a host name, like "https://server.example.org" or "https://example.com".

You cannot register the same provider multiple times in a single AWS account. If you try to submit a URL that has already been used for an OpenID Connect provider in the AWS account, you will get an error.

Returns:

  • (String)


833
834
835
836
837
838
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/types.rb', line 833

class CreateOpenIDConnectProviderRequest < Struct.new(
  :url,
  :client_id_list,
  :thumbprint_list)
  include Aws::Structure
end