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

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
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
  tags: [
    {
      key: "tagKeyType", # required
      value: "tagValueType", # required
    },
  ],
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#client_id_listArray<String>

Provides 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` operation accepts client IDs up to 255 characters long.

Returns:

  • (Array<String>)

1045
1046
1047
1048
1049
1050
1051
1052
# File 'lib/aws-sdk-iam/types.rb', line 1045

class CreateOpenIDConnectProviderRequest < Struct.new(
  :url,
  :client_id_list,
  :thumbprint_list,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#tagsArray<Types::Tag>

A list of tags that you want to attach to the new IAM OpenID Connect (OIDC) provider. Each tag consists of a key name and an associated value. For more information about tagging, see [Tagging IAM resources] in the *IAM User Guide*.

<note markdown=“1”> If any one of the tags is invalid or if you exceed the allowed maximum number of tags, then the entire request fails and the resource is not created.

</note>

[1]: docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html

Returns:


1045
1046
1047
1048
1049
1050
1051
1052
# File 'lib/aws-sdk-iam/types.rb', line 1045

class CreateOpenIDConnectProviderRequest < Struct.new(
  :url,
  :client_id_list,
  :thumbprint_list,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#thumbprint_listArray<String>

A list of server certificate thumbprints for the OpenID Connect (OIDC) identity provider's server certificates. 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, assume that the OIDC provider is `server.example.com` and the provider stores its keys at keys.server.example.com/openid-connect. In that case, the thumbprint string would be the hex-encoded SHA-1 hash value of the certificate used by `keys.server.example.com.`

For more information about obtaining the OIDC provider thumbprint, see [Obtaining the thumbprint for an OpenID Connect provider] in the *IAM User Guide*.

[1]: docs.aws.amazon.com/IAM/latest/UserGuide/identity-providers-oidc-obtain-thumbprint.html

Returns:

  • (Array<String>)

1045
1046
1047
1048
1049
1050
1051
1052
# File 'lib/aws-sdk-iam/types.rb', line 1045

class CreateOpenIDConnectProviderRequest < Struct.new(
  :url,
  :client_id_list,
  :thumbprint_list,
  :tags)
  SENSITIVE = []
  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 hostname, like `server.example.org` or `example.com`. The URL should not contain a port number.

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

Returns:

  • (String)

1045
1046
1047
1048
1049
1050
1051
1052
# File 'lib/aws-sdk-iam/types.rb', line 1045

class CreateOpenIDConnectProviderRequest < Struct.new(
  :url,
  :client_id_list,
  :thumbprint_list,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end