aws-sdk-iam 1.167.0 → 1.168.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +5 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-iam/client.rb +644 -9
- data/lib/aws-sdk-iam/client_api.rb +70 -0
- data/lib/aws-sdk-iam/resource.rb +34 -0
- data/lib/aws-sdk-iam/saml_provider.rb +103 -0
- data/lib/aws-sdk-iam/types.rb +435 -7
- data/lib/aws-sdk-iam.rb +1 -1
- data/sig/client.rbs +28 -3
- data/sig/params.rbs +25 -0
- data/sig/resource.rbs +13 -1
- data/sig/saml_provider.rbs +27 -1
- data/sig/types.rbs +46 -0
- metadata +2 -1
data/lib/aws-sdk-iam/client.rb
CHANGED
|
@@ -1747,8 +1747,18 @@ module Aws::IAM
|
|
|
1747
1747
|
# * A list of thumbprints of one or more server certificates that the
|
|
1748
1748
|
# IdP uses
|
|
1749
1749
|
#
|
|
1750
|
-
#
|
|
1751
|
-
#
|
|
1750
|
+
# * A trusted identity propagation context provider that defines how the
|
|
1751
|
+
# subject is derived and how keys from the provider's token are
|
|
1752
|
+
# mapped into trusted context keys. Specifying a context provider
|
|
1753
|
+
# enables trusted identity propagation for the provider. For more
|
|
1754
|
+
# information, see [ContextProvider][3].
|
|
1755
|
+
#
|
|
1756
|
+
# * The ARN of an IAM Identity Center instance to associate with the
|
|
1757
|
+
# OIDC provider. If you specify an IAM Identity Center instance, you
|
|
1758
|
+
# must also specify a context provider.
|
|
1759
|
+
#
|
|
1760
|
+
# You get the URL, client IDs, and thumbprints from the OIDC IdP you
|
|
1761
|
+
# want to use to access Amazon Web Services.
|
|
1752
1762
|
#
|
|
1753
1763
|
# <note markdown="1"> Amazon Web Services secures communication with OIDC identity providers
|
|
1754
1764
|
# (IdPs) using our library of trusted root certificate authorities (CAs)
|
|
@@ -1761,15 +1771,32 @@ module Aws::IAM
|
|
|
1761
1771
|
#
|
|
1762
1772
|
# <note markdown="1"> The trust for the OIDC provider is derived from the IAM provider that
|
|
1763
1773
|
# this operation creates. Therefore, it is best to limit access to the
|
|
1764
|
-
# [CreateOpenIDConnectProvider][
|
|
1774
|
+
# [CreateOpenIDConnectProvider][4] operation to highly privileged users.
|
|
1765
1775
|
#
|
|
1766
1776
|
# </note>
|
|
1767
1777
|
#
|
|
1778
|
+
# To control who can configure trusted identity propagation on an OIDC
|
|
1779
|
+
# provider, use the [iam:EnableIdentityPropagation][5],
|
|
1780
|
+
# [iam:EnableIdentityCenterAssociation][6],
|
|
1781
|
+
# [iam:RequestIdentityProviderIssuers][7],
|
|
1782
|
+
# [iam:ResourceIdentityProviderIssuers][8],
|
|
1783
|
+
# [iam:RequestIdentityCenterInstanceArn][9], and
|
|
1784
|
+
# [iam:ResourceIdentityCenterInstanceArn][10] condition keys in IAM
|
|
1785
|
+
# policies. The `Request` keys contain the values in the request. The
|
|
1786
|
+
# `Resource` keys contain the values stored on the provider.
|
|
1787
|
+
#
|
|
1768
1788
|
#
|
|
1769
1789
|
#
|
|
1770
1790
|
# [1]: http://openid.net/connect/
|
|
1771
1791
|
# [2]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_create_for-idp_oidc.html
|
|
1772
|
-
# [3]: https://docs.aws.amazon.com/IAM/latest/APIReference/
|
|
1792
|
+
# [3]: https://docs.aws.amazon.com/IAM/latest/APIReference/API_ContextProvider.html
|
|
1793
|
+
# [4]: https://docs.aws.amazon.com/IAM/latest/APIReference/API_CreateOpenIDConnectProvider.html
|
|
1794
|
+
# [5]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_iam-condition-keys.html#ck_EnableIdentityPropagation
|
|
1795
|
+
# [6]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_iam-condition-keys.html#ck_EnableIdentityCenterAssociation
|
|
1796
|
+
# [7]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_iam-condition-keys.html#ck_RequestIdentityProviderIssuers
|
|
1797
|
+
# [8]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_iam-condition-keys.html#ck_ResourceIdentityProviderIssuers
|
|
1798
|
+
# [9]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_iam-condition-keys.html#ck_RequestIdentityCenterInstanceArn
|
|
1799
|
+
# [10]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_iam-condition-keys.html#ck_ResourceIdentityCenterInstanceArn
|
|
1773
1800
|
#
|
|
1774
1801
|
# @option params [required, String] :url
|
|
1775
1802
|
# The URL of the identity provider. The URL must begin with `https://`
|
|
@@ -1850,6 +1877,30 @@ module Aws::IAM
|
|
|
1850
1877
|
#
|
|
1851
1878
|
# [1]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html
|
|
1852
1879
|
#
|
|
1880
|
+
# @option params [Types::ContextProvider] :context_provider
|
|
1881
|
+
# The trusted identity propagation context provider configuration to
|
|
1882
|
+
# associate with the OpenID Connect (OIDC) provider. The context
|
|
1883
|
+
# provider defines how the subject is derived and how keys from the
|
|
1884
|
+
# provider's token are mapped into trusted context keys. Specifying a
|
|
1885
|
+
# context provider enables trusted identity propagation for the
|
|
1886
|
+
# provider. For more information, see [ContextProvider][1].
|
|
1887
|
+
#
|
|
1888
|
+
#
|
|
1889
|
+
#
|
|
1890
|
+
# [1]: https://docs.aws.amazon.com/IAM/latest/APIReference/API_ContextProvider.html
|
|
1891
|
+
#
|
|
1892
|
+
# @option params [String] :identity_center_instance_arn
|
|
1893
|
+
# The Amazon Resource Name (ARN) of the IAM Identity Center instance to
|
|
1894
|
+
# associate with the OpenID Connect (OIDC) provider. If you specify this
|
|
1895
|
+
# parameter, you must also specify `ContextProvider`.
|
|
1896
|
+
#
|
|
1897
|
+
# For the format, see [InstanceMetadata][1] in the *IAM Identity Center
|
|
1898
|
+
# API Reference*.
|
|
1899
|
+
#
|
|
1900
|
+
#
|
|
1901
|
+
#
|
|
1902
|
+
# [1]: https://docs.aws.amazon.com/singlesignon/latest/APIReference/API_InstanceMetadata.html
|
|
1903
|
+
#
|
|
1853
1904
|
# @return [Types::CreateOpenIDConnectProviderResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
1854
1905
|
#
|
|
1855
1906
|
# * {Types::CreateOpenIDConnectProviderResponse#open_id_connect_provider_arn #open_id_connect_provider_arn} => String
|
|
@@ -1876,6 +1927,37 @@ module Aws::IAM
|
|
|
1876
1927
|
# open_id_connect_provider_arn: "arn:aws:iam::123456789012:oidc-provider/server.example.com",
|
|
1877
1928
|
# }
|
|
1878
1929
|
#
|
|
1930
|
+
# @example Example: To create an OIDC provider with trusted identity propagation
|
|
1931
|
+
#
|
|
1932
|
+
# # The following example creates an OIDC provider with a context provider that uses the sub claim as the subject and maps
|
|
1933
|
+
# # the department claim to a trusted context key. It also associates an IAM Identity Center instance with the provider.
|
|
1934
|
+
#
|
|
1935
|
+
# resp = client.create_open_id_connect_provider({
|
|
1936
|
+
# client_id_list: [
|
|
1937
|
+
# "my-application-id",
|
|
1938
|
+
# ],
|
|
1939
|
+
# context_provider: {
|
|
1940
|
+
# key_definition_list: [
|
|
1941
|
+
# {
|
|
1942
|
+
# source_key: "department",
|
|
1943
|
+
# target_key: "department",
|
|
1944
|
+
# },
|
|
1945
|
+
# ],
|
|
1946
|
+
# subject_source_key: "sub",
|
|
1947
|
+
# subject_type_value: "user",
|
|
1948
|
+
# },
|
|
1949
|
+
# identity_center_instance_arn: "arn:aws:sso:::instance/ssoins-1234567890abcdef",
|
|
1950
|
+
# thumbprint_list: [
|
|
1951
|
+
# "3768084dfb3d2b68b7897bf5f565da8efEXAMPLE",
|
|
1952
|
+
# ],
|
|
1953
|
+
# url: "https://server.example.com",
|
|
1954
|
+
# })
|
|
1955
|
+
#
|
|
1956
|
+
# resp.to_h outputs the following:
|
|
1957
|
+
# {
|
|
1958
|
+
# open_id_connect_provider_arn: "arn:aws:iam::123456789012:oidc-provider/server.example.com",
|
|
1959
|
+
# }
|
|
1960
|
+
#
|
|
1879
1961
|
# @example Request syntax with placeholder values
|
|
1880
1962
|
#
|
|
1881
1963
|
# resp = client.create_open_id_connect_provider({
|
|
@@ -1888,6 +1970,18 @@ module Aws::IAM
|
|
|
1888
1970
|
# value: "tagValueType", # required
|
|
1889
1971
|
# },
|
|
1890
1972
|
# ],
|
|
1973
|
+
# context_provider: {
|
|
1974
|
+
# key_definition_list: [
|
|
1975
|
+
# {
|
|
1976
|
+
# source_key: "contextProviderSourceKeyType", # required
|
|
1977
|
+
# target_key: "contextProviderTargetKeyType",
|
|
1978
|
+
# },
|
|
1979
|
+
# ],
|
|
1980
|
+
# subject_source_key: "contextProviderSourceKeyType", # required
|
|
1981
|
+
# subject_type_value: "subjectTypeValueType",
|
|
1982
|
+
# subject_type_source_key: "contextProviderSourceKeyType",
|
|
1983
|
+
# },
|
|
1984
|
+
# identity_center_instance_arn: "identityCenterInstanceArnType",
|
|
1891
1985
|
# })
|
|
1892
1986
|
#
|
|
1893
1987
|
# @example Response structure
|
|
@@ -2409,11 +2503,27 @@ module Aws::IAM
|
|
|
2409
2503
|
# the Amazon Web Services Management Console][2] and [About SAML
|
|
2410
2504
|
# 2.0-based federation][3] in the *IAM User Guide*.
|
|
2411
2505
|
#
|
|
2506
|
+
# To control who can configure trusted identity propagation on a SAML
|
|
2507
|
+
# provider, use the [iam:EnableIdentityPropagation][4],
|
|
2508
|
+
# [iam:EnableIdentityCenterAssociation][5],
|
|
2509
|
+
# [iam:RequestIdentityProviderIssuers][6],
|
|
2510
|
+
# [iam:ResourceIdentityProviderIssuers][7],
|
|
2511
|
+
# [iam:RequestIdentityCenterInstanceArn][8], and
|
|
2512
|
+
# [iam:ResourceIdentityCenterInstanceArn][9] condition keys in IAM
|
|
2513
|
+
# policies. The `Request` keys contain the values in the request. The
|
|
2514
|
+
# `Resource` keys contain the values stored on the provider.
|
|
2515
|
+
#
|
|
2412
2516
|
#
|
|
2413
2517
|
#
|
|
2414
2518
|
# [1]: https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html
|
|
2415
2519
|
# [2]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_providers_enable-console-saml.html
|
|
2416
2520
|
# [3]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_providers_saml.html
|
|
2521
|
+
# [4]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_iam-condition-keys.html#ck_EnableIdentityPropagation
|
|
2522
|
+
# [5]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_iam-condition-keys.html#ck_EnableIdentityCenterAssociation
|
|
2523
|
+
# [6]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_iam-condition-keys.html#ck_RequestIdentityProviderIssuers
|
|
2524
|
+
# [7]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_iam-condition-keys.html#ck_ResourceIdentityProviderIssuers
|
|
2525
|
+
# [8]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_iam-condition-keys.html#ck_RequestIdentityCenterInstanceArn
|
|
2526
|
+
# [9]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_iam-condition-keys.html#ck_ResourceIdentityCenterInstanceArn
|
|
2417
2527
|
#
|
|
2418
2528
|
# @option params [required, String] :saml_metadata_document
|
|
2419
2529
|
# An XML document generated by an identity provider (IdP) that supports
|
|
@@ -2466,11 +2576,77 @@ module Aws::IAM
|
|
|
2466
2576
|
# private key must be a .pem file that uses AES-GCM or AES-CBC
|
|
2467
2577
|
# encryption algorithm to decrypt SAML assertions.
|
|
2468
2578
|
#
|
|
2579
|
+
# @option params [Types::ContextProvider] :context_provider
|
|
2580
|
+
# The trusted identity propagation context provider configuration to
|
|
2581
|
+
# associate with the SAML provider. The context provider defines how the
|
|
2582
|
+
# subject is derived and how keys from the provider's SAML assertion
|
|
2583
|
+
# are mapped into trusted context keys. Specifying a context provider
|
|
2584
|
+
# enables trusted identity propagation for the provider. For more
|
|
2585
|
+
# information, see [ContextProvider][1].
|
|
2586
|
+
#
|
|
2587
|
+
#
|
|
2588
|
+
#
|
|
2589
|
+
# [1]: https://docs.aws.amazon.com/IAM/latest/APIReference/API_ContextProvider.html
|
|
2590
|
+
#
|
|
2591
|
+
# @option params [String] :identity_center_instance_arn
|
|
2592
|
+
# The Amazon Resource Name (ARN) of the IAM Identity Center instance to
|
|
2593
|
+
# associate with the SAML provider. If you specify this parameter, you
|
|
2594
|
+
# must also specify `ContextProvider`.
|
|
2595
|
+
#
|
|
2596
|
+
# For the format, see [InstanceMetadata][1] in the *IAM Identity Center
|
|
2597
|
+
# API Reference*.
|
|
2598
|
+
#
|
|
2599
|
+
#
|
|
2600
|
+
#
|
|
2601
|
+
# [1]: https://docs.aws.amazon.com/singlesignon/latest/APIReference/API_InstanceMetadata.html
|
|
2602
|
+
#
|
|
2469
2603
|
# @return [Types::CreateSAMLProviderResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
2470
2604
|
#
|
|
2471
2605
|
# * {Types::CreateSAMLProviderResponse#saml_provider_arn #saml_provider_arn} => String
|
|
2472
2606
|
# * {Types::CreateSAMLProviderResponse#tags #tags} => Array<Types::Tag>
|
|
2473
2607
|
#
|
|
2608
|
+
#
|
|
2609
|
+
# @example Example: To create a SAML provider
|
|
2610
|
+
#
|
|
2611
|
+
# # The following example creates a SAML provider named MyUniversity from a SAML metadata document.
|
|
2612
|
+
#
|
|
2613
|
+
# resp = client.create_saml_provider({
|
|
2614
|
+
# name: "MyUniversity",
|
|
2615
|
+
# saml_metadata_document: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><md:EntityDescriptor xmlns:md=\"urn:oasis:names:tc:SAML:2.0:metadata\" entityID=\"https://idp.example.com/saml\"><md:IDPSSODescriptor WantAuthnRequestsSigned=\"false\" protocolSupportEnumeration=\"urn:oasis:names:tc:SAML:2.0:protocol\"><md:KeyDescriptor use=\"signing\"><ds:KeyInfo xmlns:ds=\"http://www.w3.org/2000/09/xmldsig#\"><ds:X509Data><ds:X509Certificate>MIIDdzCCAl+gAwIBAgIEbySuqTANBgkqhkiG9w0BAQsFADBsMRAwDgYDVQQGEwdVbmtub3duMRAwDgYDVQQIEwdVbmtub3duMRAwDgYDVQQHEwdVbmtub3duMRAwDgYDVQQKEwdVbmtub3duMRAwDgYDVQQLEwdVbmtub3duMRAwDgYDVQQDEwdFWEFNUExFMB4XDTI2MTEwMTAwMDAwMFoXDTM2MTEwMTAwMDAwMFowbDEQMA4GA1UEBhMHVW5rbm93bjEQMA4GA1UECBMHVW5rbm93bjEQMA4GA1UEBxMHVW5rbm93bjEQMA4GA1UEChMHVW5rbm93bjEQMA4GA1UECxMHVW5rbm93bjEQMA4GA1UEAxMHRVhBTVBMRTCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAEXAMPLE</ds:X509Certificate></ds:X509Data></ds:KeyInfo></md:KeyDescriptor><md:NameIDFormat>urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress</md:NameIDFormat><md:SingleSignOnService Binding=\"urn:oasis:names:tc:SAML:2.0:bindings:HTTP-Redirect\" Location=\"https://idp.example.com/saml/sso\"/></md:IDPSSODescriptor></md:EntityDescriptor>",
|
|
2616
|
+
# })
|
|
2617
|
+
#
|
|
2618
|
+
# resp.to_h outputs the following:
|
|
2619
|
+
# {
|
|
2620
|
+
# saml_provider_arn: "arn:aws:iam::123456789012:saml-provider/MyUniversity",
|
|
2621
|
+
# }
|
|
2622
|
+
#
|
|
2623
|
+
# @example Example: To create a SAML provider with trusted identity propagation
|
|
2624
|
+
#
|
|
2625
|
+
# # The following example creates a SAML provider with a context provider that uses the email attribute as the subject and
|
|
2626
|
+
# # maps the department attribute to a trusted context key. It also associates an IAM Identity Center instance with the
|
|
2627
|
+
# # provider.
|
|
2628
|
+
#
|
|
2629
|
+
# resp = client.create_saml_provider({
|
|
2630
|
+
# context_provider: {
|
|
2631
|
+
# key_definition_list: [
|
|
2632
|
+
# {
|
|
2633
|
+
# source_key: "department",
|
|
2634
|
+
# target_key: "department",
|
|
2635
|
+
# },
|
|
2636
|
+
# ],
|
|
2637
|
+
# subject_source_key: "email",
|
|
2638
|
+
# subject_type_value: "user",
|
|
2639
|
+
# },
|
|
2640
|
+
# identity_center_instance_arn: "arn:aws:sso:::instance/ssoins-1234567890abcdef",
|
|
2641
|
+
# name: "MyUniversity",
|
|
2642
|
+
# saml_metadata_document: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><md:EntityDescriptor xmlns:md=\"urn:oasis:names:tc:SAML:2.0:metadata\" entityID=\"https://idp.example.com/saml\"><md:IDPSSODescriptor WantAuthnRequestsSigned=\"false\" protocolSupportEnumeration=\"urn:oasis:names:tc:SAML:2.0:protocol\"><md:KeyDescriptor use=\"signing\"><ds:KeyInfo xmlns:ds=\"http://www.w3.org/2000/09/xmldsig#\"><ds:X509Data><ds:X509Certificate>MIIDdzCCAl+gAwIBAgIEbySuqTANBgkqhkiG9w0BAQsFADBsMRAwDgYDVQQGEwdVbmtub3duMRAwDgYDVQQIEwdVbmtub3duMRAwDgYDVQQHEwdVbmtub3duMRAwDgYDVQQKEwdVbmtub3duMRAwDgYDVQQLEwdVbmtub3duMRAwDgYDVQQDEwdFWEFNUExFMB4XDTI2MTEwMTAwMDAwMFoXDTM2MTEwMTAwMDAwMFowbDEQMA4GA1UEBhMHVW5rbm93bjEQMA4GA1UECBMHVW5rbm93bjEQMA4GA1UEBxMHVW5rbm93bjEQMA4GA1UEChMHVW5rbm93bjEQMA4GA1UECxMHVW5rbm93bjEQMA4GA1UEAxMHRVhBTVBMRTCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAEXAMPLE</ds:X509Certificate></ds:X509Data></ds:KeyInfo></md:KeyDescriptor><md:NameIDFormat>urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress</md:NameIDFormat><md:SingleSignOnService Binding=\"urn:oasis:names:tc:SAML:2.0:bindings:HTTP-Redirect\" Location=\"https://idp.example.com/saml/sso\"/></md:IDPSSODescriptor></md:EntityDescriptor>",
|
|
2643
|
+
# })
|
|
2644
|
+
#
|
|
2645
|
+
# resp.to_h outputs the following:
|
|
2646
|
+
# {
|
|
2647
|
+
# saml_provider_arn: "arn:aws:iam::123456789012:saml-provider/MyUniversity",
|
|
2648
|
+
# }
|
|
2649
|
+
#
|
|
2474
2650
|
# @example Request syntax with placeholder values
|
|
2475
2651
|
#
|
|
2476
2652
|
# resp = client.create_saml_provider({
|
|
@@ -2484,6 +2660,18 @@ module Aws::IAM
|
|
|
2484
2660
|
# ],
|
|
2485
2661
|
# assertion_encryption_mode: "Required", # accepts Required, Allowed
|
|
2486
2662
|
# add_private_key: "privateKeyType",
|
|
2663
|
+
# context_provider: {
|
|
2664
|
+
# key_definition_list: [
|
|
2665
|
+
# {
|
|
2666
|
+
# source_key: "contextProviderSourceKeyType", # required
|
|
2667
|
+
# target_key: "contextProviderTargetKeyType",
|
|
2668
|
+
# },
|
|
2669
|
+
# ],
|
|
2670
|
+
# subject_source_key: "contextProviderSourceKeyType", # required
|
|
2671
|
+
# subject_type_value: "subjectTypeValueType",
|
|
2672
|
+
# subject_type_source_key: "contextProviderSourceKeyType",
|
|
2673
|
+
# },
|
|
2674
|
+
# identity_center_instance_arn: "identityCenterInstanceArnType",
|
|
2487
2675
|
# })
|
|
2488
2676
|
#
|
|
2489
2677
|
# @example Response structure
|
|
@@ -3348,15 +3536,14 @@ module Aws::IAM
|
|
|
3348
3536
|
end
|
|
3349
3537
|
|
|
3350
3538
|
# Deletes an OpenID Connect identity provider (IdP) resource object in
|
|
3351
|
-
# IAM.
|
|
3539
|
+
# IAM. Deleting the provider also deletes its trusted identity
|
|
3540
|
+
# propagation context provider and removes any IAM Identity Center
|
|
3541
|
+
# instance association.
|
|
3352
3542
|
#
|
|
3353
3543
|
# Deleting an IAM OIDC provider resource does not update any roles that
|
|
3354
3544
|
# reference the provider as a principal in their trust policies. Any
|
|
3355
3545
|
# attempt to assume a role that references a deleted provider fails.
|
|
3356
3546
|
#
|
|
3357
|
-
# This operation is idempotent; it does not fail or return an error if
|
|
3358
|
-
# you call the operation for a provider that does not exist.
|
|
3359
|
-
#
|
|
3360
3547
|
# @option params [required, String] :open_id_connect_provider_arn
|
|
3361
3548
|
# The Amazon Resource Name (ARN) of the IAM OpenID Connect provider
|
|
3362
3549
|
# resource object to delete. You can get a list of OpenID Connect
|
|
@@ -6128,6 +6315,45 @@ module Aws::IAM
|
|
|
6128
6315
|
# * {Types::GetOpenIDConnectProviderResponse#thumbprint_list #thumbprint_list} => Array<String>
|
|
6129
6316
|
# * {Types::GetOpenIDConnectProviderResponse#create_date #create_date} => Time
|
|
6130
6317
|
# * {Types::GetOpenIDConnectProviderResponse#tags #tags} => Array<Types::Tag>
|
|
6318
|
+
# * {Types::GetOpenIDConnectProviderResponse#context_provider #context_provider} => Types::ContextProvider
|
|
6319
|
+
# * {Types::GetOpenIDConnectProviderResponse#identity_center_instance_arn #identity_center_instance_arn} => String
|
|
6320
|
+
# * {Types::GetOpenIDConnectProviderResponse#identity_store_arn #identity_store_arn} => String
|
|
6321
|
+
#
|
|
6322
|
+
#
|
|
6323
|
+
# @example Example: To get information about an OIDC provider
|
|
6324
|
+
#
|
|
6325
|
+
# # The following example returns the configuration of an OIDC provider, including its trusted identity propagation context
|
|
6326
|
+
# # provider and the associated IAM Identity Center instance.
|
|
6327
|
+
#
|
|
6328
|
+
# resp = client.get_open_id_connect_provider({
|
|
6329
|
+
# open_id_connect_provider_arn: "arn:aws:iam::123456789012:oidc-provider/server.example.com",
|
|
6330
|
+
# })
|
|
6331
|
+
#
|
|
6332
|
+
# resp.to_h outputs the following:
|
|
6333
|
+
# {
|
|
6334
|
+
# client_id_list: [
|
|
6335
|
+
# "my-application-id",
|
|
6336
|
+
# ],
|
|
6337
|
+
# context_provider: {
|
|
6338
|
+
# key_definition_list: [
|
|
6339
|
+
# {
|
|
6340
|
+
# source_key: "department",
|
|
6341
|
+
# target_key: "department",
|
|
6342
|
+
# },
|
|
6343
|
+
# ],
|
|
6344
|
+
# subject_source_key: "sub",
|
|
6345
|
+
# subject_type_value: "user",
|
|
6346
|
+
# },
|
|
6347
|
+
# create_date: Time.parse("2026-11-01T17:22:18Z"),
|
|
6348
|
+
# identity_center_instance_arn: "arn:aws:sso:::instance/ssoins-1234567890abcdef",
|
|
6349
|
+
# identity_store_arn: "arn:aws:identitystore::123456789012:identitystore/d-1234567890",
|
|
6350
|
+
# tags: [
|
|
6351
|
+
# ],
|
|
6352
|
+
# thumbprint_list: [
|
|
6353
|
+
# "3768084dfb3d2b68b7897bf5f565da8efEXAMPLE",
|
|
6354
|
+
# ],
|
|
6355
|
+
# url: "server.example.com",
|
|
6356
|
+
# }
|
|
6131
6357
|
#
|
|
6132
6358
|
# @example Request syntax with placeholder values
|
|
6133
6359
|
#
|
|
@@ -6146,6 +6372,14 @@ module Aws::IAM
|
|
|
6146
6372
|
# resp.tags #=> Array
|
|
6147
6373
|
# resp.tags[0].key #=> String
|
|
6148
6374
|
# resp.tags[0].value #=> String
|
|
6375
|
+
# resp.context_provider.key_definition_list #=> Array
|
|
6376
|
+
# resp.context_provider.key_definition_list[0].source_key #=> String
|
|
6377
|
+
# resp.context_provider.key_definition_list[0].target_key #=> String
|
|
6378
|
+
# resp.context_provider.subject_source_key #=> String
|
|
6379
|
+
# resp.context_provider.subject_type_value #=> String
|
|
6380
|
+
# resp.context_provider.subject_type_source_key #=> String
|
|
6381
|
+
# resp.identity_center_instance_arn #=> String
|
|
6382
|
+
# resp.identity_store_arn #=> String
|
|
6149
6383
|
#
|
|
6150
6384
|
# @see http://docs.aws.amazon.com/goto/WebAPI/iam-2010-05-08/GetOpenIDConnectProvider AWS API Documentation
|
|
6151
6385
|
#
|
|
@@ -6793,11 +7027,55 @@ module Aws::IAM
|
|
|
6793
7027
|
#
|
|
6794
7028
|
# * {Types::GetSAMLProviderResponse#saml_provider_uuid #saml_provider_uuid} => String
|
|
6795
7029
|
# * {Types::GetSAMLProviderResponse#saml_metadata_document #saml_metadata_document} => String
|
|
7030
|
+
# * {Types::GetSAMLProviderResponse#context_provider #context_provider} => Types::ContextProvider
|
|
7031
|
+
# * {Types::GetSAMLProviderResponse#saml_key_hashes #saml_key_hashes} => Array<Types::SAMLKeyHashEntry>
|
|
6796
7032
|
# * {Types::GetSAMLProviderResponse#create_date #create_date} => Time
|
|
6797
7033
|
# * {Types::GetSAMLProviderResponse#valid_until #valid_until} => Time
|
|
6798
7034
|
# * {Types::GetSAMLProviderResponse#tags #tags} => Array<Types::Tag>
|
|
6799
7035
|
# * {Types::GetSAMLProviderResponse#assertion_encryption_mode #assertion_encryption_mode} => String
|
|
6800
7036
|
# * {Types::GetSAMLProviderResponse#private_key_list #private_key_list} => Array<Types::SAMLPrivateKey>
|
|
7037
|
+
# * {Types::GetSAMLProviderResponse#identity_center_instance_arn #identity_center_instance_arn} => String
|
|
7038
|
+
# * {Types::GetSAMLProviderResponse#identity_store_arn #identity_store_arn} => String
|
|
7039
|
+
#
|
|
7040
|
+
#
|
|
7041
|
+
# @example Example: To get information about a SAML provider
|
|
7042
|
+
#
|
|
7043
|
+
# # The following example returns the configuration of a SAML provider, including its trusted identity propagation context
|
|
7044
|
+
# # provider, the issuer key hashes, and the associated IAM Identity Center instance.
|
|
7045
|
+
#
|
|
7046
|
+
# resp = client.get_saml_provider({
|
|
7047
|
+
# saml_provider_arn: "arn:aws:iam::123456789012:saml-provider/MyUniversity",
|
|
7048
|
+
# })
|
|
7049
|
+
#
|
|
7050
|
+
# resp.to_h outputs the following:
|
|
7051
|
+
# {
|
|
7052
|
+
# assertion_encryption_mode: "Allowed",
|
|
7053
|
+
# context_provider: {
|
|
7054
|
+
# key_definition_list: [
|
|
7055
|
+
# {
|
|
7056
|
+
# source_key: "department",
|
|
7057
|
+
# target_key: "department",
|
|
7058
|
+
# },
|
|
7059
|
+
# ],
|
|
7060
|
+
# subject_source_key: "email",
|
|
7061
|
+
# subject_type_value: "user",
|
|
7062
|
+
# },
|
|
7063
|
+
# create_date: Time.parse("2026-11-01T17:22:18Z"),
|
|
7064
|
+
# identity_center_instance_arn: "arn:aws:sso:::instance/ssoins-1234567890abcdef",
|
|
7065
|
+
# identity_store_arn: "arn:aws:identitystore::123456789012:identitystore/d-1234567890",
|
|
7066
|
+
# saml_key_hashes: [
|
|
7067
|
+
# {
|
|
7068
|
+
# issuer_url: "https://idp.example.com/saml",
|
|
7069
|
+
# key_hashes: [
|
|
7070
|
+
# "a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6e7f8a9b0c1d2e3f4a5b6c7d8EXAMPLE",
|
|
7071
|
+
# ],
|
|
7072
|
+
# },
|
|
7073
|
+
# ],
|
|
7074
|
+
# saml_provider_uuid: "SAMLPROVIDERUUIDEXAMPLE",
|
|
7075
|
+
# tags: [
|
|
7076
|
+
# ],
|
|
7077
|
+
# valid_until: Time.parse("2036-11-01T17:22:18Z"),
|
|
7078
|
+
# }
|
|
6801
7079
|
#
|
|
6802
7080
|
# @example Request syntax with placeholder values
|
|
6803
7081
|
#
|
|
@@ -6809,6 +7087,16 @@ module Aws::IAM
|
|
|
6809
7087
|
#
|
|
6810
7088
|
# resp.saml_provider_uuid #=> String
|
|
6811
7089
|
# resp.saml_metadata_document #=> String
|
|
7090
|
+
# resp.context_provider.key_definition_list #=> Array
|
|
7091
|
+
# resp.context_provider.key_definition_list[0].source_key #=> String
|
|
7092
|
+
# resp.context_provider.key_definition_list[0].target_key #=> String
|
|
7093
|
+
# resp.context_provider.subject_source_key #=> String
|
|
7094
|
+
# resp.context_provider.subject_type_value #=> String
|
|
7095
|
+
# resp.context_provider.subject_type_source_key #=> String
|
|
7096
|
+
# resp.saml_key_hashes #=> Array
|
|
7097
|
+
# resp.saml_key_hashes[0].issuer_url #=> String
|
|
7098
|
+
# resp.saml_key_hashes[0].key_hashes #=> Array
|
|
7099
|
+
# resp.saml_key_hashes[0].key_hashes[0] #=> String
|
|
6812
7100
|
# resp.create_date #=> Time
|
|
6813
7101
|
# resp.valid_until #=> Time
|
|
6814
7102
|
# resp.tags #=> Array
|
|
@@ -6818,6 +7106,8 @@ module Aws::IAM
|
|
|
6818
7106
|
# resp.private_key_list #=> Array
|
|
6819
7107
|
# resp.private_key_list[0].key_id #=> String
|
|
6820
7108
|
# resp.private_key_list[0].timestamp #=> Time
|
|
7109
|
+
# resp.identity_center_instance_arn #=> String
|
|
7110
|
+
# resp.identity_store_arn #=> String
|
|
6821
7111
|
#
|
|
6822
7112
|
# @see http://docs.aws.amazon.com/goto/WebAPI/iam-2010-05-08/GetSAMLProvider AWS API Documentation
|
|
6823
7113
|
#
|
|
@@ -8996,10 +9286,34 @@ module Aws::IAM
|
|
|
8996
9286
|
#
|
|
8997
9287
|
# * {Types::ListOpenIDConnectProvidersResponse#open_id_connect_provider_list #open_id_connect_provider_list} => Array<Types::OpenIDConnectProviderListEntry>
|
|
8998
9288
|
#
|
|
9289
|
+
#
|
|
9290
|
+
# @example Example: To list the OIDC providers in an account
|
|
9291
|
+
#
|
|
9292
|
+
# # The following example lists the OIDC providers in the current account and shows whether trusted identity propagation is
|
|
9293
|
+
# # enabled for each provider.
|
|
9294
|
+
#
|
|
9295
|
+
# resp = client.list_open_id_connect_providers({
|
|
9296
|
+
# })
|
|
9297
|
+
#
|
|
9298
|
+
# resp.to_h outputs the following:
|
|
9299
|
+
# {
|
|
9300
|
+
# open_id_connect_provider_list: [
|
|
9301
|
+
# {
|
|
9302
|
+
# arn: "arn:aws:iam::123456789012:oidc-provider/server.example.com",
|
|
9303
|
+
# is_trusted_identity_propagation_enabled: true,
|
|
9304
|
+
# },
|
|
9305
|
+
# {
|
|
9306
|
+
# arn: "arn:aws:iam::123456789012:oidc-provider/server.example.org",
|
|
9307
|
+
# is_trusted_identity_propagation_enabled: false,
|
|
9308
|
+
# },
|
|
9309
|
+
# ],
|
|
9310
|
+
# }
|
|
9311
|
+
#
|
|
8999
9312
|
# @example Response structure
|
|
9000
9313
|
#
|
|
9001
9314
|
# resp.open_id_connect_provider_list #=> Array
|
|
9002
9315
|
# resp.open_id_connect_provider_list[0].arn #=> String
|
|
9316
|
+
# resp.open_id_connect_provider_list[0].is_trusted_identity_propagation_enabled #=> Boolean
|
|
9003
9317
|
#
|
|
9004
9318
|
# @see http://docs.aws.amazon.com/goto/WebAPI/iam-2010-05-08/ListOpenIDConnectProviders AWS API Documentation
|
|
9005
9319
|
#
|
|
@@ -9865,12 +10179,40 @@ module Aws::IAM
|
|
|
9865
10179
|
#
|
|
9866
10180
|
# * {Types::ListSAMLProvidersResponse#saml_provider_list #saml_provider_list} => Array<Types::SAMLProviderListEntry>
|
|
9867
10181
|
#
|
|
10182
|
+
#
|
|
10183
|
+
# @example Example: To list the SAML providers in an account
|
|
10184
|
+
#
|
|
10185
|
+
# # The following example lists the SAML providers in the current account and shows whether trusted identity propagation is
|
|
10186
|
+
# # enabled for each provider.
|
|
10187
|
+
#
|
|
10188
|
+
# resp = client.list_saml_providers({
|
|
10189
|
+
# })
|
|
10190
|
+
#
|
|
10191
|
+
# resp.to_h outputs the following:
|
|
10192
|
+
# {
|
|
10193
|
+
# saml_provider_list: [
|
|
10194
|
+
# {
|
|
10195
|
+
# arn: "arn:aws:iam::123456789012:saml-provider/MyUniversity",
|
|
10196
|
+
# create_date: Time.parse("2026-11-01T17:22:18Z"),
|
|
10197
|
+
# is_trusted_identity_propagation_enabled: true,
|
|
10198
|
+
# valid_until: Time.parse("2036-11-01T17:22:18Z"),
|
|
10199
|
+
# },
|
|
10200
|
+
# {
|
|
10201
|
+
# arn: "arn:aws:iam::123456789012:saml-provider/MyCompany",
|
|
10202
|
+
# create_date: Time.parse("2020-03-11T13:11:02Z"),
|
|
10203
|
+
# is_trusted_identity_propagation_enabled: false,
|
|
10204
|
+
# valid_until: Time.parse("2030-03-11T13:11:02Z"),
|
|
10205
|
+
# },
|
|
10206
|
+
# ],
|
|
10207
|
+
# }
|
|
10208
|
+
#
|
|
9868
10209
|
# @example Response structure
|
|
9869
10210
|
#
|
|
9870
10211
|
# resp.saml_provider_list #=> Array
|
|
9871
10212
|
# resp.saml_provider_list[0].arn #=> String
|
|
9872
10213
|
# resp.saml_provider_list[0].valid_until #=> Time
|
|
9873
10214
|
# resp.saml_provider_list[0].create_date #=> Time
|
|
10215
|
+
# resp.saml_provider_list[0].is_trusted_identity_propagation_enabled #=> Boolean
|
|
9874
10216
|
#
|
|
9875
10217
|
# @see http://docs.aws.amazon.com/goto/WebAPI/iam-2010-05-08/ListSAMLProviders AWS API Documentation
|
|
9876
10218
|
#
|
|
@@ -14112,6 +14454,179 @@ module Aws::IAM
|
|
|
14112
14454
|
req.send_request(options)
|
|
14113
14455
|
end
|
|
14114
14456
|
|
|
14457
|
+
# Updates the configuration of an existing IAM OpenID Connect (OIDC)
|
|
14458
|
+
# identity provider resource object. Use this operation to set, change,
|
|
14459
|
+
# or remove the trusted identity propagation context provider, and to
|
|
14460
|
+
# associate or disassociate an IAM Identity Center instance with the
|
|
14461
|
+
# provider.
|
|
14462
|
+
#
|
|
14463
|
+
# <note markdown="1"> This operation does not update the OIDC provider's server certificate
|
|
14464
|
+
# thumbprints. Thumbprints are managed only by the
|
|
14465
|
+
# [UpdateOpenIDConnectProviderThumbprint][1] operation. To change a
|
|
14466
|
+
# provider's thumbprints, call that operation instead.
|
|
14467
|
+
#
|
|
14468
|
+
# </note>
|
|
14469
|
+
#
|
|
14470
|
+
# To remove a configuration rather than replace it, use the
|
|
14471
|
+
# `RemoveContextProvider` and `RemoveIdentityCenterInstance` parameters.
|
|
14472
|
+
# For each configuration, provide either the new value or the
|
|
14473
|
+
# corresponding `Remove` flag in a single request, but not both. For
|
|
14474
|
+
# example, specifying both `ContextProvider` and `RemoveContextProvider`
|
|
14475
|
+
# in the same request is not allowed.
|
|
14476
|
+
#
|
|
14477
|
+
# A single request can change either the context provider or the IAM
|
|
14478
|
+
# Identity Center association, but not both. To change both, make
|
|
14479
|
+
# separate `UpdateOpenIDConnectProvider` requests. To remove the context
|
|
14480
|
+
# provider, first remove the IAM Identity Center association in a
|
|
14481
|
+
# separate request.
|
|
14482
|
+
#
|
|
14483
|
+
# To control who can configure trusted identity propagation on an OIDC
|
|
14484
|
+
# provider, use the [iam:EnableIdentityPropagation][2],
|
|
14485
|
+
# [iam:EnableIdentityCenterAssociation][3],
|
|
14486
|
+
# [iam:ResourceIdentityProviderIssuers][4],
|
|
14487
|
+
# [iam:RequestIdentityCenterInstanceArn][5], and
|
|
14488
|
+
# [iam:ResourceIdentityCenterInstanceArn][6] condition keys in IAM
|
|
14489
|
+
# policies. The `Request` keys contain the values in the request. The
|
|
14490
|
+
# `Resource` keys contain the values stored on the provider.
|
|
14491
|
+
#
|
|
14492
|
+
#
|
|
14493
|
+
#
|
|
14494
|
+
# [1]: https://docs.aws.amazon.com/IAM/latest/APIReference/API_UpdateOpenIDConnectProviderThumbprint.html
|
|
14495
|
+
# [2]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_iam-condition-keys.html#ck_EnableIdentityPropagation
|
|
14496
|
+
# [3]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_iam-condition-keys.html#ck_EnableIdentityCenterAssociation
|
|
14497
|
+
# [4]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_iam-condition-keys.html#ck_ResourceIdentityProviderIssuers
|
|
14498
|
+
# [5]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_iam-condition-keys.html#ck_RequestIdentityCenterInstanceArn
|
|
14499
|
+
# [6]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_iam-condition-keys.html#ck_ResourceIdentityCenterInstanceArn
|
|
14500
|
+
#
|
|
14501
|
+
# @option params [required, String] :open_id_connect_provider_arn
|
|
14502
|
+
# The Amazon Resource Name (ARN) of the IAM OIDC provider resource
|
|
14503
|
+
# object to update. You can get a list of OIDC provider resource ARNs by
|
|
14504
|
+
# using the [ListOpenIDConnectProviders][1] operation.
|
|
14505
|
+
#
|
|
14506
|
+
# For more information about ARNs, see [Amazon Resource Names (ARNs)][2]
|
|
14507
|
+
# in the *Amazon Web Services General Reference*.
|
|
14508
|
+
#
|
|
14509
|
+
#
|
|
14510
|
+
#
|
|
14511
|
+
# [1]: https://docs.aws.amazon.com/IAM/latest/APIReference/API_ListOpenIDConnectProviders.html
|
|
14512
|
+
# [2]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
|
|
14513
|
+
#
|
|
14514
|
+
# @option params [Types::ContextProvider] :context_provider
|
|
14515
|
+
# The trusted identity propagation context provider configuration to set
|
|
14516
|
+
# on the OIDC provider. This configuration defines the subject mapping
|
|
14517
|
+
# and the source-to-target key mappings that are used when trusted
|
|
14518
|
+
# context is injected. For more information, see [ContextProvider][1].
|
|
14519
|
+
#
|
|
14520
|
+
# To remove the existing context provider instead of replacing it, use
|
|
14521
|
+
# `RemoveContextProvider`. Do not specify both `ContextProvider` and
|
|
14522
|
+
# `RemoveContextProvider` in the same request.
|
|
14523
|
+
#
|
|
14524
|
+
#
|
|
14525
|
+
#
|
|
14526
|
+
# [1]: https://docs.aws.amazon.com/IAM/latest/APIReference/API_ContextProvider.html
|
|
14527
|
+
#
|
|
14528
|
+
# @option params [String] :identity_center_instance_arn
|
|
14529
|
+
# The Amazon Resource Name (ARN) of the IAM Identity Center instance to
|
|
14530
|
+
# associate with the OIDC provider.
|
|
14531
|
+
#
|
|
14532
|
+
# For the format, see [InstanceMetadata][1] in the *IAM Identity Center
|
|
14533
|
+
# API Reference*.
|
|
14534
|
+
#
|
|
14535
|
+
# To disassociate the currently associated instance instead of changing
|
|
14536
|
+
# it, use `RemoveIdentityCenterInstance`. Do not specify both
|
|
14537
|
+
# `IdentityCenterInstanceArn` and `RemoveIdentityCenterInstance` in the
|
|
14538
|
+
# same request.
|
|
14539
|
+
#
|
|
14540
|
+
#
|
|
14541
|
+
#
|
|
14542
|
+
# [1]: https://docs.aws.amazon.com/singlesignon/latest/APIReference/API_InstanceMetadata.html
|
|
14543
|
+
#
|
|
14544
|
+
# @option params [Boolean] :remove_context_provider
|
|
14545
|
+
# Specifies whether to remove the existing context provider
|
|
14546
|
+
# configuration from the OIDC provider. Set this value to `true` to
|
|
14547
|
+
# remove the context provider.
|
|
14548
|
+
#
|
|
14549
|
+
# This parameter is mutually exclusive with `ContextProvider`. In a
|
|
14550
|
+
# single request, specify either a new `ContextProvider` value or
|
|
14551
|
+
# `RemoveContextProvider`, but not both.
|
|
14552
|
+
#
|
|
14553
|
+
# @option params [Boolean] :remove_identity_center_instance
|
|
14554
|
+
# Specifies whether to disassociate the IAM Identity Center instance
|
|
14555
|
+
# from the OIDC provider. Set this value to `true` to remove the
|
|
14556
|
+
# association.
|
|
14557
|
+
#
|
|
14558
|
+
# This parameter is mutually exclusive with `IdentityCenterInstanceArn`.
|
|
14559
|
+
# In a single request, specify either a new `IdentityCenterInstanceArn`
|
|
14560
|
+
# value or `RemoveIdentityCenterInstance`, but not both.
|
|
14561
|
+
#
|
|
14562
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
|
14563
|
+
#
|
|
14564
|
+
#
|
|
14565
|
+
# @example Example: To set the context provider for an OIDC provider
|
|
14566
|
+
#
|
|
14567
|
+
# # The following example sets a trusted identity propagation context provider on an existing OIDC provider. The context
|
|
14568
|
+
# # provider uses the sub claim as the subject and maps the department claim to a trusted context key.
|
|
14569
|
+
#
|
|
14570
|
+
# resp = client.update_open_id_connect_provider({
|
|
14571
|
+
# context_provider: {
|
|
14572
|
+
# key_definition_list: [
|
|
14573
|
+
# {
|
|
14574
|
+
# source_key: "department",
|
|
14575
|
+
# target_key: "department",
|
|
14576
|
+
# },
|
|
14577
|
+
# ],
|
|
14578
|
+
# subject_source_key: "sub",
|
|
14579
|
+
# subject_type_value: "user",
|
|
14580
|
+
# },
|
|
14581
|
+
# open_id_connect_provider_arn: "arn:aws:iam::123456789012:oidc-provider/server.example.com",
|
|
14582
|
+
# })
|
|
14583
|
+
#
|
|
14584
|
+
# resp.to_h outputs the following:
|
|
14585
|
+
# {
|
|
14586
|
+
# }
|
|
14587
|
+
#
|
|
14588
|
+
# @example Example: To associate an IAM Identity Center instance with an OIDC provider
|
|
14589
|
+
#
|
|
14590
|
+
# # The following example associates an IAM Identity Center instance with an existing OIDC provider.
|
|
14591
|
+
#
|
|
14592
|
+
# resp = client.update_open_id_connect_provider({
|
|
14593
|
+
# identity_center_instance_arn: "arn:aws:sso:::instance/ssoins-1234567890abcdef",
|
|
14594
|
+
# open_id_connect_provider_arn: "arn:aws:iam::123456789012:oidc-provider/server.example.com",
|
|
14595
|
+
# })
|
|
14596
|
+
#
|
|
14597
|
+
# resp.to_h outputs the following:
|
|
14598
|
+
# {
|
|
14599
|
+
# }
|
|
14600
|
+
#
|
|
14601
|
+
# @example Request syntax with placeholder values
|
|
14602
|
+
#
|
|
14603
|
+
# resp = client.update_open_id_connect_provider({
|
|
14604
|
+
# open_id_connect_provider_arn: "arnType", # required
|
|
14605
|
+
# context_provider: {
|
|
14606
|
+
# key_definition_list: [
|
|
14607
|
+
# {
|
|
14608
|
+
# source_key: "contextProviderSourceKeyType", # required
|
|
14609
|
+
# target_key: "contextProviderTargetKeyType",
|
|
14610
|
+
# },
|
|
14611
|
+
# ],
|
|
14612
|
+
# subject_source_key: "contextProviderSourceKeyType", # required
|
|
14613
|
+
# subject_type_value: "subjectTypeValueType",
|
|
14614
|
+
# subject_type_source_key: "contextProviderSourceKeyType",
|
|
14615
|
+
# },
|
|
14616
|
+
# identity_center_instance_arn: "identityCenterInstanceArnType",
|
|
14617
|
+
# remove_context_provider: false,
|
|
14618
|
+
# remove_identity_center_instance: false,
|
|
14619
|
+
# })
|
|
14620
|
+
#
|
|
14621
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/iam-2010-05-08/UpdateOpenIDConnectProvider AWS API Documentation
|
|
14622
|
+
#
|
|
14623
|
+
# @overload update_open_id_connect_provider(params = {})
|
|
14624
|
+
# @param [Hash] params ({})
|
|
14625
|
+
def update_open_id_connect_provider(params = {}, options = {})
|
|
14626
|
+
req = build_request(:update_open_id_connect_provider, params)
|
|
14627
|
+
req.send_request(options)
|
|
14628
|
+
end
|
|
14629
|
+
|
|
14115
14630
|
# Replaces the existing list of server certificate thumbprints
|
|
14116
14631
|
# associated with an OpenID Connect (OIDC) provider resource object with
|
|
14117
14632
|
# a new list of thumbprints.
|
|
@@ -14334,6 +14849,40 @@ module Aws::IAM
|
|
|
14334
14849
|
# keys for an existing SAML provider. To rotate private keys, add your
|
|
14335
14850
|
# new private key and then remove the old key in a separate request.
|
|
14336
14851
|
#
|
|
14852
|
+
# You can also use this operation to set, change, or remove the trusted
|
|
14853
|
+
# identity propagation context provider, and to associate or
|
|
14854
|
+
# disassociate an IAM Identity Center instance with the provider. To
|
|
14855
|
+
# remove a configuration rather than replace it, use the
|
|
14856
|
+
# `RemoveContextProvider` and `RemoveIdentityCenterInstance` parameters.
|
|
14857
|
+
# For each configuration, provide either the new value or the
|
|
14858
|
+
# corresponding `Remove` flag in a single request, but not both.
|
|
14859
|
+
#
|
|
14860
|
+
# A single request can change either the context provider or the
|
|
14861
|
+
# provider metadata, but not both. Provider metadata includes the SAML
|
|
14862
|
+
# metadata document, assertion encryption mode, private keys, and IAM
|
|
14863
|
+
# Identity Center association. To change both, make separate
|
|
14864
|
+
# `UpdateSAMLProvider` requests. To remove the context provider, first
|
|
14865
|
+
# remove the IAM Identity Center association in a separate request.
|
|
14866
|
+
#
|
|
14867
|
+
# To control who can configure trusted identity propagation on a SAML
|
|
14868
|
+
# provider, use the [iam:EnableIdentityPropagation][1],
|
|
14869
|
+
# [iam:EnableIdentityCenterAssociation][2],
|
|
14870
|
+
# [iam:RequestIdentityProviderIssuers][3],
|
|
14871
|
+
# [iam:ResourceIdentityProviderIssuers][4],
|
|
14872
|
+
# [iam:RequestIdentityCenterInstanceArn][5], and
|
|
14873
|
+
# [iam:ResourceIdentityCenterInstanceArn][6] condition keys in IAM
|
|
14874
|
+
# policies. The `Request` keys contain the values in the request. The
|
|
14875
|
+
# `Resource` keys contain the values stored on the provider.
|
|
14876
|
+
#
|
|
14877
|
+
#
|
|
14878
|
+
#
|
|
14879
|
+
# [1]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_iam-condition-keys.html#ck_EnableIdentityPropagation
|
|
14880
|
+
# [2]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_iam-condition-keys.html#ck_EnableIdentityCenterAssociation
|
|
14881
|
+
# [3]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_iam-condition-keys.html#ck_RequestIdentityProviderIssuers
|
|
14882
|
+
# [4]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_iam-condition-keys.html#ck_ResourceIdentityProviderIssuers
|
|
14883
|
+
# [5]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_iam-condition-keys.html#ck_RequestIdentityCenterInstanceArn
|
|
14884
|
+
# [6]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_iam-condition-keys.html#ck_ResourceIdentityCenterInstanceArn
|
|
14885
|
+
#
|
|
14337
14886
|
# @option params [String] :saml_metadata_document
|
|
14338
14887
|
# An XML document generated by an identity provider (IdP) that supports
|
|
14339
14888
|
# SAML 2.0. The document includes the issuer's name, expiration
|
|
@@ -14363,10 +14912,82 @@ module Aws::IAM
|
|
|
14363
14912
|
# @option params [String] :remove_private_key
|
|
14364
14913
|
# The Key ID of the private key to remove.
|
|
14365
14914
|
#
|
|
14915
|
+
# @option params [Types::ContextProvider] :context_provider
|
|
14916
|
+
# The trusted identity propagation context provider configuration to
|
|
14917
|
+
# associate with the SAML provider. This replaces the existing context
|
|
14918
|
+
# provider configuration. For more information, see
|
|
14919
|
+
# [ContextProvider][1].
|
|
14920
|
+
#
|
|
14921
|
+
#
|
|
14922
|
+
#
|
|
14923
|
+
# [1]: https://docs.aws.amazon.com/IAM/latest/APIReference/API_ContextProvider.html
|
|
14924
|
+
#
|
|
14925
|
+
# @option params [String] :identity_center_instance_arn
|
|
14926
|
+
# The Amazon Resource Name (ARN) of the IAM Identity Center instance to
|
|
14927
|
+
# associate with the SAML provider.
|
|
14928
|
+
#
|
|
14929
|
+
# For the format, see [InstanceMetadata][1] in the *IAM Identity Center
|
|
14930
|
+
# API Reference*.
|
|
14931
|
+
#
|
|
14932
|
+
#
|
|
14933
|
+
#
|
|
14934
|
+
# [1]: https://docs.aws.amazon.com/singlesignon/latest/APIReference/API_InstanceMetadata.html
|
|
14935
|
+
#
|
|
14936
|
+
# @option params [Boolean] :remove_context_provider
|
|
14937
|
+
# Specifies whether to remove the existing trusted identity propagation
|
|
14938
|
+
# context provider configuration from the SAML provider. When set to
|
|
14939
|
+
# `true`, the context provider is removed. This parameter is mutually
|
|
14940
|
+
# exclusive with `ContextProvider`.
|
|
14941
|
+
#
|
|
14942
|
+
# @option params [Boolean] :remove_identity_center_instance
|
|
14943
|
+
# Specifies whether to disassociate the IAM Identity Center instance
|
|
14944
|
+
# from the SAML provider. When set to `true`, the instance is
|
|
14945
|
+
# disassociated. This parameter is mutually exclusive with
|
|
14946
|
+
# `IdentityCenterInstanceArn`.
|
|
14947
|
+
#
|
|
14366
14948
|
# @return [Types::UpdateSAMLProviderResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
14367
14949
|
#
|
|
14368
14950
|
# * {Types::UpdateSAMLProviderResponse#saml_provider_arn #saml_provider_arn} => String
|
|
14369
14951
|
#
|
|
14952
|
+
#
|
|
14953
|
+
# @example Example: To set the context provider for a SAML provider
|
|
14954
|
+
#
|
|
14955
|
+
# # The following example sets a trusted identity propagation context provider on an existing SAML provider. The context
|
|
14956
|
+
# # provider uses the email attribute as the subject and maps the department attribute to a trusted context key.
|
|
14957
|
+
#
|
|
14958
|
+
# resp = client.update_saml_provider({
|
|
14959
|
+
# context_provider: {
|
|
14960
|
+
# key_definition_list: [
|
|
14961
|
+
# {
|
|
14962
|
+
# source_key: "department",
|
|
14963
|
+
# target_key: "department",
|
|
14964
|
+
# },
|
|
14965
|
+
# ],
|
|
14966
|
+
# subject_source_key: "email",
|
|
14967
|
+
# subject_type_value: "user",
|
|
14968
|
+
# },
|
|
14969
|
+
# saml_provider_arn: "arn:aws:iam::123456789012:saml-provider/MyUniversity",
|
|
14970
|
+
# })
|
|
14971
|
+
#
|
|
14972
|
+
# resp.to_h outputs the following:
|
|
14973
|
+
# {
|
|
14974
|
+
# saml_provider_arn: "arn:aws:iam::123456789012:saml-provider/MyUniversity",
|
|
14975
|
+
# }
|
|
14976
|
+
#
|
|
14977
|
+
# @example Example: To associate an IAM Identity Center instance with a SAML provider
|
|
14978
|
+
#
|
|
14979
|
+
# # The following example associates an IAM Identity Center instance with an existing SAML provider.
|
|
14980
|
+
#
|
|
14981
|
+
# resp = client.update_saml_provider({
|
|
14982
|
+
# identity_center_instance_arn: "arn:aws:sso:::instance/ssoins-1234567890abcdef",
|
|
14983
|
+
# saml_provider_arn: "arn:aws:iam::123456789012:saml-provider/MyUniversity",
|
|
14984
|
+
# })
|
|
14985
|
+
#
|
|
14986
|
+
# resp.to_h outputs the following:
|
|
14987
|
+
# {
|
|
14988
|
+
# saml_provider_arn: "arn:aws:iam::123456789012:saml-provider/MyUniversity",
|
|
14989
|
+
# }
|
|
14990
|
+
#
|
|
14370
14991
|
# @example Request syntax with placeholder values
|
|
14371
14992
|
#
|
|
14372
14993
|
# resp = client.update_saml_provider({
|
|
@@ -14375,6 +14996,20 @@ module Aws::IAM
|
|
|
14375
14996
|
# assertion_encryption_mode: "Required", # accepts Required, Allowed
|
|
14376
14997
|
# add_private_key: "privateKeyType",
|
|
14377
14998
|
# remove_private_key: "privateKeyIdType",
|
|
14999
|
+
# context_provider: {
|
|
15000
|
+
# key_definition_list: [
|
|
15001
|
+
# {
|
|
15002
|
+
# source_key: "contextProviderSourceKeyType", # required
|
|
15003
|
+
# target_key: "contextProviderTargetKeyType",
|
|
15004
|
+
# },
|
|
15005
|
+
# ],
|
|
15006
|
+
# subject_source_key: "contextProviderSourceKeyType", # required
|
|
15007
|
+
# subject_type_value: "subjectTypeValueType",
|
|
15008
|
+
# subject_type_source_key: "contextProviderSourceKeyType",
|
|
15009
|
+
# },
|
|
15010
|
+
# identity_center_instance_arn: "identityCenterInstanceArnType",
|
|
15011
|
+
# remove_context_provider: false,
|
|
15012
|
+
# remove_identity_center_instance: false,
|
|
14378
15013
|
# })
|
|
14379
15014
|
#
|
|
14380
15015
|
# @example Response structure
|
|
@@ -15172,7 +15807,7 @@ module Aws::IAM
|
|
|
15172
15807
|
tracer: tracer
|
|
15173
15808
|
)
|
|
15174
15809
|
context[:gem_name] = 'aws-sdk-iam'
|
|
15175
|
-
context[:gem_version] = '1.
|
|
15810
|
+
context[:gem_version] = '1.168.0'
|
|
15176
15811
|
Seahorse::Client::Request.new(handlers, context)
|
|
15177
15812
|
end
|
|
15178
15813
|
|