| Copyright | (c) 2013-2021 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | None |
Amazonka.IAM.CreateOpenIDConnectProvider
Description
Creates an IAM entity to describe an identity provider (IdP) that supports OpenID Connect (OIDC).
The OIDC provider that you create with this operation can be used as a principal in a role's trust policy. Such a policy establishes a trust relationship between Amazon Web Services and the OIDC provider.
If you are using an OIDC identity provider from Google, Facebook, or Amazon Cognito, you don't need to create a separate IAM identity provider. These OIDC identity providers are already built-in to Amazon Web Services and are available for your use. Instead, you can move directly to creating new roles using your identity provider. To learn more, see Creating a role for web identity or OpenID connect federation in the IAM User Guide.
When you create the IAM OIDC provider, you specify the following:
- The URL of the OIDC identity provider (IdP) to trust
- A list of client IDs (also known as audiences) that identify the application or applications allowed to authenticate using the OIDC provider
- A list of thumbprints of one or more server certificates that the IdP uses
You get all of this information from the OIDC IdP you want to use to access Amazon Web Services.
Amazon Web Services secures communication with some OIDC identity providers (IdPs) through our library of trusted certificate authorities (CAs) instead of using a certificate thumbprint to verify your IdP server certificate. These OIDC IdPs include Google, and those that use an Amazon S3 bucket to host a JSON Web Key Set (JWKS) endpoint. In these cases, your legacy thumbprint remains in your configuration, but is no longer used for validation.
The trust for the OIDC provider is derived from the IAM provider that this operation creates. Therefore, it is best to limit access to the CreateOpenIDConnectProvider operation to highly privileged users.
Synopsis
- data CreateOpenIDConnectProvider = CreateOpenIDConnectProvider' {
- clientIDList :: Maybe [Text]
- tags :: Maybe [Tag]
- url :: Text
- thumbprintList :: [Text]
- newCreateOpenIDConnectProvider :: Text -> CreateOpenIDConnectProvider
- createOpenIDConnectProvider_clientIDList :: Lens' CreateOpenIDConnectProvider (Maybe [Text])
- createOpenIDConnectProvider_tags :: Lens' CreateOpenIDConnectProvider (Maybe [Tag])
- createOpenIDConnectProvider_url :: Lens' CreateOpenIDConnectProvider Text
- createOpenIDConnectProvider_thumbprintList :: Lens' CreateOpenIDConnectProvider [Text]
- data CreateOpenIDConnectProviderResponse = CreateOpenIDConnectProviderResponse' {
- openIDConnectProviderArn :: Maybe Text
- tags :: Maybe [Tag]
- httpStatus :: Int
- newCreateOpenIDConnectProviderResponse :: Int -> CreateOpenIDConnectProviderResponse
- createOpenIDConnectProviderResponse_openIDConnectProviderArn :: Lens' CreateOpenIDConnectProviderResponse (Maybe Text)
- createOpenIDConnectProviderResponse_tags :: Lens' CreateOpenIDConnectProviderResponse (Maybe [Tag])
- createOpenIDConnectProviderResponse_httpStatus :: Lens' CreateOpenIDConnectProviderResponse Int
Creating a Request
data CreateOpenIDConnectProvider Source #
See: newCreateOpenIDConnectProvider smart constructor.
Constructors
| CreateOpenIDConnectProvider' | |
Fields
| |
Instances
newCreateOpenIDConnectProvider Source #
Create a value of CreateOpenIDConnectProvider with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:clientIDList:CreateOpenIDConnectProvider', createOpenIDConnectProvider_clientIDList - 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.
$sel:tags:CreateOpenIDConnectProvider', createOpenIDConnectProvider_tags - 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.
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.
$sel:url:CreateOpenIDConnectProvider', createOpenIDConnectProvider_url - 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 https://server.example.org or
https://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.
$sel:thumbprintList:CreateOpenIDConnectProvider', createOpenIDConnectProvider_thumbprintList - 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
https://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 https://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.
Request Lenses
createOpenIDConnectProvider_clientIDList :: Lens' CreateOpenIDConnectProvider (Maybe [Text]) Source #
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.
createOpenIDConnectProvider_tags :: Lens' CreateOpenIDConnectProvider (Maybe [Tag]) Source #
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.
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.
createOpenIDConnectProvider_url :: Lens' CreateOpenIDConnectProvider Text Source #
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 https://server.example.org or
https://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.
createOpenIDConnectProvider_thumbprintList :: Lens' CreateOpenIDConnectProvider [Text] Source #
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
https://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 https://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.
Destructuring the Response
data CreateOpenIDConnectProviderResponse Source #
Contains the response to a successful CreateOpenIDConnectProvider request.
See: newCreateOpenIDConnectProviderResponse smart constructor.
Constructors
| CreateOpenIDConnectProviderResponse' | |
Fields
| |
Instances
newCreateOpenIDConnectProviderResponse Source #
Arguments
| :: Int | |
| -> CreateOpenIDConnectProviderResponse |
Create a value of CreateOpenIDConnectProviderResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:openIDConnectProviderArn:CreateOpenIDConnectProviderResponse', createOpenIDConnectProviderResponse_openIDConnectProviderArn - The Amazon Resource Name (ARN) of the new IAM OpenID Connect provider
that is created. For more information, see
OpenIDConnectProviderListEntry.
$sel:tags:CreateOpenIDConnectProvider', createOpenIDConnectProviderResponse_tags - A list of tags that are attached to the new IAM OIDC provider. The
returned list of tags is sorted by tag key. For more information about
tagging, see
Tagging IAM resources
in the IAM User Guide.
$sel:httpStatus:CreateOpenIDConnectProviderResponse', createOpenIDConnectProviderResponse_httpStatus - The response's http status code.
Response Lenses
createOpenIDConnectProviderResponse_openIDConnectProviderArn :: Lens' CreateOpenIDConnectProviderResponse (Maybe Text) Source #
The Amazon Resource Name (ARN) of the new IAM OpenID Connect provider that is created. For more information, see OpenIDConnectProviderListEntry.
createOpenIDConnectProviderResponse_tags :: Lens' CreateOpenIDConnectProviderResponse (Maybe [Tag]) Source #
A list of tags that are attached to the new IAM OIDC provider. The returned list of tags is sorted by tag key. For more information about tagging, see Tagging IAM resources in the IAM User Guide.
createOpenIDConnectProviderResponse_httpStatus :: Lens' CreateOpenIDConnectProviderResponse Int Source #
The response's http status code.