aws-sdk-identitystore 1.59.0 → 1.60.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-identitystore/client.rb +189 -82
- data/lib/aws-sdk-identitystore/client_api.rb +68 -10
- data/lib/aws-sdk-identitystore/errors.rb +20 -0
- data/lib/aws-sdk-identitystore/types.rb +350 -78
- data/lib/aws-sdk-identitystore.rb +1 -1
- data/sig/client.rbs +31 -5
- data/sig/errors.rbs +4 -0
- data/sig/types.rbs +56 -9
- metadata +3 -3
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 19d32eabe615b4269f26d8ac54a14c670ee4d4b6595454eb700a8256df742966
|
|
4
|
+
data.tar.gz: 0ca1094d715a3f1378bd391fc8b41cb0834b8cab347774bf5cae4e4e8c91b5f0
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 67edfb2400ef97c3bcb876b8d5e2f5dee87e207a0492cf618f911e6b93c2292ced7dfcfe0271d8c87d52a154479f960b44ba7012abb2580090d5b3af549cb2fe
|
|
7
|
+
data.tar.gz: f2f408a39e73cb451e0e48a68be6f4d56aabd68593766fc3355806e295ac26837cff86246bf8c42652582b0024be947000df7f71d6ef8cf180d84bfe7c29dca4
|
data/CHANGELOG.md
CHANGED
|
@@ -1,6 +1,11 @@
|
|
|
1
1
|
Unreleased Changes
|
|
2
2
|
------------------
|
|
3
3
|
|
|
4
|
+
1.60.0 (2025-11-06)
|
|
5
|
+
------------------
|
|
6
|
+
|
|
7
|
+
* Feature - IdentityStore API: added new KMSExceptionReason fields to the Exception object; added multiple new fields to the User APIs - UserStatus, Birthdate, Website and Photos; added multiple new metadata fields for User, Groups and Membership APIs - CreatedAt, CreatedBy, UpdatedAt and UpdatedBy.
|
|
8
|
+
|
|
4
9
|
1.59.0 (2025-10-21)
|
|
5
10
|
------------------
|
|
6
11
|
|
data/VERSION
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
1.
|
|
1
|
+
1.60.0
|
|
@@ -582,12 +582,13 @@ module Aws::IdentityStore
|
|
|
582
582
|
# reserved names and can't be used for users or groups.
|
|
583
583
|
#
|
|
584
584
|
# @option params [Types::Name] :name
|
|
585
|
-
# An object containing the name of the user.
|
|
585
|
+
# An object containing the name of the user. When used in IAM Identity
|
|
586
|
+
# Center, this parameter is required.
|
|
586
587
|
#
|
|
587
588
|
# @option params [String] :display_name
|
|
588
589
|
# A string containing the name of the user. This value is typically
|
|
589
590
|
# formatted for display when the user is referenced. For example, "John
|
|
590
|
-
# Doe."
|
|
591
|
+
# Doe." When used in IAM Identity Center, this parameter is required.
|
|
591
592
|
#
|
|
592
593
|
# @option params [String] :nick_name
|
|
593
594
|
# A string containing an alternate name for the user.
|
|
@@ -625,10 +626,23 @@ module Aws::IdentityStore
|
|
|
625
626
|
# @option params [String] :timezone
|
|
626
627
|
# A string containing the time zone of the user.
|
|
627
628
|
#
|
|
629
|
+
# @option params [Array<Types::Photo>] :photos
|
|
630
|
+
# A list of photos associated with the user. You can add up to 3 photos
|
|
631
|
+
# per user. Each photo can include a value, type, display name, and
|
|
632
|
+
# primary designation.
|
|
633
|
+
#
|
|
634
|
+
# @option params [String] :website
|
|
635
|
+
# The user's personal website or blog URL. This field allows users to
|
|
636
|
+
# provide a link to their personal or professional website.
|
|
637
|
+
#
|
|
638
|
+
# @option params [String] :birthdate
|
|
639
|
+
# The user's birthdate in YYYY-MM-DD format. This field supports
|
|
640
|
+
# standard date format for storing personal information.
|
|
641
|
+
#
|
|
628
642
|
# @return [Types::CreateUserResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
629
643
|
#
|
|
630
|
-
# * {Types::CreateUserResponse#user_id #user_id} => String
|
|
631
644
|
# * {Types::CreateUserResponse#identity_store_id #identity_store_id} => String
|
|
645
|
+
# * {Types::CreateUserResponse#user_id #user_id} => String
|
|
632
646
|
#
|
|
633
647
|
# @example Request syntax with placeholder values
|
|
634
648
|
#
|
|
@@ -677,12 +691,22 @@ module Aws::IdentityStore
|
|
|
677
691
|
# preferred_language: "SensitiveStringType",
|
|
678
692
|
# locale: "SensitiveStringType",
|
|
679
693
|
# timezone: "SensitiveStringType",
|
|
694
|
+
# photos: [
|
|
695
|
+
# {
|
|
696
|
+
# value: "SensitiveStringType", # required
|
|
697
|
+
# type: "SensitiveStringType",
|
|
698
|
+
# display: "SensitiveStringType",
|
|
699
|
+
# primary: false,
|
|
700
|
+
# },
|
|
701
|
+
# ],
|
|
702
|
+
# website: "SensitiveStringType",
|
|
703
|
+
# birthdate: "SensitiveStringType",
|
|
680
704
|
# })
|
|
681
705
|
#
|
|
682
706
|
# @example Response structure
|
|
683
707
|
#
|
|
684
|
-
# resp.user_id #=> String
|
|
685
708
|
# resp.identity_store_id #=> String
|
|
709
|
+
# resp.user_id #=> String
|
|
686
710
|
#
|
|
687
711
|
# @see http://docs.aws.amazon.com/goto/WebAPI/identitystore-2020-06-15/CreateUser AWS API Documentation
|
|
688
712
|
#
|
|
@@ -774,15 +798,16 @@ module Aws::IdentityStore
|
|
|
774
798
|
# Retrieves the group metadata and attributes from `GroupId` in an
|
|
775
799
|
# identity store.
|
|
776
800
|
#
|
|
777
|
-
# <note markdown="1"> If you have
|
|
778
|
-
#
|
|
779
|
-
#
|
|
801
|
+
# <note markdown="1"> If you have access to a member account, you can use this API operation
|
|
802
|
+
# from the member account. For more information, see [Limiting access to
|
|
803
|
+
# the identity store from member accounts][1] in the <i> IAM Identity
|
|
804
|
+
# Center User Guide</i>.
|
|
780
805
|
#
|
|
781
806
|
# </note>
|
|
782
807
|
#
|
|
783
808
|
#
|
|
784
809
|
#
|
|
785
|
-
# [1]: https://docs.aws.amazon.com/
|
|
810
|
+
# [1]: https://docs.aws.amazon.com/singlesignon/latest/userguide/manage-your-accounts.html#limiting-access-from-member-accounts
|
|
786
811
|
#
|
|
787
812
|
# @option params [required, String] :identity_store_id
|
|
788
813
|
# The globally unique identifier for the identity store, such as
|
|
@@ -800,6 +825,10 @@ module Aws::IdentityStore
|
|
|
800
825
|
# * {Types::DescribeGroupResponse#display_name #display_name} => String
|
|
801
826
|
# * {Types::DescribeGroupResponse#external_ids #external_ids} => Array<Types::ExternalId>
|
|
802
827
|
# * {Types::DescribeGroupResponse#description #description} => String
|
|
828
|
+
# * {Types::DescribeGroupResponse#created_at #created_at} => Time
|
|
829
|
+
# * {Types::DescribeGroupResponse#updated_at #updated_at} => Time
|
|
830
|
+
# * {Types::DescribeGroupResponse#created_by #created_by} => String
|
|
831
|
+
# * {Types::DescribeGroupResponse#updated_by #updated_by} => String
|
|
803
832
|
# * {Types::DescribeGroupResponse#identity_store_id #identity_store_id} => String
|
|
804
833
|
#
|
|
805
834
|
# @example Request syntax with placeholder values
|
|
@@ -817,6 +846,10 @@ module Aws::IdentityStore
|
|
|
817
846
|
# resp.external_ids[0].issuer #=> String
|
|
818
847
|
# resp.external_ids[0].id #=> String
|
|
819
848
|
# resp.description #=> String
|
|
849
|
+
# resp.created_at #=> Time
|
|
850
|
+
# resp.updated_at #=> Time
|
|
851
|
+
# resp.created_by #=> String
|
|
852
|
+
# resp.updated_by #=> String
|
|
820
853
|
# resp.identity_store_id #=> String
|
|
821
854
|
#
|
|
822
855
|
# @see http://docs.aws.amazon.com/goto/WebAPI/identitystore-2020-06-15/DescribeGroup AWS API Documentation
|
|
@@ -831,15 +864,16 @@ module Aws::IdentityStore
|
|
|
831
864
|
# Retrieves membership metadata and attributes from `MembershipId` in an
|
|
832
865
|
# identity store.
|
|
833
866
|
#
|
|
834
|
-
# <note markdown="1"> If you have
|
|
835
|
-
#
|
|
836
|
-
#
|
|
867
|
+
# <note markdown="1"> If you have access to a member account, you can use this API operation
|
|
868
|
+
# from the member account. For more information, see [Limiting access to
|
|
869
|
+
# the identity store from member accounts][1] in the <i> IAM Identity
|
|
870
|
+
# Center User Guide</i>.
|
|
837
871
|
#
|
|
838
872
|
# </note>
|
|
839
873
|
#
|
|
840
874
|
#
|
|
841
875
|
#
|
|
842
|
-
# [1]: https://docs.aws.amazon.com/
|
|
876
|
+
# [1]: https://docs.aws.amazon.com/singlesignon/latest/userguide/manage-your-accounts.html#limiting-access-from-member-accounts
|
|
843
877
|
#
|
|
844
878
|
# @option params [required, String] :identity_store_id
|
|
845
879
|
# The globally unique identifier for the identity store.
|
|
@@ -853,6 +887,10 @@ module Aws::IdentityStore
|
|
|
853
887
|
# * {Types::DescribeGroupMembershipResponse#membership_id #membership_id} => String
|
|
854
888
|
# * {Types::DescribeGroupMembershipResponse#group_id #group_id} => String
|
|
855
889
|
# * {Types::DescribeGroupMembershipResponse#member_id #member_id} => Types::MemberId
|
|
890
|
+
# * {Types::DescribeGroupMembershipResponse#created_at #created_at} => Time
|
|
891
|
+
# * {Types::DescribeGroupMembershipResponse#updated_at #updated_at} => Time
|
|
892
|
+
# * {Types::DescribeGroupMembershipResponse#created_by #created_by} => String
|
|
893
|
+
# * {Types::DescribeGroupMembershipResponse#updated_by #updated_by} => String
|
|
856
894
|
#
|
|
857
895
|
# @example Request syntax with placeholder values
|
|
858
896
|
#
|
|
@@ -867,6 +905,10 @@ module Aws::IdentityStore
|
|
|
867
905
|
# resp.membership_id #=> String
|
|
868
906
|
# resp.group_id #=> String
|
|
869
907
|
# resp.member_id.user_id #=> String
|
|
908
|
+
# resp.created_at #=> Time
|
|
909
|
+
# resp.updated_at #=> Time
|
|
910
|
+
# resp.created_by #=> String
|
|
911
|
+
# resp.updated_by #=> String
|
|
870
912
|
#
|
|
871
913
|
# @see http://docs.aws.amazon.com/goto/WebAPI/identitystore-2020-06-15/DescribeGroupMembership AWS API Documentation
|
|
872
914
|
#
|
|
@@ -880,15 +922,16 @@ module Aws::IdentityStore
|
|
|
880
922
|
# Retrieves the user metadata and attributes from the `UserId` in an
|
|
881
923
|
# identity store.
|
|
882
924
|
#
|
|
883
|
-
# <note markdown="1"> If you have
|
|
884
|
-
#
|
|
885
|
-
#
|
|
925
|
+
# <note markdown="1"> If you have access to a member account, you can use this API operation
|
|
926
|
+
# from the member account. For more information, see [Limiting access to
|
|
927
|
+
# the identity store from member accounts][1] in the <i> IAM Identity
|
|
928
|
+
# Center User Guide</i>.
|
|
886
929
|
#
|
|
887
930
|
# </note>
|
|
888
931
|
#
|
|
889
932
|
#
|
|
890
933
|
#
|
|
891
|
-
# [1]: https://docs.aws.amazon.com/
|
|
934
|
+
# [1]: https://docs.aws.amazon.com/singlesignon/latest/userguide/manage-your-accounts.html#limiting-access-from-member-accounts
|
|
892
935
|
#
|
|
893
936
|
# @option params [required, String] :identity_store_id
|
|
894
937
|
# The globally unique identifier for the identity store, such as
|
|
@@ -902,8 +945,9 @@ module Aws::IdentityStore
|
|
|
902
945
|
#
|
|
903
946
|
# @return [Types::DescribeUserResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
904
947
|
#
|
|
905
|
-
# * {Types::DescribeUserResponse#
|
|
948
|
+
# * {Types::DescribeUserResponse#identity_store_id #identity_store_id} => String
|
|
906
949
|
# * {Types::DescribeUserResponse#user_id #user_id} => String
|
|
950
|
+
# * {Types::DescribeUserResponse#user_name #user_name} => String
|
|
907
951
|
# * {Types::DescribeUserResponse#external_ids #external_ids} => Array<Types::ExternalId>
|
|
908
952
|
# * {Types::DescribeUserResponse#name #name} => Types::Name
|
|
909
953
|
# * {Types::DescribeUserResponse#display_name #display_name} => String
|
|
@@ -917,7 +961,14 @@ module Aws::IdentityStore
|
|
|
917
961
|
# * {Types::DescribeUserResponse#preferred_language #preferred_language} => String
|
|
918
962
|
# * {Types::DescribeUserResponse#locale #locale} => String
|
|
919
963
|
# * {Types::DescribeUserResponse#timezone #timezone} => String
|
|
920
|
-
# * {Types::DescribeUserResponse#
|
|
964
|
+
# * {Types::DescribeUserResponse#user_status #user_status} => String
|
|
965
|
+
# * {Types::DescribeUserResponse#photos #photos} => Array<Types::Photo>
|
|
966
|
+
# * {Types::DescribeUserResponse#website #website} => String
|
|
967
|
+
# * {Types::DescribeUserResponse#birthdate #birthdate} => String
|
|
968
|
+
# * {Types::DescribeUserResponse#created_at #created_at} => Time
|
|
969
|
+
# * {Types::DescribeUserResponse#created_by #created_by} => String
|
|
970
|
+
# * {Types::DescribeUserResponse#updated_at #updated_at} => Time
|
|
971
|
+
# * {Types::DescribeUserResponse#updated_by #updated_by} => String
|
|
921
972
|
#
|
|
922
973
|
# @example Request syntax with placeholder values
|
|
923
974
|
#
|
|
@@ -928,8 +979,9 @@ module Aws::IdentityStore
|
|
|
928
979
|
#
|
|
929
980
|
# @example Response structure
|
|
930
981
|
#
|
|
931
|
-
# resp.
|
|
982
|
+
# resp.identity_store_id #=> String
|
|
932
983
|
# resp.user_id #=> String
|
|
984
|
+
# resp.user_name #=> String
|
|
933
985
|
# resp.external_ids #=> Array
|
|
934
986
|
# resp.external_ids[0].issuer #=> String
|
|
935
987
|
# resp.external_ids[0].id #=> String
|
|
@@ -964,7 +1016,18 @@ module Aws::IdentityStore
|
|
|
964
1016
|
# resp.preferred_language #=> String
|
|
965
1017
|
# resp.locale #=> String
|
|
966
1018
|
# resp.timezone #=> String
|
|
967
|
-
# resp.
|
|
1019
|
+
# resp.user_status #=> String, one of "ENABLED", "DISABLED"
|
|
1020
|
+
# resp.photos #=> Array
|
|
1021
|
+
# resp.photos[0].value #=> String
|
|
1022
|
+
# resp.photos[0].type #=> String
|
|
1023
|
+
# resp.photos[0].display #=> String
|
|
1024
|
+
# resp.photos[0].primary #=> Boolean
|
|
1025
|
+
# resp.website #=> String
|
|
1026
|
+
# resp.birthdate #=> String
|
|
1027
|
+
# resp.created_at #=> Time
|
|
1028
|
+
# resp.created_by #=> String
|
|
1029
|
+
# resp.updated_at #=> Time
|
|
1030
|
+
# resp.updated_by #=> String
|
|
968
1031
|
#
|
|
969
1032
|
# @see http://docs.aws.amazon.com/goto/WebAPI/identitystore-2020-06-15/DescribeUser AWS API Documentation
|
|
970
1033
|
#
|
|
@@ -977,15 +1040,16 @@ module Aws::IdentityStore
|
|
|
977
1040
|
|
|
978
1041
|
# Retrieves `GroupId` in an identity store.
|
|
979
1042
|
#
|
|
980
|
-
# <note markdown="1"> If you have
|
|
981
|
-
#
|
|
982
|
-
#
|
|
1043
|
+
# <note markdown="1"> If you have access to a member account, you can use this API operation
|
|
1044
|
+
# from the member account. For more information, see [Limiting access to
|
|
1045
|
+
# the identity store from member accounts][1] in the <i> IAM Identity
|
|
1046
|
+
# Center User Guide</i>.
|
|
983
1047
|
#
|
|
984
1048
|
# </note>
|
|
985
1049
|
#
|
|
986
1050
|
#
|
|
987
1051
|
#
|
|
988
|
-
# [1]: https://docs.aws.amazon.com/
|
|
1052
|
+
# [1]: https://docs.aws.amazon.com/singlesignon/latest/userguide/manage-your-accounts.html#limiting-access-from-member-accounts
|
|
989
1053
|
#
|
|
990
1054
|
# @option params [required, String] :identity_store_id
|
|
991
1055
|
# The globally unique identifier for the identity store.
|
|
@@ -994,8 +1058,8 @@ module Aws::IdentityStore
|
|
|
994
1058
|
# A unique identifier for a user or group that is not the primary
|
|
995
1059
|
# identifier. This value can be an identifier from an external identity
|
|
996
1060
|
# provider (IdP) that is associated with the user, the group, or a
|
|
997
|
-
# unique attribute. For the unique attribute, the only valid path is
|
|
998
|
-
#
|
|
1061
|
+
# unique attribute. For the unique attribute, the only valid path is `
|
|
1062
|
+
# displayName`.
|
|
999
1063
|
#
|
|
1000
1064
|
# @return [Types::GetGroupIdResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
1001
1065
|
#
|
|
@@ -1034,15 +1098,16 @@ module Aws::IdentityStore
|
|
|
1034
1098
|
|
|
1035
1099
|
# Retrieves the `MembershipId` in an identity store.
|
|
1036
1100
|
#
|
|
1037
|
-
# <note markdown="1"> If you have
|
|
1038
|
-
#
|
|
1039
|
-
#
|
|
1101
|
+
# <note markdown="1"> If you have access to a member account, you can use this API operation
|
|
1102
|
+
# from the member account. For more information, see [Limiting access to
|
|
1103
|
+
# the identity store from member accounts][1] in the <i> IAM Identity
|
|
1104
|
+
# Center User Guide</i>.
|
|
1040
1105
|
#
|
|
1041
1106
|
# </note>
|
|
1042
1107
|
#
|
|
1043
1108
|
#
|
|
1044
1109
|
#
|
|
1045
|
-
# [1]: https://docs.aws.amazon.com/
|
|
1110
|
+
# [1]: https://docs.aws.amazon.com/singlesignon/latest/userguide/manage-your-accounts.html#limiting-access-from-member-accounts
|
|
1046
1111
|
#
|
|
1047
1112
|
# @option params [required, String] :identity_store_id
|
|
1048
1113
|
# The globally unique identifier for the identity store.
|
|
@@ -1086,15 +1151,16 @@ module Aws::IdentityStore
|
|
|
1086
1151
|
|
|
1087
1152
|
# Retrieves the `UserId` in an identity store.
|
|
1088
1153
|
#
|
|
1089
|
-
# <note markdown="1"> If you have
|
|
1090
|
-
#
|
|
1091
|
-
#
|
|
1154
|
+
# <note markdown="1"> If you have access to a member account, you can use this API operation
|
|
1155
|
+
# from the member account. For more information, see [Limiting access to
|
|
1156
|
+
# the identity store from member accounts][1] in the <i> IAM Identity
|
|
1157
|
+
# Center User Guide</i>.
|
|
1092
1158
|
#
|
|
1093
1159
|
# </note>
|
|
1094
1160
|
#
|
|
1095
1161
|
#
|
|
1096
1162
|
#
|
|
1097
|
-
# [1]: https://docs.aws.amazon.com/
|
|
1163
|
+
# [1]: https://docs.aws.amazon.com/singlesignon/latest/userguide/manage-your-accounts.html#limiting-access-from-member-accounts
|
|
1098
1164
|
#
|
|
1099
1165
|
# @option params [required, String] :identity_store_id
|
|
1100
1166
|
# The globally unique identifier for the identity store.
|
|
@@ -1103,13 +1169,13 @@ module Aws::IdentityStore
|
|
|
1103
1169
|
# A unique identifier for a user or group that is not the primary
|
|
1104
1170
|
# identifier. This value can be an identifier from an external identity
|
|
1105
1171
|
# provider (IdP) that is associated with the user, the group, or a
|
|
1106
|
-
# unique attribute. For the unique attribute, the only valid paths are
|
|
1107
|
-
#
|
|
1172
|
+
# unique attribute. For the unique attribute, the only valid paths are `
|
|
1173
|
+
# userName` and `emails.value`.
|
|
1108
1174
|
#
|
|
1109
1175
|
# @return [Types::GetUserIdResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
1110
1176
|
#
|
|
1111
|
-
# * {Types::GetUserIdResponse#user_id #user_id} => String
|
|
1112
1177
|
# * {Types::GetUserIdResponse#identity_store_id #identity_store_id} => String
|
|
1178
|
+
# * {Types::GetUserIdResponse#user_id #user_id} => String
|
|
1113
1179
|
#
|
|
1114
1180
|
# @example Request syntax with placeholder values
|
|
1115
1181
|
#
|
|
@@ -1129,8 +1195,8 @@ module Aws::IdentityStore
|
|
|
1129
1195
|
#
|
|
1130
1196
|
# @example Response structure
|
|
1131
1197
|
#
|
|
1132
|
-
# resp.user_id #=> String
|
|
1133
1198
|
# resp.identity_store_id #=> String
|
|
1199
|
+
# resp.user_id #=> String
|
|
1134
1200
|
#
|
|
1135
1201
|
# @see http://docs.aws.amazon.com/goto/WebAPI/identitystore-2020-06-15/GetUserId AWS API Documentation
|
|
1136
1202
|
#
|
|
@@ -1144,15 +1210,16 @@ module Aws::IdentityStore
|
|
|
1144
1210
|
# Checks the user's membership in all requested groups and returns if
|
|
1145
1211
|
# the member exists in all queried groups.
|
|
1146
1212
|
#
|
|
1147
|
-
# <note markdown="1"> If you have
|
|
1148
|
-
#
|
|
1149
|
-
#
|
|
1213
|
+
# <note markdown="1"> If you have access to a member account, you can use this API operation
|
|
1214
|
+
# from the member account. For more information, see [Limiting access to
|
|
1215
|
+
# the identity store from member accounts][1] in the <i> IAM Identity
|
|
1216
|
+
# Center User Guide</i>.
|
|
1150
1217
|
#
|
|
1151
1218
|
# </note>
|
|
1152
1219
|
#
|
|
1153
1220
|
#
|
|
1154
1221
|
#
|
|
1155
|
-
# [1]: https://docs.aws.amazon.com/
|
|
1222
|
+
# [1]: https://docs.aws.amazon.com/singlesignon/latest/userguide/manage-your-accounts.html#limiting-access-from-member-accounts
|
|
1156
1223
|
#
|
|
1157
1224
|
# @option params [required, String] :identity_store_id
|
|
1158
1225
|
# The globally unique identifier for the identity store.
|
|
@@ -1194,18 +1261,19 @@ module Aws::IdentityStore
|
|
|
1194
1261
|
end
|
|
1195
1262
|
|
|
1196
1263
|
# For the specified group in the specified identity store, returns the
|
|
1197
|
-
# list of all `GroupMembership` objects and returns results in
|
|
1198
|
-
# form.
|
|
1264
|
+
# list of all ` GroupMembership` objects and returns results in
|
|
1265
|
+
# paginated form.
|
|
1199
1266
|
#
|
|
1200
|
-
# <note markdown="1"> If you have
|
|
1201
|
-
#
|
|
1202
|
-
#
|
|
1267
|
+
# <note markdown="1"> If you have access to a member account, you can use this API operation
|
|
1268
|
+
# from the member account. For more information, see [Limiting access to
|
|
1269
|
+
# the identity store from member accounts][1] in the <i> IAM Identity
|
|
1270
|
+
# Center User Guide</i>.
|
|
1203
1271
|
#
|
|
1204
1272
|
# </note>
|
|
1205
1273
|
#
|
|
1206
1274
|
#
|
|
1207
1275
|
#
|
|
1208
|
-
# [1]: https://docs.aws.amazon.com/
|
|
1276
|
+
# [1]: https://docs.aws.amazon.com/singlesignon/latest/userguide/manage-your-accounts.html#limiting-access-from-member-accounts
|
|
1209
1277
|
#
|
|
1210
1278
|
# @option params [required, String] :identity_store_id
|
|
1211
1279
|
# The globally unique identifier for the identity store.
|
|
@@ -1215,12 +1283,12 @@ module Aws::IdentityStore
|
|
|
1215
1283
|
#
|
|
1216
1284
|
# @option params [Integer] :max_results
|
|
1217
1285
|
# The maximum number of results to be returned per request. This
|
|
1218
|
-
# parameter is used in all `List` requests to specify how many results
|
|
1286
|
+
# parameter is used in all ` List` requests to specify how many results
|
|
1219
1287
|
# to return in one page.
|
|
1220
1288
|
#
|
|
1221
1289
|
# @option params [String] :next_token
|
|
1222
|
-
# The pagination token used for the `ListUsers`, `ListGroups` and
|
|
1223
|
-
#
|
|
1290
|
+
# The pagination token used for the `ListUsers`, `ListGroups` and `
|
|
1291
|
+
# ListGroupMemberships` API operations. This value is generated by the
|
|
1224
1292
|
# identity store service. It is returned in the API response if the
|
|
1225
1293
|
# total results are more than the size of one page. This token is also
|
|
1226
1294
|
# returned when it is used in the API request to search for the next
|
|
@@ -1249,6 +1317,10 @@ module Aws::IdentityStore
|
|
|
1249
1317
|
# resp.group_memberships[0].membership_id #=> String
|
|
1250
1318
|
# resp.group_memberships[0].group_id #=> String
|
|
1251
1319
|
# resp.group_memberships[0].member_id.user_id #=> String
|
|
1320
|
+
# resp.group_memberships[0].created_at #=> Time
|
|
1321
|
+
# resp.group_memberships[0].updated_at #=> Time
|
|
1322
|
+
# resp.group_memberships[0].created_by #=> String
|
|
1323
|
+
# resp.group_memberships[0].updated_by #=> String
|
|
1252
1324
|
# resp.next_token #=> String
|
|
1253
1325
|
#
|
|
1254
1326
|
# @see http://docs.aws.amazon.com/goto/WebAPI/identitystore-2020-06-15/ListGroupMemberships AWS API Documentation
|
|
@@ -1261,18 +1333,19 @@ module Aws::IdentityStore
|
|
|
1261
1333
|
end
|
|
1262
1334
|
|
|
1263
1335
|
# For the specified member in the specified identity store, returns the
|
|
1264
|
-
# list of all `GroupMembership` objects and returns results in
|
|
1265
|
-
# form.
|
|
1336
|
+
# list of all ` GroupMembership` objects and returns results in
|
|
1337
|
+
# paginated form.
|
|
1266
1338
|
#
|
|
1267
|
-
# <note markdown="1"> If you have
|
|
1268
|
-
#
|
|
1269
|
-
#
|
|
1339
|
+
# <note markdown="1"> If you have access to a member account, you can use this API operation
|
|
1340
|
+
# from the member account. For more information, see [Limiting access to
|
|
1341
|
+
# the identity store from member accounts][1] in the <i> IAM Identity
|
|
1342
|
+
# Center User Guide</i>.
|
|
1270
1343
|
#
|
|
1271
1344
|
# </note>
|
|
1272
1345
|
#
|
|
1273
1346
|
#
|
|
1274
1347
|
#
|
|
1275
|
-
# [1]: https://docs.aws.amazon.com/
|
|
1348
|
+
# [1]: https://docs.aws.amazon.com/singlesignon/latest/userguide/manage-your-accounts.html#limiting-access-from-member-accounts
|
|
1276
1349
|
#
|
|
1277
1350
|
# @option params [required, String] :identity_store_id
|
|
1278
1351
|
# The globally unique identifier for the identity store.
|
|
@@ -1284,13 +1357,13 @@ module Aws::IdentityStore
|
|
|
1284
1357
|
#
|
|
1285
1358
|
# @option params [Integer] :max_results
|
|
1286
1359
|
# The maximum number of results to be returned per request. This
|
|
1287
|
-
# parameter is used in the `ListUsers` and `ListGroups` requests to
|
|
1360
|
+
# parameter is used in the ` ListUsers` and `ListGroups` requests to
|
|
1288
1361
|
# specify how many results to return in one page. The length limit is 50
|
|
1289
1362
|
# characters.
|
|
1290
1363
|
#
|
|
1291
1364
|
# @option params [String] :next_token
|
|
1292
|
-
# The pagination token used for the `ListUsers`, `ListGroups`, and
|
|
1293
|
-
#
|
|
1365
|
+
# The pagination token used for the `ListUsers`, `ListGroups`, and `
|
|
1366
|
+
# ListGroupMemberships` API operations. This value is generated by the
|
|
1294
1367
|
# identity store service. It is returned in the API response if the
|
|
1295
1368
|
# total results are more than the size of one page. This token is also
|
|
1296
1369
|
# returned when it is used in the API request to search for the next
|
|
@@ -1321,6 +1394,10 @@ module Aws::IdentityStore
|
|
|
1321
1394
|
# resp.group_memberships[0].membership_id #=> String
|
|
1322
1395
|
# resp.group_memberships[0].group_id #=> String
|
|
1323
1396
|
# resp.group_memberships[0].member_id.user_id #=> String
|
|
1397
|
+
# resp.group_memberships[0].created_at #=> Time
|
|
1398
|
+
# resp.group_memberships[0].updated_at #=> Time
|
|
1399
|
+
# resp.group_memberships[0].created_by #=> String
|
|
1400
|
+
# resp.group_memberships[0].updated_by #=> String
|
|
1324
1401
|
# resp.next_token #=> String
|
|
1325
1402
|
#
|
|
1326
1403
|
# @see http://docs.aws.amazon.com/goto/WebAPI/identitystore-2020-06-15/ListGroupMembershipsForMember AWS API Documentation
|
|
@@ -1336,15 +1413,16 @@ module Aws::IdentityStore
|
|
|
1336
1413
|
# complete `Group` objects. Filtering for a `Group` by the `DisplayName`
|
|
1337
1414
|
# attribute is deprecated. Instead, use the `GetGroupId` API action.
|
|
1338
1415
|
#
|
|
1339
|
-
# <note markdown="1"> If you have
|
|
1340
|
-
#
|
|
1341
|
-
#
|
|
1416
|
+
# <note markdown="1"> If you have access to a member account, you can use this API operation
|
|
1417
|
+
# from the member account. For more information, see [Limiting access to
|
|
1418
|
+
# the identity store from member accounts][1] in the <i> IAM Identity
|
|
1419
|
+
# Center User Guide</i>.
|
|
1342
1420
|
#
|
|
1343
1421
|
# </note>
|
|
1344
1422
|
#
|
|
1345
1423
|
#
|
|
1346
1424
|
#
|
|
1347
|
-
# [1]: https://docs.aws.amazon.com/
|
|
1425
|
+
# [1]: https://docs.aws.amazon.com/singlesignon/latest/userguide/manage-your-accounts.html#limiting-access-from-member-accounts
|
|
1348
1426
|
#
|
|
1349
1427
|
# @option params [required, String] :identity_store_id
|
|
1350
1428
|
# The globally unique identifier for the identity store, such as
|
|
@@ -1355,7 +1433,7 @@ module Aws::IdentityStore
|
|
|
1355
1433
|
#
|
|
1356
1434
|
# @option params [Integer] :max_results
|
|
1357
1435
|
# The maximum number of results to be returned per request. This
|
|
1358
|
-
# parameter is used in the `ListUsers` and `ListGroups` requests to
|
|
1436
|
+
# parameter is used in the ` ListUsers` and `ListGroups` requests to
|
|
1359
1437
|
# specify how many results to return in one page. The length limit is 50
|
|
1360
1438
|
# characters.
|
|
1361
1439
|
#
|
|
@@ -1367,8 +1445,8 @@ module Aws::IdentityStore
|
|
|
1367
1445
|
# API request to search for the next page.
|
|
1368
1446
|
#
|
|
1369
1447
|
# @option params [Array<Types::Filter>] :filters
|
|
1370
|
-
# A list of `Filter` objects, which is used in the `ListUsers` and
|
|
1371
|
-
#
|
|
1448
|
+
# A list of `Filter` objects, which is used in the `ListUsers` and `
|
|
1449
|
+
# ListGroups` requests.
|
|
1372
1450
|
#
|
|
1373
1451
|
# @return [Types::ListGroupsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
1374
1452
|
#
|
|
@@ -1400,6 +1478,10 @@ module Aws::IdentityStore
|
|
|
1400
1478
|
# resp.groups[0].external_ids[0].issuer #=> String
|
|
1401
1479
|
# resp.groups[0].external_ids[0].id #=> String
|
|
1402
1480
|
# resp.groups[0].description #=> String
|
|
1481
|
+
# resp.groups[0].created_at #=> Time
|
|
1482
|
+
# resp.groups[0].updated_at #=> Time
|
|
1483
|
+
# resp.groups[0].created_by #=> String
|
|
1484
|
+
# resp.groups[0].updated_by #=> String
|
|
1403
1485
|
# resp.groups[0].identity_store_id #=> String
|
|
1404
1486
|
# resp.next_token #=> String
|
|
1405
1487
|
#
|
|
@@ -1416,15 +1498,16 @@ module Aws::IdentityStore
|
|
|
1416
1498
|
# complete `User` objects. Filtering for a `User` by the `UserName`
|
|
1417
1499
|
# attribute is deprecated. Instead, use the `GetUserId` API action.
|
|
1418
1500
|
#
|
|
1419
|
-
# <note markdown="1"> If you have
|
|
1420
|
-
#
|
|
1421
|
-
#
|
|
1501
|
+
# <note markdown="1"> If you have access to a member account, you can use this API operation
|
|
1502
|
+
# from the member account. For more information, see [Limiting access to
|
|
1503
|
+
# the identity store from member accounts][1] in the <i> IAM Identity
|
|
1504
|
+
# Center User Guide</i>.
|
|
1422
1505
|
#
|
|
1423
1506
|
# </note>
|
|
1424
1507
|
#
|
|
1425
1508
|
#
|
|
1426
1509
|
#
|
|
1427
|
-
# [1]: https://docs.aws.amazon.com/
|
|
1510
|
+
# [1]: https://docs.aws.amazon.com/singlesignon/latest/userguide/manage-your-accounts.html#limiting-access-from-member-accounts
|
|
1428
1511
|
#
|
|
1429
1512
|
# @option params [required, String] :identity_store_id
|
|
1430
1513
|
# The globally unique identifier for the identity store, such as
|
|
@@ -1435,7 +1518,7 @@ module Aws::IdentityStore
|
|
|
1435
1518
|
#
|
|
1436
1519
|
# @option params [Integer] :max_results
|
|
1437
1520
|
# The maximum number of results to be returned per request. This
|
|
1438
|
-
# parameter is used in the `ListUsers` and `ListGroups` requests to
|
|
1521
|
+
# parameter is used in the ` ListUsers` and `ListGroups` requests to
|
|
1439
1522
|
# specify how many results to return in one page. The length limit is 50
|
|
1440
1523
|
# characters.
|
|
1441
1524
|
#
|
|
@@ -1447,8 +1530,8 @@ module Aws::IdentityStore
|
|
|
1447
1530
|
# API request to search for the next page.
|
|
1448
1531
|
#
|
|
1449
1532
|
# @option params [Array<Types::Filter>] :filters
|
|
1450
|
-
# A list of `Filter` objects, which is used in the `ListUsers` and
|
|
1451
|
-
#
|
|
1533
|
+
# A list of `Filter` objects, which is used in the `ListUsers` and `
|
|
1534
|
+
# ListGroups` requests.
|
|
1452
1535
|
#
|
|
1453
1536
|
# @return [Types::ListUsersResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
1454
1537
|
#
|
|
@@ -1474,8 +1557,9 @@ module Aws::IdentityStore
|
|
|
1474
1557
|
# @example Response structure
|
|
1475
1558
|
#
|
|
1476
1559
|
# resp.users #=> Array
|
|
1477
|
-
# resp.users[0].
|
|
1560
|
+
# resp.users[0].identity_store_id #=> String
|
|
1478
1561
|
# resp.users[0].user_id #=> String
|
|
1562
|
+
# resp.users[0].user_name #=> String
|
|
1479
1563
|
# resp.users[0].external_ids #=> Array
|
|
1480
1564
|
# resp.users[0].external_ids[0].issuer #=> String
|
|
1481
1565
|
# resp.users[0].external_ids[0].id #=> String
|
|
@@ -1510,7 +1594,18 @@ module Aws::IdentityStore
|
|
|
1510
1594
|
# resp.users[0].preferred_language #=> String
|
|
1511
1595
|
# resp.users[0].locale #=> String
|
|
1512
1596
|
# resp.users[0].timezone #=> String
|
|
1513
|
-
# resp.users[0].
|
|
1597
|
+
# resp.users[0].user_status #=> String, one of "ENABLED", "DISABLED"
|
|
1598
|
+
# resp.users[0].photos #=> Array
|
|
1599
|
+
# resp.users[0].photos[0].value #=> String
|
|
1600
|
+
# resp.users[0].photos[0].type #=> String
|
|
1601
|
+
# resp.users[0].photos[0].display #=> String
|
|
1602
|
+
# resp.users[0].photos[0].primary #=> Boolean
|
|
1603
|
+
# resp.users[0].website #=> String
|
|
1604
|
+
# resp.users[0].birthdate #=> String
|
|
1605
|
+
# resp.users[0].created_at #=> Time
|
|
1606
|
+
# resp.users[0].created_by #=> String
|
|
1607
|
+
# resp.users[0].updated_at #=> Time
|
|
1608
|
+
# resp.users[0].updated_by #=> String
|
|
1514
1609
|
# resp.next_token #=> String
|
|
1515
1610
|
#
|
|
1516
1611
|
# @see http://docs.aws.amazon.com/goto/WebAPI/identitystore-2020-06-15/ListUsers AWS API Documentation
|
|
@@ -1522,8 +1617,8 @@ module Aws::IdentityStore
|
|
|
1522
1617
|
req.send_request(options)
|
|
1523
1618
|
end
|
|
1524
1619
|
|
|
1525
|
-
#
|
|
1526
|
-
#
|
|
1620
|
+
# Updates the specified group metadata and attributes in the specified
|
|
1621
|
+
# identity store.
|
|
1527
1622
|
#
|
|
1528
1623
|
# @option params [required, String] :identity_store_id
|
|
1529
1624
|
# The globally unique identifier for the identity store.
|
|
@@ -1534,6 +1629,12 @@ module Aws::IdentityStore
|
|
|
1534
1629
|
# @option params [required, Array<Types::AttributeOperation>] :operations
|
|
1535
1630
|
# A list of `AttributeOperation` objects to apply to the requested
|
|
1536
1631
|
# group. These operations might add, replace, or remove an attribute.
|
|
1632
|
+
# For more information on the attributes that can be added, replaced, or
|
|
1633
|
+
# removed, see [Group][1].
|
|
1634
|
+
#
|
|
1635
|
+
#
|
|
1636
|
+
#
|
|
1637
|
+
# [1]: https://docs.aws.amazon.com/singlesignon/latest/IdentityStoreAPIReference/API_Group.html
|
|
1537
1638
|
#
|
|
1538
1639
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
|
1539
1640
|
#
|
|
@@ -1559,8 +1660,8 @@ module Aws::IdentityStore
|
|
|
1559
1660
|
req.send_request(options)
|
|
1560
1661
|
end
|
|
1561
1662
|
|
|
1562
|
-
#
|
|
1563
|
-
#
|
|
1663
|
+
# Updates the specified user metadata and attributes in the specified
|
|
1664
|
+
# identity store.
|
|
1564
1665
|
#
|
|
1565
1666
|
# @option params [required, String] :identity_store_id
|
|
1566
1667
|
# The globally unique identifier for the identity store.
|
|
@@ -1570,7 +1671,13 @@ module Aws::IdentityStore
|
|
|
1570
1671
|
#
|
|
1571
1672
|
# @option params [required, Array<Types::AttributeOperation>] :operations
|
|
1572
1673
|
# A list of `AttributeOperation` objects to apply to the requested user.
|
|
1573
|
-
# These operations might add, replace, or remove an attribute.
|
|
1674
|
+
# These operations might add, replace, or remove an attribute. For more
|
|
1675
|
+
# information on the attributes that can be added, replaced, or removed,
|
|
1676
|
+
# see [User][1].
|
|
1677
|
+
#
|
|
1678
|
+
#
|
|
1679
|
+
#
|
|
1680
|
+
# [1]: https://docs.aws.amazon.com/singlesignon/latest/IdentityStoreAPIReference/API_User.html
|
|
1574
1681
|
#
|
|
1575
1682
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
|
1576
1683
|
#
|
|
@@ -1614,7 +1721,7 @@ module Aws::IdentityStore
|
|
|
1614
1721
|
tracer: tracer
|
|
1615
1722
|
)
|
|
1616
1723
|
context[:gem_name] = 'aws-sdk-identitystore'
|
|
1617
|
-
context[:gem_version] = '1.
|
|
1724
|
+
context[:gem_version] = '1.60.0'
|
|
1618
1725
|
Seahorse::Client::Request.new(handlers, context)
|
|
1619
1726
|
end
|
|
1620
1727
|
|