aws-sdk-identitystore 1.74.0 → 1.76.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 +10 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-identitystore/client.rb +390 -29
- data/lib/aws-sdk-identitystore/client_api.rb +146 -8
- data/lib/aws-sdk-identitystore/types.rb +686 -55
- data/lib/aws-sdk-identitystore.rb +1 -1
- data/sig/client.rbs +75 -9
- data/sig/errors.rbs +7 -7
- data/sig/types.rbs +98 -8
- metadata +3 -3
|
@@ -486,6 +486,10 @@ module Aws::IdentityStore
|
|
|
486
486
|
# @option params [required, String] :identity_store_id
|
|
487
487
|
# The globally unique identifier for the identity store.
|
|
488
488
|
#
|
|
489
|
+
# You can specify the identity store by ID or by Amazon Resource Name
|
|
490
|
+
# (ARN). For example, identity store ID `d-1234567890` or identity store
|
|
491
|
+
# ARN `arn:aws:identitystore::111122223333:identitystore/d-1234567890`.
|
|
492
|
+
#
|
|
489
493
|
# @option params [String] :display_name
|
|
490
494
|
# A string containing the name of the group. This value is commonly
|
|
491
495
|
# displayed when the group is referenced. `Administrator` and
|
|
@@ -497,8 +501,10 @@ module Aws::IdentityStore
|
|
|
497
501
|
#
|
|
498
502
|
# @return [Types::CreateGroupResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
499
503
|
#
|
|
500
|
-
# * {Types::CreateGroupResponse#group_id #group_id} => String
|
|
501
504
|
# * {Types::CreateGroupResponse#identity_store_id #identity_store_id} => String
|
|
505
|
+
# * {Types::CreateGroupResponse#group_id #group_id} => String
|
|
506
|
+
# * {Types::CreateGroupResponse#group_arn #group_arn} => String
|
|
507
|
+
# * {Types::CreateGroupResponse#revision #revision} => String
|
|
502
508
|
#
|
|
503
509
|
# @example Request syntax with placeholder values
|
|
504
510
|
#
|
|
@@ -510,8 +516,10 @@ module Aws::IdentityStore
|
|
|
510
516
|
#
|
|
511
517
|
# @example Response structure
|
|
512
518
|
#
|
|
513
|
-
# resp.group_id #=> String
|
|
514
519
|
# resp.identity_store_id #=> String
|
|
520
|
+
# resp.group_id #=> String
|
|
521
|
+
# resp.group_arn #=> String
|
|
522
|
+
# resp.revision #=> String
|
|
515
523
|
#
|
|
516
524
|
# @see http://docs.aws.amazon.com/goto/WebAPI/identitystore-2020-06-15/CreateGroup AWS API Documentation
|
|
517
525
|
#
|
|
@@ -529,9 +537,17 @@ module Aws::IdentityStore
|
|
|
529
537
|
# @option params [required, String] :identity_store_id
|
|
530
538
|
# The globally unique identifier for the identity store.
|
|
531
539
|
#
|
|
540
|
+
# You can specify the identity store by ID or by Amazon Resource Name
|
|
541
|
+
# (ARN). For example, identity store ID `d-1234567890` or identity store
|
|
542
|
+
# ARN `arn:aws:identitystore::111122223333:identitystore/d-1234567890`.
|
|
543
|
+
#
|
|
532
544
|
# @option params [required, String] :group_id
|
|
533
545
|
# The identifier for a group in the identity store.
|
|
534
546
|
#
|
|
547
|
+
# You can specify the group by ID or by Amazon Resource Name (ARN). For
|
|
548
|
+
# example, group ID `a1b2c3d4-5678-90ab-cdef-EXAMPLE22222` or group ARN
|
|
549
|
+
# `arn:aws:identitystore:::group/a1b2c3d4-5678-90ab-cdef-EXAMPLE22222`.
|
|
550
|
+
#
|
|
535
551
|
# @option params [required, Types::MemberId] :member_id
|
|
536
552
|
# An object that contains the identifier of a group member. Setting the
|
|
537
553
|
# `UserID` field to the specific identifier for a user indicates that
|
|
@@ -539,8 +555,9 @@ module Aws::IdentityStore
|
|
|
539
555
|
#
|
|
540
556
|
# @return [Types::CreateGroupMembershipResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
541
557
|
#
|
|
542
|
-
# * {Types::CreateGroupMembershipResponse#membership_id #membership_id} => String
|
|
543
558
|
# * {Types::CreateGroupMembershipResponse#identity_store_id #identity_store_id} => String
|
|
559
|
+
# * {Types::CreateGroupMembershipResponse#membership_id #membership_id} => String
|
|
560
|
+
# * {Types::CreateGroupMembershipResponse#membership_arn #membership_arn} => String
|
|
544
561
|
#
|
|
545
562
|
# @example Request syntax with placeholder values
|
|
546
563
|
#
|
|
@@ -554,8 +571,9 @@ module Aws::IdentityStore
|
|
|
554
571
|
#
|
|
555
572
|
# @example Response structure
|
|
556
573
|
#
|
|
557
|
-
# resp.membership_id #=> String
|
|
558
574
|
# resp.identity_store_id #=> String
|
|
575
|
+
# resp.membership_id #=> String
|
|
576
|
+
# resp.membership_arn #=> String
|
|
559
577
|
#
|
|
560
578
|
# @see http://docs.aws.amazon.com/goto/WebAPI/identitystore-2020-06-15/CreateGroupMembership AWS API Documentation
|
|
561
579
|
#
|
|
@@ -571,6 +589,10 @@ module Aws::IdentityStore
|
|
|
571
589
|
# @option params [required, String] :identity_store_id
|
|
572
590
|
# The globally unique identifier for the identity store.
|
|
573
591
|
#
|
|
592
|
+
# You can specify the identity store by ID or by Amazon Resource Name
|
|
593
|
+
# (ARN). For example, identity store ID `d-1234567890` or identity store
|
|
594
|
+
# ARN `arn:aws:identitystore::111122223333:identitystore/d-1234567890`.
|
|
595
|
+
#
|
|
574
596
|
# @option params [String] :user_name
|
|
575
597
|
# A unique string used to identify the user. The length limit is 128
|
|
576
598
|
# characters. This value can consist of letters, accented characters,
|
|
@@ -651,6 +673,8 @@ module Aws::IdentityStore
|
|
|
651
673
|
#
|
|
652
674
|
# * {Types::CreateUserResponse#identity_store_id #identity_store_id} => String
|
|
653
675
|
# * {Types::CreateUserResponse#user_id #user_id} => String
|
|
676
|
+
# * {Types::CreateUserResponse#user_arn #user_arn} => String
|
|
677
|
+
# * {Types::CreateUserResponse#revision #revision} => String
|
|
654
678
|
#
|
|
655
679
|
# @example Request syntax with placeholder values
|
|
656
680
|
#
|
|
@@ -725,6 +749,8 @@ module Aws::IdentityStore
|
|
|
725
749
|
#
|
|
726
750
|
# resp.identity_store_id #=> String
|
|
727
751
|
# resp.user_id #=> String
|
|
752
|
+
# resp.user_arn #=> String
|
|
753
|
+
# resp.revision #=> String
|
|
728
754
|
#
|
|
729
755
|
# @see http://docs.aws.amazon.com/goto/WebAPI/identitystore-2020-06-15/CreateUser AWS API Documentation
|
|
730
756
|
#
|
|
@@ -740,9 +766,24 @@ module Aws::IdentityStore
|
|
|
740
766
|
# @option params [required, String] :identity_store_id
|
|
741
767
|
# The globally unique identifier for the identity store.
|
|
742
768
|
#
|
|
769
|
+
# You can specify the identity store by ID or by Amazon Resource Name
|
|
770
|
+
# (ARN). For example, identity store ID `d-1234567890` or identity store
|
|
771
|
+
# ARN `arn:aws:identitystore::111122223333:identitystore/d-1234567890`.
|
|
772
|
+
#
|
|
743
773
|
# @option params [required, String] :group_id
|
|
744
774
|
# The identifier for a group in the identity store.
|
|
745
775
|
#
|
|
776
|
+
# You can specify the group by ID or by Amazon Resource Name (ARN). For
|
|
777
|
+
# example, group ID `a1b2c3d4-5678-90ab-cdef-EXAMPLE22222` or group ARN
|
|
778
|
+
# `arn:aws:identitystore:::group/a1b2c3d4-5678-90ab-cdef-EXAMPLE22222`.
|
|
779
|
+
#
|
|
780
|
+
# @option params [String] :revision
|
|
781
|
+
# The expected current revision of the group. When you provide this
|
|
782
|
+
# value, the group is deleted only if it matches the current revision of
|
|
783
|
+
# the group in the identity store. If the value doesn't match, the
|
|
784
|
+
# operation fails with a `ConflictException`. If you don't provide this
|
|
785
|
+
# value, the group is deleted regardless of its current revision.
|
|
786
|
+
#
|
|
746
787
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
|
747
788
|
#
|
|
748
789
|
# @example Request syntax with placeholder values
|
|
@@ -750,6 +791,7 @@ module Aws::IdentityStore
|
|
|
750
791
|
# resp = client.delete_group({
|
|
751
792
|
# identity_store_id: "IdentityStoreId", # required
|
|
752
793
|
# group_id: "ResourceId", # required
|
|
794
|
+
# revision: "ResourceRevision",
|
|
753
795
|
# })
|
|
754
796
|
#
|
|
755
797
|
# @see http://docs.aws.amazon.com/goto/WebAPI/identitystore-2020-06-15/DeleteGroup AWS API Documentation
|
|
@@ -766,9 +808,18 @@ module Aws::IdentityStore
|
|
|
766
808
|
# @option params [required, String] :identity_store_id
|
|
767
809
|
# The globally unique identifier for the identity store.
|
|
768
810
|
#
|
|
811
|
+
# You can specify the identity store by ID or by Amazon Resource Name
|
|
812
|
+
# (ARN). For example, identity store ID `d-1234567890` or identity store
|
|
813
|
+
# ARN `arn:aws:identitystore::111122223333:identitystore/d-1234567890`.
|
|
814
|
+
#
|
|
769
815
|
# @option params [required, String] :membership_id
|
|
770
816
|
# The identifier for a `GroupMembership` in an identity store.
|
|
771
817
|
#
|
|
818
|
+
# You can specify the group membership by ID or by Amazon Resource Name
|
|
819
|
+
# (ARN). For example, membership ID
|
|
820
|
+
# `a1b2c3d4-5678-90ab-cdef-EXAMPLE33333` or membership ARN
|
|
821
|
+
# `arn:aws:identitystore:::membership/a1b2c3d4-5678-90ab-cdef-EXAMPLE33333`.
|
|
822
|
+
#
|
|
772
823
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
|
773
824
|
#
|
|
774
825
|
# @example Request syntax with placeholder values
|
|
@@ -792,9 +843,24 @@ module Aws::IdentityStore
|
|
|
792
843
|
# @option params [required, String] :identity_store_id
|
|
793
844
|
# The globally unique identifier for the identity store.
|
|
794
845
|
#
|
|
846
|
+
# You can specify the identity store by ID or by Amazon Resource Name
|
|
847
|
+
# (ARN). For example, identity store ID `d-1234567890` or identity store
|
|
848
|
+
# ARN `arn:aws:identitystore::111122223333:identitystore/d-1234567890`.
|
|
849
|
+
#
|
|
795
850
|
# @option params [required, String] :user_id
|
|
796
851
|
# The identifier for a user in the identity store.
|
|
797
852
|
#
|
|
853
|
+
# You can specify the user by ID or by Amazon Resource Name (ARN). For
|
|
854
|
+
# example, user ID `a1b2c3d4-5678-90ab-cdef-EXAMPLE11111` or user ARN
|
|
855
|
+
# `arn:aws:identitystore:::user/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111`.
|
|
856
|
+
#
|
|
857
|
+
# @option params [String] :revision
|
|
858
|
+
# The expected current revision of the user. When you provide this
|
|
859
|
+
# value, the user is deleted only if it matches the current revision of
|
|
860
|
+
# the user in the identity store. If the value doesn't match, the
|
|
861
|
+
# operation fails with a `ConflictException`. If you don't provide this
|
|
862
|
+
# value, the user is deleted regardless of its current revision.
|
|
863
|
+
#
|
|
798
864
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
|
799
865
|
#
|
|
800
866
|
# @example Request syntax with placeholder values
|
|
@@ -802,6 +868,7 @@ module Aws::IdentityStore
|
|
|
802
868
|
# resp = client.delete_user({
|
|
803
869
|
# identity_store_id: "IdentityStoreId", # required
|
|
804
870
|
# user_id: "ResourceId", # required
|
|
871
|
+
# revision: "ResourceRevision",
|
|
805
872
|
# })
|
|
806
873
|
#
|
|
807
874
|
# @see http://docs.aws.amazon.com/goto/WebAPI/identitystore-2020-06-15/DeleteUser AWS API Documentation
|
|
@@ -834,12 +901,23 @@ module Aws::IdentityStore
|
|
|
834
901
|
# lower case letters. This value is generated at the time that a new
|
|
835
902
|
# identity store is created.
|
|
836
903
|
#
|
|
904
|
+
# You can specify the identity store by ID or by Amazon Resource Name
|
|
905
|
+
# (ARN). For example, identity store ID `d-1234567890` or identity store
|
|
906
|
+
# ARN `arn:aws:identitystore::111122223333:identitystore/d-1234567890`.
|
|
907
|
+
#
|
|
837
908
|
# @option params [required, String] :group_id
|
|
838
909
|
# The identifier for a group in the identity store.
|
|
839
910
|
#
|
|
911
|
+
# You can specify the group by ID or by Amazon Resource Name (ARN). For
|
|
912
|
+
# example, group ID `a1b2c3d4-5678-90ab-cdef-EXAMPLE22222` or group ARN
|
|
913
|
+
# `arn:aws:identitystore:::group/a1b2c3d4-5678-90ab-cdef-EXAMPLE22222`.
|
|
914
|
+
#
|
|
840
915
|
# @return [Types::DescribeGroupResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
841
916
|
#
|
|
917
|
+
# * {Types::DescribeGroupResponse#identity_store_id #identity_store_id} => String
|
|
842
918
|
# * {Types::DescribeGroupResponse#group_id #group_id} => String
|
|
919
|
+
# * {Types::DescribeGroupResponse#group_arn #group_arn} => String
|
|
920
|
+
# * {Types::DescribeGroupResponse#revision #revision} => String
|
|
843
921
|
# * {Types::DescribeGroupResponse#display_name #display_name} => String
|
|
844
922
|
# * {Types::DescribeGroupResponse#external_ids #external_ids} => Array<Types::ExternalId>
|
|
845
923
|
# * {Types::DescribeGroupResponse#description #description} => String
|
|
@@ -847,7 +925,6 @@ module Aws::IdentityStore
|
|
|
847
925
|
# * {Types::DescribeGroupResponse#updated_at #updated_at} => Time
|
|
848
926
|
# * {Types::DescribeGroupResponse#created_by #created_by} => String
|
|
849
927
|
# * {Types::DescribeGroupResponse#updated_by #updated_by} => String
|
|
850
|
-
# * {Types::DescribeGroupResponse#identity_store_id #identity_store_id} => String
|
|
851
928
|
#
|
|
852
929
|
# @example Request syntax with placeholder values
|
|
853
930
|
#
|
|
@@ -858,7 +935,10 @@ module Aws::IdentityStore
|
|
|
858
935
|
#
|
|
859
936
|
# @example Response structure
|
|
860
937
|
#
|
|
938
|
+
# resp.identity_store_id #=> String
|
|
861
939
|
# resp.group_id #=> String
|
|
940
|
+
# resp.group_arn #=> String
|
|
941
|
+
# resp.revision #=> String
|
|
862
942
|
# resp.display_name #=> String
|
|
863
943
|
# resp.external_ids #=> Array
|
|
864
944
|
# resp.external_ids[0].issuer #=> String
|
|
@@ -868,7 +948,6 @@ module Aws::IdentityStore
|
|
|
868
948
|
# resp.updated_at #=> Time
|
|
869
949
|
# resp.created_by #=> String
|
|
870
950
|
# resp.updated_by #=> String
|
|
871
|
-
# resp.identity_store_id #=> String
|
|
872
951
|
#
|
|
873
952
|
# @see http://docs.aws.amazon.com/goto/WebAPI/identitystore-2020-06-15/DescribeGroup AWS API Documentation
|
|
874
953
|
#
|
|
@@ -896,13 +975,23 @@ module Aws::IdentityStore
|
|
|
896
975
|
# @option params [required, String] :identity_store_id
|
|
897
976
|
# The globally unique identifier for the identity store.
|
|
898
977
|
#
|
|
978
|
+
# You can specify the identity store by ID or by Amazon Resource Name
|
|
979
|
+
# (ARN). For example, identity store ID `d-1234567890` or identity store
|
|
980
|
+
# ARN `arn:aws:identitystore::111122223333:identitystore/d-1234567890`.
|
|
981
|
+
#
|
|
899
982
|
# @option params [required, String] :membership_id
|
|
900
983
|
# The identifier for a `GroupMembership` in an identity store.
|
|
901
984
|
#
|
|
985
|
+
# You can specify the group membership by ID or by Amazon Resource Name
|
|
986
|
+
# (ARN). For example, membership ID
|
|
987
|
+
# `a1b2c3d4-5678-90ab-cdef-EXAMPLE33333` or membership ARN
|
|
988
|
+
# `arn:aws:identitystore:::membership/a1b2c3d4-5678-90ab-cdef-EXAMPLE33333`.
|
|
989
|
+
#
|
|
902
990
|
# @return [Types::DescribeGroupMembershipResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
903
991
|
#
|
|
904
992
|
# * {Types::DescribeGroupMembershipResponse#identity_store_id #identity_store_id} => String
|
|
905
993
|
# * {Types::DescribeGroupMembershipResponse#membership_id #membership_id} => String
|
|
994
|
+
# * {Types::DescribeGroupMembershipResponse#membership_arn #membership_arn} => String
|
|
906
995
|
# * {Types::DescribeGroupMembershipResponse#group_id #group_id} => String
|
|
907
996
|
# * {Types::DescribeGroupMembershipResponse#member_id #member_id} => Types::MemberId
|
|
908
997
|
# * {Types::DescribeGroupMembershipResponse#created_at #created_at} => Time
|
|
@@ -921,6 +1010,7 @@ module Aws::IdentityStore
|
|
|
921
1010
|
#
|
|
922
1011
|
# resp.identity_store_id #=> String
|
|
923
1012
|
# resp.membership_id #=> String
|
|
1013
|
+
# resp.membership_arn #=> String
|
|
924
1014
|
# resp.group_id #=> String
|
|
925
1015
|
# resp.member_id.user_id #=> String
|
|
926
1016
|
# resp.created_at #=> Time
|
|
@@ -937,6 +1027,49 @@ module Aws::IdentityStore
|
|
|
937
1027
|
req.send_request(options)
|
|
938
1028
|
end
|
|
939
1029
|
|
|
1030
|
+
# Retrieves details about the specified identity store, including its
|
|
1031
|
+
# Amazon Resource Name (ARN) and network configuration.
|
|
1032
|
+
#
|
|
1033
|
+
# @option params [required, String] :identity_store_id
|
|
1034
|
+
# The globally unique identifier for the identity store.
|
|
1035
|
+
#
|
|
1036
|
+
# You can specify the identity store by ID or by Amazon Resource Name
|
|
1037
|
+
# (ARN). For example, identity store ID `d-1234567890` or identity store
|
|
1038
|
+
# ARN `arn:aws:identitystore::111122223333:identitystore/d-1234567890`.
|
|
1039
|
+
#
|
|
1040
|
+
# @return [Types::DescribeIdentityStoreResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
1041
|
+
#
|
|
1042
|
+
# * {Types::DescribeIdentityStoreResponse#identity_store_id #identity_store_id} => String
|
|
1043
|
+
# * {Types::DescribeIdentityStoreResponse#identity_store_arn #identity_store_arn} => String
|
|
1044
|
+
# * {Types::DescribeIdentityStoreResponse#network_configuration #network_configuration} => Types::NetworkConfigurationDetails
|
|
1045
|
+
#
|
|
1046
|
+
# @example Request syntax with placeholder values
|
|
1047
|
+
#
|
|
1048
|
+
# resp = client.describe_identity_store({
|
|
1049
|
+
# identity_store_id: "IdentityStoreId", # required
|
|
1050
|
+
# })
|
|
1051
|
+
#
|
|
1052
|
+
# @example Response structure
|
|
1053
|
+
#
|
|
1054
|
+
# resp.identity_store_id #=> String
|
|
1055
|
+
# resp.identity_store_arn #=> String
|
|
1056
|
+
# resp.network_configuration.vpce_access_required #=> Boolean
|
|
1057
|
+
# resp.network_configuration.api_restrict_source_vpcs #=> Array
|
|
1058
|
+
# resp.network_configuration.api_restrict_source_vpcs[0] #=> String
|
|
1059
|
+
# resp.network_configuration.api_allow_source_ips #=> Array
|
|
1060
|
+
# resp.network_configuration.api_allow_source_ips[0] #=> String
|
|
1061
|
+
# resp.network_configuration.scim_allow_source_ips #=> Array
|
|
1062
|
+
# resp.network_configuration.scim_allow_source_ips[0] #=> String
|
|
1063
|
+
#
|
|
1064
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/identitystore-2020-06-15/DescribeIdentityStore AWS API Documentation
|
|
1065
|
+
#
|
|
1066
|
+
# @overload describe_identity_store(params = {})
|
|
1067
|
+
# @param [Hash] params ({})
|
|
1068
|
+
def describe_identity_store(params = {}, options = {})
|
|
1069
|
+
req = build_request(:describe_identity_store, params)
|
|
1070
|
+
req.send_request(options)
|
|
1071
|
+
end
|
|
1072
|
+
|
|
940
1073
|
# Retrieves the user metadata and attributes from the `UserId` in an
|
|
941
1074
|
# identity store.
|
|
942
1075
|
#
|
|
@@ -958,9 +1091,17 @@ module Aws::IdentityStore
|
|
|
958
1091
|
# lower case letters. This value is generated at the time that a new
|
|
959
1092
|
# identity store is created.
|
|
960
1093
|
#
|
|
1094
|
+
# You can specify the identity store by ID or by Amazon Resource Name
|
|
1095
|
+
# (ARN). For example, identity store ID `d-1234567890` or identity store
|
|
1096
|
+
# ARN `arn:aws:identitystore::111122223333:identitystore/d-1234567890`.
|
|
1097
|
+
#
|
|
961
1098
|
# @option params [required, String] :user_id
|
|
962
1099
|
# The identifier for a user in the identity store.
|
|
963
1100
|
#
|
|
1101
|
+
# You can specify the user by ID or by Amazon Resource Name (ARN). For
|
|
1102
|
+
# example, user ID `a1b2c3d4-5678-90ab-cdef-EXAMPLE11111` or user ARN
|
|
1103
|
+
# `arn:aws:identitystore:::user/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111`.
|
|
1104
|
+
#
|
|
964
1105
|
# @option params [Array<String>] :extensions
|
|
965
1106
|
# A collection of extension names indicating what extensions the service
|
|
966
1107
|
# should retrieve alongside other user attributes.
|
|
@@ -970,6 +1111,8 @@ module Aws::IdentityStore
|
|
|
970
1111
|
#
|
|
971
1112
|
# * {Types::DescribeUserResponse#identity_store_id #identity_store_id} => String
|
|
972
1113
|
# * {Types::DescribeUserResponse#user_id #user_id} => String
|
|
1114
|
+
# * {Types::DescribeUserResponse#user_arn #user_arn} => String
|
|
1115
|
+
# * {Types::DescribeUserResponse#revision #revision} => String
|
|
973
1116
|
# * {Types::DescribeUserResponse#user_name #user_name} => String
|
|
974
1117
|
# * {Types::DescribeUserResponse#external_ids #external_ids} => Array<Types::ExternalId>
|
|
975
1118
|
# * {Types::DescribeUserResponse#name #name} => Types::Name
|
|
@@ -1007,6 +1150,8 @@ module Aws::IdentityStore
|
|
|
1007
1150
|
#
|
|
1008
1151
|
# resp.identity_store_id #=> String
|
|
1009
1152
|
# resp.user_id #=> String
|
|
1153
|
+
# resp.user_arn #=> String
|
|
1154
|
+
# resp.revision #=> String
|
|
1010
1155
|
# resp.user_name #=> String
|
|
1011
1156
|
# resp.external_ids #=> Array
|
|
1012
1157
|
# resp.external_ids[0].issuer #=> String
|
|
@@ -1086,6 +1231,10 @@ module Aws::IdentityStore
|
|
|
1086
1231
|
# @option params [required, String] :identity_store_id
|
|
1087
1232
|
# The globally unique identifier for the identity store.
|
|
1088
1233
|
#
|
|
1234
|
+
# You can specify the identity store by ID or by Amazon Resource Name
|
|
1235
|
+
# (ARN). For example, identity store ID `d-1234567890` or identity store
|
|
1236
|
+
# ARN `arn:aws:identitystore::111122223333:identitystore/d-1234567890`.
|
|
1237
|
+
#
|
|
1089
1238
|
# @option params [required, Types::AlternateIdentifier] :alternate_identifier
|
|
1090
1239
|
# A unique identifier for a user or group that is not the primary
|
|
1091
1240
|
# identifier. This value can be an identifier from an external identity
|
|
@@ -1095,8 +1244,9 @@ module Aws::IdentityStore
|
|
|
1095
1244
|
#
|
|
1096
1245
|
# @return [Types::GetGroupIdResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
1097
1246
|
#
|
|
1098
|
-
# * {Types::GetGroupIdResponse#group_id #group_id} => String
|
|
1099
1247
|
# * {Types::GetGroupIdResponse#identity_store_id #identity_store_id} => String
|
|
1248
|
+
# * {Types::GetGroupIdResponse#group_id #group_id} => String
|
|
1249
|
+
# * {Types::GetGroupIdResponse#group_arn #group_arn} => String
|
|
1100
1250
|
#
|
|
1101
1251
|
# @example Request syntax with placeholder values
|
|
1102
1252
|
#
|
|
@@ -1116,8 +1266,9 @@ module Aws::IdentityStore
|
|
|
1116
1266
|
#
|
|
1117
1267
|
# @example Response structure
|
|
1118
1268
|
#
|
|
1119
|
-
# resp.group_id #=> String
|
|
1120
1269
|
# resp.identity_store_id #=> String
|
|
1270
|
+
# resp.group_id #=> String
|
|
1271
|
+
# resp.group_arn #=> String
|
|
1121
1272
|
#
|
|
1122
1273
|
# @see http://docs.aws.amazon.com/goto/WebAPI/identitystore-2020-06-15/GetGroupId AWS API Documentation
|
|
1123
1274
|
#
|
|
@@ -1144,9 +1295,17 @@ module Aws::IdentityStore
|
|
|
1144
1295
|
# @option params [required, String] :identity_store_id
|
|
1145
1296
|
# The globally unique identifier for the identity store.
|
|
1146
1297
|
#
|
|
1298
|
+
# You can specify the identity store by ID or by Amazon Resource Name
|
|
1299
|
+
# (ARN). For example, identity store ID `d-1234567890` or identity store
|
|
1300
|
+
# ARN `arn:aws:identitystore::111122223333:identitystore/d-1234567890`.
|
|
1301
|
+
#
|
|
1147
1302
|
# @option params [required, String] :group_id
|
|
1148
1303
|
# The identifier for a group in the identity store.
|
|
1149
1304
|
#
|
|
1305
|
+
# You can specify the group by ID or by Amazon Resource Name (ARN). For
|
|
1306
|
+
# example, group ID `a1b2c3d4-5678-90ab-cdef-EXAMPLE22222` or group ARN
|
|
1307
|
+
# `arn:aws:identitystore:::group/a1b2c3d4-5678-90ab-cdef-EXAMPLE22222`.
|
|
1308
|
+
#
|
|
1150
1309
|
# @option params [required, Types::MemberId] :member_id
|
|
1151
1310
|
# An object that contains the identifier of a group member. Setting the
|
|
1152
1311
|
# `UserID` field to the specific identifier for a user indicates that
|
|
@@ -1154,8 +1313,9 @@ module Aws::IdentityStore
|
|
|
1154
1313
|
#
|
|
1155
1314
|
# @return [Types::GetGroupMembershipIdResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
1156
1315
|
#
|
|
1157
|
-
# * {Types::GetGroupMembershipIdResponse#membership_id #membership_id} => String
|
|
1158
1316
|
# * {Types::GetGroupMembershipIdResponse#identity_store_id #identity_store_id} => String
|
|
1317
|
+
# * {Types::GetGroupMembershipIdResponse#membership_id #membership_id} => String
|
|
1318
|
+
# * {Types::GetGroupMembershipIdResponse#membership_arn #membership_arn} => String
|
|
1159
1319
|
#
|
|
1160
1320
|
# @example Request syntax with placeholder values
|
|
1161
1321
|
#
|
|
@@ -1169,8 +1329,9 @@ module Aws::IdentityStore
|
|
|
1169
1329
|
#
|
|
1170
1330
|
# @example Response structure
|
|
1171
1331
|
#
|
|
1172
|
-
# resp.membership_id #=> String
|
|
1173
1332
|
# resp.identity_store_id #=> String
|
|
1333
|
+
# resp.membership_id #=> String
|
|
1334
|
+
# resp.membership_arn #=> String
|
|
1174
1335
|
#
|
|
1175
1336
|
# @see http://docs.aws.amazon.com/goto/WebAPI/identitystore-2020-06-15/GetGroupMembershipId AWS API Documentation
|
|
1176
1337
|
#
|
|
@@ -1197,6 +1358,10 @@ module Aws::IdentityStore
|
|
|
1197
1358
|
# @option params [required, String] :identity_store_id
|
|
1198
1359
|
# The globally unique identifier for the identity store.
|
|
1199
1360
|
#
|
|
1361
|
+
# You can specify the identity store by ID or by Amazon Resource Name
|
|
1362
|
+
# (ARN). For example, identity store ID `d-1234567890` or identity store
|
|
1363
|
+
# ARN `arn:aws:identitystore::111122223333:identitystore/d-1234567890`.
|
|
1364
|
+
#
|
|
1200
1365
|
# @option params [required, Types::AlternateIdentifier] :alternate_identifier
|
|
1201
1366
|
# A unique identifier for a user or group that is not the primary
|
|
1202
1367
|
# identifier. This value can be an identifier from an external identity
|
|
@@ -1208,6 +1373,7 @@ module Aws::IdentityStore
|
|
|
1208
1373
|
#
|
|
1209
1374
|
# * {Types::GetUserIdResponse#identity_store_id #identity_store_id} => String
|
|
1210
1375
|
# * {Types::GetUserIdResponse#user_id #user_id} => String
|
|
1376
|
+
# * {Types::GetUserIdResponse#user_arn #user_arn} => String
|
|
1211
1377
|
#
|
|
1212
1378
|
# @example Request syntax with placeholder values
|
|
1213
1379
|
#
|
|
@@ -1229,6 +1395,7 @@ module Aws::IdentityStore
|
|
|
1229
1395
|
#
|
|
1230
1396
|
# resp.identity_store_id #=> String
|
|
1231
1397
|
# resp.user_id #=> String
|
|
1398
|
+
# resp.user_arn #=> String
|
|
1232
1399
|
#
|
|
1233
1400
|
# @see http://docs.aws.amazon.com/goto/WebAPI/identitystore-2020-06-15/GetUserId AWS API Documentation
|
|
1234
1401
|
#
|
|
@@ -1256,12 +1423,20 @@ module Aws::IdentityStore
|
|
|
1256
1423
|
# @option params [required, String] :identity_store_id
|
|
1257
1424
|
# The globally unique identifier for the identity store.
|
|
1258
1425
|
#
|
|
1426
|
+
# You can specify the identity store by ID or by Amazon Resource Name
|
|
1427
|
+
# (ARN). For example, identity store ID `d-1234567890` or identity store
|
|
1428
|
+
# ARN `arn:aws:identitystore::111122223333:identitystore/d-1234567890`.
|
|
1429
|
+
#
|
|
1259
1430
|
# @option params [required, Types::MemberId] :member_id
|
|
1260
1431
|
# An object containing the identifier of a group member.
|
|
1261
1432
|
#
|
|
1262
1433
|
# @option params [required, Array<String>] :group_ids
|
|
1263
1434
|
# A list of identifiers for groups in the identity store.
|
|
1264
1435
|
#
|
|
1436
|
+
# You can specify each group by ID or by Amazon Resource Name (ARN). For
|
|
1437
|
+
# example, group ID `a1b2c3d4-5678-90ab-cdef-EXAMPLE22222` or group ARN
|
|
1438
|
+
# `arn:aws:identitystore:::group/a1b2c3d4-5678-90ab-cdef-EXAMPLE22222`.
|
|
1439
|
+
#
|
|
1265
1440
|
# @return [Types::IsMemberInGroupsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
1266
1441
|
#
|
|
1267
1442
|
# * {Types::IsMemberInGroupsResponse#results #results} => Array<Types::GroupMembershipExistenceResult>
|
|
@@ -1310,9 +1485,17 @@ module Aws::IdentityStore
|
|
|
1310
1485
|
# @option params [required, String] :identity_store_id
|
|
1311
1486
|
# The globally unique identifier for the identity store.
|
|
1312
1487
|
#
|
|
1488
|
+
# You can specify the identity store by ID or by Amazon Resource Name
|
|
1489
|
+
# (ARN). For example, identity store ID `d-1234567890` or identity store
|
|
1490
|
+
# ARN `arn:aws:identitystore::111122223333:identitystore/d-1234567890`.
|
|
1491
|
+
#
|
|
1313
1492
|
# @option params [required, String] :group_id
|
|
1314
1493
|
# The identifier for a group in the identity store.
|
|
1315
1494
|
#
|
|
1495
|
+
# You can specify the group by ID or by Amazon Resource Name (ARN). For
|
|
1496
|
+
# example, group ID `a1b2c3d4-5678-90ab-cdef-EXAMPLE22222` or group ARN
|
|
1497
|
+
# `arn:aws:identitystore:::group/a1b2c3d4-5678-90ab-cdef-EXAMPLE22222`.
|
|
1498
|
+
#
|
|
1316
1499
|
# @option params [Integer] :max_results
|
|
1317
1500
|
# The maximum number of results to be returned per request. This
|
|
1318
1501
|
# parameter is used in all ` List` requests to specify how many results
|
|
@@ -1323,8 +1506,8 @@ module Aws::IdentityStore
|
|
|
1323
1506
|
# ListGroupMemberships` API operations. This value is generated by the
|
|
1324
1507
|
# identity store service. It is returned in the API response if the
|
|
1325
1508
|
# total results are more than the size of one page. This token is also
|
|
1326
|
-
# returned when it is used in the API request to
|
|
1327
|
-
#
|
|
1509
|
+
# returned when it is used in the API request to retrieve the next page
|
|
1510
|
+
# of results.
|
|
1328
1511
|
#
|
|
1329
1512
|
# @return [Types::ListGroupMembershipsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
1330
1513
|
#
|
|
@@ -1347,6 +1530,7 @@ module Aws::IdentityStore
|
|
|
1347
1530
|
# resp.group_memberships #=> Array
|
|
1348
1531
|
# resp.group_memberships[0].identity_store_id #=> String
|
|
1349
1532
|
# resp.group_memberships[0].membership_id #=> String
|
|
1533
|
+
# resp.group_memberships[0].membership_arn #=> String
|
|
1350
1534
|
# resp.group_memberships[0].group_id #=> String
|
|
1351
1535
|
# resp.group_memberships[0].member_id.user_id #=> String
|
|
1352
1536
|
# resp.group_memberships[0].created_at #=> Time
|
|
@@ -1382,6 +1566,10 @@ module Aws::IdentityStore
|
|
|
1382
1566
|
# @option params [required, String] :identity_store_id
|
|
1383
1567
|
# The globally unique identifier for the identity store.
|
|
1384
1568
|
#
|
|
1569
|
+
# You can specify the identity store by ID or by Amazon Resource Name
|
|
1570
|
+
# (ARN). For example, identity store ID `d-1234567890` or identity store
|
|
1571
|
+
# ARN `arn:aws:identitystore::111122223333:identitystore/d-1234567890`.
|
|
1572
|
+
#
|
|
1385
1573
|
# @option params [required, Types::MemberId] :member_id
|
|
1386
1574
|
# An object that contains the identifier of a group member. Setting the
|
|
1387
1575
|
# `UserID` field to the specific identifier for a user indicates that
|
|
@@ -1389,17 +1577,16 @@ module Aws::IdentityStore
|
|
|
1389
1577
|
#
|
|
1390
1578
|
# @option params [Integer] :max_results
|
|
1391
1579
|
# The maximum number of results to be returned per request. This
|
|
1392
|
-
# parameter is used in
|
|
1393
|
-
#
|
|
1394
|
-
# characters.
|
|
1580
|
+
# parameter is used in all `List` requests to specify how many results
|
|
1581
|
+
# to return in one page.
|
|
1395
1582
|
#
|
|
1396
1583
|
# @option params [String] :next_token
|
|
1397
1584
|
# The pagination token used for the `ListUsers`, `ListGroups`, and `
|
|
1398
1585
|
# ListGroupMemberships` API operations. This value is generated by the
|
|
1399
1586
|
# identity store service. It is returned in the API response if the
|
|
1400
1587
|
# total results are more than the size of one page. This token is also
|
|
1401
|
-
# returned when it is used in the API request to
|
|
1402
|
-
#
|
|
1588
|
+
# returned when it is used in the API request to retrieve the next page
|
|
1589
|
+
# of results.
|
|
1403
1590
|
#
|
|
1404
1591
|
# @return [Types::ListGroupMembershipsForMemberResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
1405
1592
|
#
|
|
@@ -1424,6 +1611,7 @@ module Aws::IdentityStore
|
|
|
1424
1611
|
# resp.group_memberships #=> Array
|
|
1425
1612
|
# resp.group_memberships[0].identity_store_id #=> String
|
|
1426
1613
|
# resp.group_memberships[0].membership_id #=> String
|
|
1614
|
+
# resp.group_memberships[0].membership_arn #=> String
|
|
1427
1615
|
# resp.group_memberships[0].group_id #=> String
|
|
1428
1616
|
# resp.group_memberships[0].member_id.user_id #=> String
|
|
1429
1617
|
# resp.group_memberships[0].created_at #=> Time
|
|
@@ -1463,18 +1651,21 @@ module Aws::IdentityStore
|
|
|
1463
1651
|
# lower case letters. This value is generated at the time that a new
|
|
1464
1652
|
# identity store is created.
|
|
1465
1653
|
#
|
|
1654
|
+
# You can specify the identity store by ID or by Amazon Resource Name
|
|
1655
|
+
# (ARN). For example, identity store ID `d-1234567890` or identity store
|
|
1656
|
+
# ARN `arn:aws:identitystore::111122223333:identitystore/d-1234567890`.
|
|
1657
|
+
#
|
|
1466
1658
|
# @option params [Integer] :max_results
|
|
1467
1659
|
# The maximum number of results to be returned per request. This
|
|
1468
|
-
# parameter is used in
|
|
1469
|
-
#
|
|
1470
|
-
# characters.
|
|
1660
|
+
# parameter is used in all `List` requests to specify how many results
|
|
1661
|
+
# to return in one page.
|
|
1471
1662
|
#
|
|
1472
1663
|
# @option params [String] :next_token
|
|
1473
1664
|
# The pagination token used for the `ListUsers` and `ListGroups` API
|
|
1474
1665
|
# operations. This value is generated by the identity store service. It
|
|
1475
1666
|
# is returned in the API response if the total results are more than the
|
|
1476
1667
|
# size of one page. This token is also returned when it is used in the
|
|
1477
|
-
# API request to
|
|
1668
|
+
# API request to retrieve the next page of results.
|
|
1478
1669
|
#
|
|
1479
1670
|
# @option params [Array<Types::Filter>] :filters
|
|
1480
1671
|
# A list of `Filter` objects, which is used in the `ListUsers` and `
|
|
@@ -1504,7 +1695,10 @@ module Aws::IdentityStore
|
|
|
1504
1695
|
# @example Response structure
|
|
1505
1696
|
#
|
|
1506
1697
|
# resp.groups #=> Array
|
|
1698
|
+
# resp.groups[0].identity_store_id #=> String
|
|
1507
1699
|
# resp.groups[0].group_id #=> String
|
|
1700
|
+
# resp.groups[0].group_arn #=> String
|
|
1701
|
+
# resp.groups[0].revision #=> String
|
|
1508
1702
|
# resp.groups[0].display_name #=> String
|
|
1509
1703
|
# resp.groups[0].external_ids #=> Array
|
|
1510
1704
|
# resp.groups[0].external_ids[0].issuer #=> String
|
|
@@ -1514,7 +1708,6 @@ module Aws::IdentityStore
|
|
|
1514
1708
|
# resp.groups[0].updated_at #=> Time
|
|
1515
1709
|
# resp.groups[0].created_by #=> String
|
|
1516
1710
|
# resp.groups[0].updated_by #=> String
|
|
1517
|
-
# resp.groups[0].identity_store_id #=> String
|
|
1518
1711
|
# resp.next_token #=> String
|
|
1519
1712
|
#
|
|
1520
1713
|
# @see http://docs.aws.amazon.com/goto/WebAPI/identitystore-2020-06-15/ListGroups AWS API Documentation
|
|
@@ -1526,6 +1719,57 @@ module Aws::IdentityStore
|
|
|
1526
1719
|
req.send_request(options)
|
|
1527
1720
|
end
|
|
1528
1721
|
|
|
1722
|
+
# Lists the identity stores that you have access to. This operation
|
|
1723
|
+
# returns only the identity store ID and Amazon Resource Name (ARN) of
|
|
1724
|
+
# each identity store. To obtain additional information about an
|
|
1725
|
+
# identity store, call `DescribeIdentityStore`.
|
|
1726
|
+
#
|
|
1727
|
+
# This operation returns results in paginated form. Use the `NextToken`
|
|
1728
|
+
# parameter to retrieve additional pages of results.
|
|
1729
|
+
#
|
|
1730
|
+
# @option params [Integer] :max_results
|
|
1731
|
+
# The maximum number of results to return per request. This parameter is
|
|
1732
|
+
# used in all ` List` operations to specify how many results to return
|
|
1733
|
+
# on one page. If you don't specify a value, the operation uses a
|
|
1734
|
+
# default page size.
|
|
1735
|
+
#
|
|
1736
|
+
# @option params [String] :next_token
|
|
1737
|
+
# The pagination token used for the `ListIdentityStores` API operation.
|
|
1738
|
+
# This value is generated by the identity store service. It is returned
|
|
1739
|
+
# in the API response if the total results are more than the size of one
|
|
1740
|
+
# page. This token is also returned when it is used in the API request
|
|
1741
|
+
# to retrieve the next page of results.
|
|
1742
|
+
#
|
|
1743
|
+
# @return [Types::ListIdentityStoresResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
1744
|
+
#
|
|
1745
|
+
# * {Types::ListIdentityStoresResponse#identity_stores #identity_stores} => Array<Types::IdentityStore>
|
|
1746
|
+
# * {Types::ListIdentityStoresResponse#next_token #next_token} => String
|
|
1747
|
+
#
|
|
1748
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
|
1749
|
+
#
|
|
1750
|
+
# @example Request syntax with placeholder values
|
|
1751
|
+
#
|
|
1752
|
+
# resp = client.list_identity_stores({
|
|
1753
|
+
# max_results: 1,
|
|
1754
|
+
# next_token: "NextToken",
|
|
1755
|
+
# })
|
|
1756
|
+
#
|
|
1757
|
+
# @example Response structure
|
|
1758
|
+
#
|
|
1759
|
+
# resp.identity_stores #=> Array
|
|
1760
|
+
# resp.identity_stores[0].identity_store_id #=> String
|
|
1761
|
+
# resp.identity_stores[0].identity_store_arn #=> String
|
|
1762
|
+
# resp.next_token #=> String
|
|
1763
|
+
#
|
|
1764
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/identitystore-2020-06-15/ListIdentityStores AWS API Documentation
|
|
1765
|
+
#
|
|
1766
|
+
# @overload list_identity_stores(params = {})
|
|
1767
|
+
# @param [Hash] params ({})
|
|
1768
|
+
def list_identity_stores(params = {}, options = {})
|
|
1769
|
+
req = build_request(:list_identity_stores, params)
|
|
1770
|
+
req.send_request(options)
|
|
1771
|
+
end
|
|
1772
|
+
|
|
1529
1773
|
# Lists all users in the identity store. Returns a paginated list of
|
|
1530
1774
|
# complete `User` objects. Filtering for a `User` by the `UserName`
|
|
1531
1775
|
# attribute is deprecated. Instead, use the `GetUserId` API action.
|
|
@@ -1548,6 +1792,10 @@ module Aws::IdentityStore
|
|
|
1548
1792
|
# lower case letters. This value is generated at the time that a new
|
|
1549
1793
|
# identity store is created.
|
|
1550
1794
|
#
|
|
1795
|
+
# You can specify the identity store by ID or by Amazon Resource Name
|
|
1796
|
+
# (ARN). For example, identity store ID `d-1234567890` or identity store
|
|
1797
|
+
# ARN `arn:aws:identitystore::111122223333:identitystore/d-1234567890`.
|
|
1798
|
+
#
|
|
1551
1799
|
# @option params [Array<String>] :extensions
|
|
1552
1800
|
# A collection of extension names indicating what extensions the service
|
|
1553
1801
|
# should retrieve alongside other user attributes.
|
|
@@ -1555,16 +1803,15 @@ module Aws::IdentityStore
|
|
|
1555
1803
|
#
|
|
1556
1804
|
# @option params [Integer] :max_results
|
|
1557
1805
|
# The maximum number of results to be returned per request. This
|
|
1558
|
-
# parameter is used in
|
|
1559
|
-
#
|
|
1560
|
-
# characters.
|
|
1806
|
+
# parameter is used in all `List` requests to specify how many results
|
|
1807
|
+
# to return in one page.
|
|
1561
1808
|
#
|
|
1562
1809
|
# @option params [String] :next_token
|
|
1563
1810
|
# The pagination token used for the `ListUsers` and `ListGroups` API
|
|
1564
1811
|
# operations. This value is generated by the identity store service. It
|
|
1565
1812
|
# is returned in the API response if the total results are more than the
|
|
1566
1813
|
# size of one page. This token is also returned when it is used in the
|
|
1567
|
-
# API request to
|
|
1814
|
+
# API request to retrieve the next page of results.
|
|
1568
1815
|
#
|
|
1569
1816
|
# @option params [Array<Types::Filter>] :filters
|
|
1570
1817
|
# A list of `Filter` objects, which is used in the `ListUsers` and `
|
|
@@ -1597,6 +1844,8 @@ module Aws::IdentityStore
|
|
|
1597
1844
|
# resp.users #=> Array
|
|
1598
1845
|
# resp.users[0].identity_store_id #=> String
|
|
1599
1846
|
# resp.users[0].user_id #=> String
|
|
1847
|
+
# resp.users[0].user_arn #=> String
|
|
1848
|
+
# resp.users[0].revision #=> String
|
|
1600
1849
|
# resp.users[0].user_name #=> String
|
|
1601
1850
|
# resp.users[0].external_ids #=> Array
|
|
1602
1851
|
# resp.users[0].external_ids[0].issuer #=> String
|
|
@@ -1667,9 +1916,17 @@ module Aws::IdentityStore
|
|
|
1667
1916
|
# @option params [required, String] :identity_store_id
|
|
1668
1917
|
# The globally unique identifier for the identity store.
|
|
1669
1918
|
#
|
|
1919
|
+
# You can specify the identity store by ID or by Amazon Resource Name
|
|
1920
|
+
# (ARN). For example, identity store ID `d-1234567890` or identity store
|
|
1921
|
+
# ARN `arn:aws:identitystore::111122223333:identitystore/d-1234567890`.
|
|
1922
|
+
#
|
|
1670
1923
|
# @option params [required, String] :group_id
|
|
1671
1924
|
# The identifier for a group in the identity store.
|
|
1672
1925
|
#
|
|
1926
|
+
# You can specify the group by ID or by Amazon Resource Name (ARN). For
|
|
1927
|
+
# example, group ID `a1b2c3d4-5678-90ab-cdef-EXAMPLE22222` or group ARN
|
|
1928
|
+
# `arn:aws:identitystore:::group/a1b2c3d4-5678-90ab-cdef-EXAMPLE22222`.
|
|
1929
|
+
#
|
|
1673
1930
|
# @option params [required, Array<Types::AttributeOperation>] :operations
|
|
1674
1931
|
# A list of `AttributeOperation` objects to apply to the requested
|
|
1675
1932
|
# group. These operations might add, replace, or remove an attribute.
|
|
@@ -1680,7 +1937,20 @@ module Aws::IdentityStore
|
|
|
1680
1937
|
#
|
|
1681
1938
|
# [1]: https://docs.aws.amazon.com/singlesignon/latest/IdentityStoreAPIReference/API_Group.html
|
|
1682
1939
|
#
|
|
1683
|
-
# @
|
|
1940
|
+
# @option params [String] :revision
|
|
1941
|
+
# The expected current revision of the group. When you provide this
|
|
1942
|
+
# value, the update is applied only if it matches the current revision
|
|
1943
|
+
# of the group in the identity store, which prevents you from
|
|
1944
|
+
# overwriting concurrent changes. If the value doesn't match, the
|
|
1945
|
+
# operation fails with a `ConflictException`. If you don't provide this
|
|
1946
|
+
# value, the update is applied unconditionally.
|
|
1947
|
+
#
|
|
1948
|
+
# @return [Types::UpdateGroupResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
1949
|
+
#
|
|
1950
|
+
# * {Types::UpdateGroupResponse#identity_store_id #identity_store_id} => String
|
|
1951
|
+
# * {Types::UpdateGroupResponse#group_id #group_id} => String
|
|
1952
|
+
# * {Types::UpdateGroupResponse#group_arn #group_arn} => String
|
|
1953
|
+
# * {Types::UpdateGroupResponse#revision #revision} => String
|
|
1684
1954
|
#
|
|
1685
1955
|
# @example Request syntax with placeholder values
|
|
1686
1956
|
#
|
|
@@ -1693,8 +1963,16 @@ module Aws::IdentityStore
|
|
|
1693
1963
|
# attribute_value: "value", # value <Hash,Array,String,Numeric,Boolean,IO,Set,nil>
|
|
1694
1964
|
# },
|
|
1695
1965
|
# ],
|
|
1966
|
+
# revision: "ResourceRevision",
|
|
1696
1967
|
# })
|
|
1697
1968
|
#
|
|
1969
|
+
# @example Response structure
|
|
1970
|
+
#
|
|
1971
|
+
# resp.identity_store_id #=> String
|
|
1972
|
+
# resp.group_id #=> String
|
|
1973
|
+
# resp.group_arn #=> String
|
|
1974
|
+
# resp.revision #=> String
|
|
1975
|
+
#
|
|
1698
1976
|
# @see http://docs.aws.amazon.com/goto/WebAPI/identitystore-2020-06-15/UpdateGroup AWS API Documentation
|
|
1699
1977
|
#
|
|
1700
1978
|
# @overload update_group(params = {})
|
|
@@ -1704,15 +1982,77 @@ module Aws::IdentityStore
|
|
|
1704
1982
|
req.send_request(options)
|
|
1705
1983
|
end
|
|
1706
1984
|
|
|
1985
|
+
# Updates the configuration of the specified identity store, including
|
|
1986
|
+
# its network configuration.
|
|
1987
|
+
#
|
|
1988
|
+
# @option params [required, String] :identity_store_id
|
|
1989
|
+
# The globally unique identifier for the identity store.
|
|
1990
|
+
#
|
|
1991
|
+
# You can specify the identity store by ID or by Amazon Resource Name
|
|
1992
|
+
# (ARN). For example, identity store ID `d-1234567890` or identity store
|
|
1993
|
+
# ARN `arn:aws:identitystore::111122223333:identitystore/d-1234567890`.
|
|
1994
|
+
#
|
|
1995
|
+
# @option params [Types::NetworkConfiguration] :network_configuration
|
|
1996
|
+
# The network configuration to apply to the identity store. This
|
|
1997
|
+
# controls whether access through a virtual private cloud (VPC) endpoint
|
|
1998
|
+
# is required and the source VPCs and IP addresses that are allowed to
|
|
1999
|
+
# access the identity store.
|
|
2000
|
+
#
|
|
2001
|
+
# When you provide `NetworkConfiguration` in a request, the service
|
|
2002
|
+
# performs a full replacement of the identity store's current network
|
|
2003
|
+
# configuration with the values you specify. Any values that you omit
|
|
2004
|
+
# are cleared. To preserve or change the allowed source VPCs or IP
|
|
2005
|
+
# address ranges, include the complete set of values that you want in
|
|
2006
|
+
# the request. To clear a list, omit it; an empty list is not accepted.
|
|
2007
|
+
#
|
|
2008
|
+
# @return [Types::UpdateIdentityStoreResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
2009
|
+
#
|
|
2010
|
+
# * {Types::UpdateIdentityStoreResponse#identity_store_id #identity_store_id} => String
|
|
2011
|
+
# * {Types::UpdateIdentityStoreResponse#identity_store_arn #identity_store_arn} => String
|
|
2012
|
+
#
|
|
2013
|
+
# @example Request syntax with placeholder values
|
|
2014
|
+
#
|
|
2015
|
+
# resp = client.update_identity_store({
|
|
2016
|
+
# identity_store_id: "IdentityStoreId", # required
|
|
2017
|
+
# network_configuration: {
|
|
2018
|
+
# vpce_access_required: false, # required
|
|
2019
|
+
# api_restrict_source_vpcs: ["VpcIdType"],
|
|
2020
|
+
# api_allow_source_ips: ["IpCidrType"],
|
|
2021
|
+
# scim_allow_source_ips: ["IpCidrType"],
|
|
2022
|
+
# },
|
|
2023
|
+
# })
|
|
2024
|
+
#
|
|
2025
|
+
# @example Response structure
|
|
2026
|
+
#
|
|
2027
|
+
# resp.identity_store_id #=> String
|
|
2028
|
+
# resp.identity_store_arn #=> String
|
|
2029
|
+
#
|
|
2030
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/identitystore-2020-06-15/UpdateIdentityStore AWS API Documentation
|
|
2031
|
+
#
|
|
2032
|
+
# @overload update_identity_store(params = {})
|
|
2033
|
+
# @param [Hash] params ({})
|
|
2034
|
+
def update_identity_store(params = {}, options = {})
|
|
2035
|
+
req = build_request(:update_identity_store, params)
|
|
2036
|
+
req.send_request(options)
|
|
2037
|
+
end
|
|
2038
|
+
|
|
1707
2039
|
# Updates the specified user metadata and attributes in the specified
|
|
1708
2040
|
# identity store.
|
|
1709
2041
|
#
|
|
1710
2042
|
# @option params [required, String] :identity_store_id
|
|
1711
2043
|
# The globally unique identifier for the identity store.
|
|
1712
2044
|
#
|
|
2045
|
+
# You can specify the identity store by ID or by Amazon Resource Name
|
|
2046
|
+
# (ARN). For example, identity store ID `d-1234567890` or identity store
|
|
2047
|
+
# ARN `arn:aws:identitystore::111122223333:identitystore/d-1234567890`.
|
|
2048
|
+
#
|
|
1713
2049
|
# @option params [required, String] :user_id
|
|
1714
2050
|
# The identifier for a user in the identity store.
|
|
1715
2051
|
#
|
|
2052
|
+
# You can specify the user by ID or by Amazon Resource Name (ARN). For
|
|
2053
|
+
# example, user ID `a1b2c3d4-5678-90ab-cdef-EXAMPLE11111` or user ARN
|
|
2054
|
+
# `arn:aws:identitystore:::user/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111`.
|
|
2055
|
+
#
|
|
1716
2056
|
# @option params [required, Array<Types::AttributeOperation>] :operations
|
|
1717
2057
|
# A list of `AttributeOperation` objects to apply to the requested user.
|
|
1718
2058
|
# These operations might add, replace, or remove an attribute. For more
|
|
@@ -1723,7 +2063,20 @@ module Aws::IdentityStore
|
|
|
1723
2063
|
#
|
|
1724
2064
|
# [1]: https://docs.aws.amazon.com/singlesignon/latest/IdentityStoreAPIReference/API_User.html
|
|
1725
2065
|
#
|
|
1726
|
-
# @
|
|
2066
|
+
# @option params [String] :revision
|
|
2067
|
+
# The expected current revision of the user. When you provide this
|
|
2068
|
+
# value, the update is applied only if it matches the current revision
|
|
2069
|
+
# of the user in the identity store, which prevents you from overwriting
|
|
2070
|
+
# concurrent changes. If the value doesn't match, the operation fails
|
|
2071
|
+
# with a `ConflictException`. If you don't provide this value, the
|
|
2072
|
+
# update is applied unconditionally.
|
|
2073
|
+
#
|
|
2074
|
+
# @return [Types::UpdateUserResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
2075
|
+
#
|
|
2076
|
+
# * {Types::UpdateUserResponse#identity_store_id #identity_store_id} => String
|
|
2077
|
+
# * {Types::UpdateUserResponse#user_id #user_id} => String
|
|
2078
|
+
# * {Types::UpdateUserResponse#user_arn #user_arn} => String
|
|
2079
|
+
# * {Types::UpdateUserResponse#revision #revision} => String
|
|
1727
2080
|
#
|
|
1728
2081
|
# @example Request syntax with placeholder values
|
|
1729
2082
|
#
|
|
@@ -1736,8 +2089,16 @@ module Aws::IdentityStore
|
|
|
1736
2089
|
# attribute_value: "value", # value <Hash,Array,String,Numeric,Boolean,IO,Set,nil>
|
|
1737
2090
|
# },
|
|
1738
2091
|
# ],
|
|
2092
|
+
# revision: "ResourceRevision",
|
|
1739
2093
|
# })
|
|
1740
2094
|
#
|
|
2095
|
+
# @example Response structure
|
|
2096
|
+
#
|
|
2097
|
+
# resp.identity_store_id #=> String
|
|
2098
|
+
# resp.user_id #=> String
|
|
2099
|
+
# resp.user_arn #=> String
|
|
2100
|
+
# resp.revision #=> String
|
|
2101
|
+
#
|
|
1741
2102
|
# @see http://docs.aws.amazon.com/goto/WebAPI/identitystore-2020-06-15/UpdateUser AWS API Documentation
|
|
1742
2103
|
#
|
|
1743
2104
|
# @overload update_user(params = {})
|
|
@@ -1765,7 +2126,7 @@ module Aws::IdentityStore
|
|
|
1765
2126
|
tracer: tracer
|
|
1766
2127
|
)
|
|
1767
2128
|
context[:gem_name] = 'aws-sdk-identitystore'
|
|
1768
|
-
context[:gem_version] = '1.
|
|
2129
|
+
context[:gem_version] = '1.76.0'
|
|
1769
2130
|
Seahorse::Client::Request.new(handlers, context)
|
|
1770
2131
|
end
|
|
1771
2132
|
|