aws-sdk-identitystore 1.17.0 → 1.20.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -361,13 +361,298 @@ module Aws::IdentityStore
361
361
 
362
362
  # @!group API Operations
363
363
 
364
+ # Creates a group within the specified identity store.
365
+ #
366
+ # @option params [required, String] :identity_store_id
367
+ # The globally unique identifier for the identity store.
368
+ #
369
+ # @option params [String] :display_name
370
+ # A string containing the name of the group. This value is commonly
371
+ # displayed when the group is referenced.
372
+ #
373
+ # @option params [String] :description
374
+ # A string containing the description of the group.
375
+ #
376
+ # @return [Types::CreateGroupResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
377
+ #
378
+ # * {Types::CreateGroupResponse#group_id #group_id} => String
379
+ # * {Types::CreateGroupResponse#identity_store_id #identity_store_id} => String
380
+ #
381
+ # @example Request syntax with placeholder values
382
+ #
383
+ # resp = client.create_group({
384
+ # identity_store_id: "IdentityStoreId", # required
385
+ # display_name: "GroupDisplayName",
386
+ # description: "SensitiveStringType",
387
+ # })
388
+ #
389
+ # @example Response structure
390
+ #
391
+ # resp.group_id #=> String
392
+ # resp.identity_store_id #=> String
393
+ #
394
+ # @see http://docs.aws.amazon.com/goto/WebAPI/identitystore-2020-06-15/CreateGroup AWS API Documentation
395
+ #
396
+ # @overload create_group(params = {})
397
+ # @param [Hash] params ({})
398
+ def create_group(params = {}, options = {})
399
+ req = build_request(:create_group, params)
400
+ req.send_request(options)
401
+ end
402
+
403
+ # Creates a relationship between a member and a group. The following
404
+ # identifiers must be specified: `GroupId`, `IdentityStoreId`, and
405
+ # `MemberId`.
406
+ #
407
+ # @option params [required, String] :identity_store_id
408
+ # The globally unique identifier for the identity store.
409
+ #
410
+ # @option params [required, String] :group_id
411
+ # The identifier for a group in the identity store.
412
+ #
413
+ # @option params [required, Types::MemberId] :member_id
414
+ # An object that contains the identifier of a group member. Setting the
415
+ # `UserID` field to the specific identifier for a user indicates that
416
+ # the user is a member of the group.
417
+ #
418
+ # @return [Types::CreateGroupMembershipResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
419
+ #
420
+ # * {Types::CreateGroupMembershipResponse#membership_id #membership_id} => String
421
+ # * {Types::CreateGroupMembershipResponse#identity_store_id #identity_store_id} => String
422
+ #
423
+ # @example Request syntax with placeholder values
424
+ #
425
+ # resp = client.create_group_membership({
426
+ # identity_store_id: "IdentityStoreId", # required
427
+ # group_id: "ResourceId", # required
428
+ # member_id: { # required
429
+ # user_id: "ResourceId",
430
+ # },
431
+ # })
432
+ #
433
+ # @example Response structure
434
+ #
435
+ # resp.membership_id #=> String
436
+ # resp.identity_store_id #=> String
437
+ #
438
+ # @see http://docs.aws.amazon.com/goto/WebAPI/identitystore-2020-06-15/CreateGroupMembership AWS API Documentation
439
+ #
440
+ # @overload create_group_membership(params = {})
441
+ # @param [Hash] params ({})
442
+ def create_group_membership(params = {}, options = {})
443
+ req = build_request(:create_group_membership, params)
444
+ req.send_request(options)
445
+ end
446
+
447
+ # Creates a new user within the specified identity store.
448
+ #
449
+ # @option params [required, String] :identity_store_id
450
+ # The globally unique identifier for the identity store.
451
+ #
452
+ # @option params [String] :user_name
453
+ # A unique string used to identify the user. The length limit is 128
454
+ # characters. This value can consist of letters, accented characters,
455
+ # symbols, numbers, and punctuation. This value is specified at the time
456
+ # the user is created and stored as an attribute of the user object in
457
+ # the identity store.
458
+ #
459
+ # @option params [Types::Name] :name
460
+ # An object containing the user's name.
461
+ #
462
+ # @option params [String] :display_name
463
+ # A string containing the user's name. This value is typically
464
+ # formatted for display when the user is referenced. For example, "John
465
+ # Doe."
466
+ #
467
+ # @option params [String] :nick_name
468
+ # A string containing an alternate name for the user.
469
+ #
470
+ # @option params [String] :profile_url
471
+ # A string containing a URL that may be associated with the user.
472
+ #
473
+ # @option params [Array<Types::Email>] :emails
474
+ # A list of `Email` objects containing email addresses associated with
475
+ # the user.
476
+ #
477
+ # @option params [Array<Types::Address>] :addresses
478
+ # A list of `Address` objects containing addresses associated with the
479
+ # user.
480
+ #
481
+ # @option params [Array<Types::PhoneNumber>] :phone_numbers
482
+ # A list of `PhoneNumber` objects containing phone numbers associated
483
+ # with the user.
484
+ #
485
+ # @option params [String] :user_type
486
+ # A string indicating the user's type. Possible values depend on each
487
+ # customer's specific needs, so they are left unspecified.
488
+ #
489
+ # @option params [String] :title
490
+ # A string containing the user's title. Possible values are left
491
+ # unspecified given that they depend on each customer's specific needs.
492
+ #
493
+ # @option params [String] :preferred_language
494
+ # A string containing the preferred language of the user. For example,
495
+ # "American English" or "en-us."
496
+ #
497
+ # @option params [String] :locale
498
+ # A string containing the user's geographical region or location.
499
+ #
500
+ # @option params [String] :timezone
501
+ # A string containing the user's time zone.
502
+ #
503
+ # @return [Types::CreateUserResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
504
+ #
505
+ # * {Types::CreateUserResponse#user_id #user_id} => String
506
+ # * {Types::CreateUserResponse#identity_store_id #identity_store_id} => String
507
+ #
508
+ # @example Request syntax with placeholder values
509
+ #
510
+ # resp = client.create_user({
511
+ # identity_store_id: "IdentityStoreId", # required
512
+ # user_name: "UserName",
513
+ # name: {
514
+ # formatted: "SensitiveStringType",
515
+ # family_name: "SensitiveStringType",
516
+ # given_name: "SensitiveStringType",
517
+ # middle_name: "SensitiveStringType",
518
+ # honorific_prefix: "SensitiveStringType",
519
+ # honorific_suffix: "SensitiveStringType",
520
+ # },
521
+ # display_name: "SensitiveStringType",
522
+ # nick_name: "SensitiveStringType",
523
+ # profile_url: "SensitiveStringType",
524
+ # emails: [
525
+ # {
526
+ # value: "SensitiveStringType",
527
+ # type: "SensitiveStringType",
528
+ # primary: false,
529
+ # },
530
+ # ],
531
+ # addresses: [
532
+ # {
533
+ # street_address: "SensitiveStringType",
534
+ # locality: "SensitiveStringType",
535
+ # region: "SensitiveStringType",
536
+ # postal_code: "SensitiveStringType",
537
+ # country: "SensitiveStringType",
538
+ # formatted: "SensitiveStringType",
539
+ # type: "SensitiveStringType",
540
+ # primary: false,
541
+ # },
542
+ # ],
543
+ # phone_numbers: [
544
+ # {
545
+ # value: "SensitiveStringType",
546
+ # type: "SensitiveStringType",
547
+ # primary: false,
548
+ # },
549
+ # ],
550
+ # user_type: "SensitiveStringType",
551
+ # title: "SensitiveStringType",
552
+ # preferred_language: "SensitiveStringType",
553
+ # locale: "SensitiveStringType",
554
+ # timezone: "SensitiveStringType",
555
+ # })
556
+ #
557
+ # @example Response structure
558
+ #
559
+ # resp.user_id #=> String
560
+ # resp.identity_store_id #=> String
561
+ #
562
+ # @see http://docs.aws.amazon.com/goto/WebAPI/identitystore-2020-06-15/CreateUser AWS API Documentation
563
+ #
564
+ # @overload create_user(params = {})
565
+ # @param [Hash] params ({})
566
+ def create_user(params = {}, options = {})
567
+ req = build_request(:create_user, params)
568
+ req.send_request(options)
569
+ end
570
+
571
+ # Delete a group within an identity store given `GroupId`.
572
+ #
573
+ # @option params [required, String] :identity_store_id
574
+ # The globally unique identifier for the identity store.
575
+ #
576
+ # @option params [required, String] :group_id
577
+ # The identifier for a group in the identity store.
578
+ #
579
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
580
+ #
581
+ # @example Request syntax with placeholder values
582
+ #
583
+ # resp = client.delete_group({
584
+ # identity_store_id: "IdentityStoreId", # required
585
+ # group_id: "ResourceId", # required
586
+ # })
587
+ #
588
+ # @see http://docs.aws.amazon.com/goto/WebAPI/identitystore-2020-06-15/DeleteGroup AWS API Documentation
589
+ #
590
+ # @overload delete_group(params = {})
591
+ # @param [Hash] params ({})
592
+ def delete_group(params = {}, options = {})
593
+ req = build_request(:delete_group, params)
594
+ req.send_request(options)
595
+ end
596
+
597
+ # Delete a membership within a group given `MembershipId`.
598
+ #
599
+ # @option params [required, String] :identity_store_id
600
+ # The globally unique identifier for the identity store.
601
+ #
602
+ # @option params [required, String] :membership_id
603
+ # The identifier for a `GroupMembership` in an identity store.
604
+ #
605
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
606
+ #
607
+ # @example Request syntax with placeholder values
608
+ #
609
+ # resp = client.delete_group_membership({
610
+ # identity_store_id: "IdentityStoreId", # required
611
+ # membership_id: "ResourceId", # required
612
+ # })
613
+ #
614
+ # @see http://docs.aws.amazon.com/goto/WebAPI/identitystore-2020-06-15/DeleteGroupMembership AWS API Documentation
615
+ #
616
+ # @overload delete_group_membership(params = {})
617
+ # @param [Hash] params ({})
618
+ def delete_group_membership(params = {}, options = {})
619
+ req = build_request(:delete_group_membership, params)
620
+ req.send_request(options)
621
+ end
622
+
623
+ # Deletes a user within an identity store given `UserId`.
624
+ #
625
+ # @option params [required, String] :identity_store_id
626
+ # The globally unique identifier for the identity store.
627
+ #
628
+ # @option params [required, String] :user_id
629
+ # The identifier for a user in the identity store.
630
+ #
631
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
632
+ #
633
+ # @example Request syntax with placeholder values
634
+ #
635
+ # resp = client.delete_user({
636
+ # identity_store_id: "IdentityStoreId", # required
637
+ # user_id: "ResourceId", # required
638
+ # })
639
+ #
640
+ # @see http://docs.aws.amazon.com/goto/WebAPI/identitystore-2020-06-15/DeleteUser AWS API Documentation
641
+ #
642
+ # @overload delete_user(params = {})
643
+ # @param [Hash] params ({})
644
+ def delete_user(params = {}, options = {})
645
+ req = build_request(:delete_user, params)
646
+ req.send_request(options)
647
+ end
648
+
364
649
  # Retrieves the group metadata and attributes from `GroupId` in an
365
650
  # identity store.
366
651
  #
367
652
  # @option params [required, String] :identity_store_id
368
653
  # The globally unique identifier for the identity store, such as
369
654
  # `d-1234567890`. In this example, `d-` is a fixed prefix, and
370
- # `1234567890` is a randomly generated string that contains number and
655
+ # `1234567890` is a randomly generated string that contains numbers and
371
656
  # lower case letters. This value is generated at the time that a new
372
657
  # identity store is created.
373
658
  #
@@ -378,6 +663,9 @@ module Aws::IdentityStore
378
663
  #
379
664
  # * {Types::DescribeGroupResponse#group_id #group_id} => String
380
665
  # * {Types::DescribeGroupResponse#display_name #display_name} => String
666
+ # * {Types::DescribeGroupResponse#external_ids #external_ids} => Array&lt;Types::ExternalId&gt;
667
+ # * {Types::DescribeGroupResponse#description #description} => String
668
+ # * {Types::DescribeGroupResponse#identity_store_id #identity_store_id} => String
381
669
  #
382
670
  # @example Request syntax with placeholder values
383
671
  #
@@ -390,6 +678,11 @@ module Aws::IdentityStore
390
678
  #
391
679
  # resp.group_id #=> String
392
680
  # resp.display_name #=> String
681
+ # resp.external_ids #=> Array
682
+ # resp.external_ids[0].issuer #=> String
683
+ # resp.external_ids[0].id #=> String
684
+ # resp.description #=> String
685
+ # resp.identity_store_id #=> String
393
686
  #
394
687
  # @see http://docs.aws.amazon.com/goto/WebAPI/identitystore-2020-06-15/DescribeGroup AWS API Documentation
395
688
  #
@@ -400,13 +693,52 @@ module Aws::IdentityStore
400
693
  req.send_request(options)
401
694
  end
402
695
 
403
- # Retrieves the user metadata and attributes from `UserId` in an
696
+ # Retrieves membership metadata and attributes from `MembershipId` in an
697
+ # identity store.
698
+ #
699
+ # @option params [required, String] :identity_store_id
700
+ # The globally unique identifier for the identity store.
701
+ #
702
+ # @option params [required, String] :membership_id
703
+ # The identifier for a `GroupMembership` in an identity store.
704
+ #
705
+ # @return [Types::DescribeGroupMembershipResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
706
+ #
707
+ # * {Types::DescribeGroupMembershipResponse#identity_store_id #identity_store_id} => String
708
+ # * {Types::DescribeGroupMembershipResponse#membership_id #membership_id} => String
709
+ # * {Types::DescribeGroupMembershipResponse#group_id #group_id} => String
710
+ # * {Types::DescribeGroupMembershipResponse#member_id #member_id} => Types::MemberId
711
+ #
712
+ # @example Request syntax with placeholder values
713
+ #
714
+ # resp = client.describe_group_membership({
715
+ # identity_store_id: "IdentityStoreId", # required
716
+ # membership_id: "ResourceId", # required
717
+ # })
718
+ #
719
+ # @example Response structure
720
+ #
721
+ # resp.identity_store_id #=> String
722
+ # resp.membership_id #=> String
723
+ # resp.group_id #=> String
724
+ # resp.member_id.user_id #=> String
725
+ #
726
+ # @see http://docs.aws.amazon.com/goto/WebAPI/identitystore-2020-06-15/DescribeGroupMembership AWS API Documentation
727
+ #
728
+ # @overload describe_group_membership(params = {})
729
+ # @param [Hash] params ({})
730
+ def describe_group_membership(params = {}, options = {})
731
+ req = build_request(:describe_group_membership, params)
732
+ req.send_request(options)
733
+ end
734
+
735
+ # Retrieves the user metadata and attributes from the `UserId` in an
404
736
  # identity store.
405
737
  #
406
738
  # @option params [required, String] :identity_store_id
407
739
  # The globally unique identifier for the identity store, such as
408
740
  # `d-1234567890`. In this example, `d-` is a fixed prefix, and
409
- # `1234567890` is a randomly generated string that contains number and
741
+ # `1234567890` is a randomly generated string that contains numbers and
410
742
  # lower case letters. This value is generated at the time that a new
411
743
  # identity store is created.
412
744
  #
@@ -417,6 +749,20 @@ module Aws::IdentityStore
417
749
  #
418
750
  # * {Types::DescribeUserResponse#user_name #user_name} => String
419
751
  # * {Types::DescribeUserResponse#user_id #user_id} => String
752
+ # * {Types::DescribeUserResponse#external_ids #external_ids} => Array&lt;Types::ExternalId&gt;
753
+ # * {Types::DescribeUserResponse#name #name} => Types::Name
754
+ # * {Types::DescribeUserResponse#display_name #display_name} => String
755
+ # * {Types::DescribeUserResponse#nick_name #nick_name} => String
756
+ # * {Types::DescribeUserResponse#profile_url #profile_url} => String
757
+ # * {Types::DescribeUserResponse#emails #emails} => Array&lt;Types::Email&gt;
758
+ # * {Types::DescribeUserResponse#addresses #addresses} => Array&lt;Types::Address&gt;
759
+ # * {Types::DescribeUserResponse#phone_numbers #phone_numbers} => Array&lt;Types::PhoneNumber&gt;
760
+ # * {Types::DescribeUserResponse#user_type #user_type} => String
761
+ # * {Types::DescribeUserResponse#title #title} => String
762
+ # * {Types::DescribeUserResponse#preferred_language #preferred_language} => String
763
+ # * {Types::DescribeUserResponse#locale #locale} => String
764
+ # * {Types::DescribeUserResponse#timezone #timezone} => String
765
+ # * {Types::DescribeUserResponse#identity_store_id #identity_store_id} => String
420
766
  #
421
767
  # @example Request syntax with placeholder values
422
768
  #
@@ -429,6 +775,41 @@ module Aws::IdentityStore
429
775
  #
430
776
  # resp.user_name #=> String
431
777
  # resp.user_id #=> String
778
+ # resp.external_ids #=> Array
779
+ # resp.external_ids[0].issuer #=> String
780
+ # resp.external_ids[0].id #=> String
781
+ # resp.name.formatted #=> String
782
+ # resp.name.family_name #=> String
783
+ # resp.name.given_name #=> String
784
+ # resp.name.middle_name #=> String
785
+ # resp.name.honorific_prefix #=> String
786
+ # resp.name.honorific_suffix #=> String
787
+ # resp.display_name #=> String
788
+ # resp.nick_name #=> String
789
+ # resp.profile_url #=> String
790
+ # resp.emails #=> Array
791
+ # resp.emails[0].value #=> String
792
+ # resp.emails[0].type #=> String
793
+ # resp.emails[0].primary #=> Boolean
794
+ # resp.addresses #=> Array
795
+ # resp.addresses[0].street_address #=> String
796
+ # resp.addresses[0].locality #=> String
797
+ # resp.addresses[0].region #=> String
798
+ # resp.addresses[0].postal_code #=> String
799
+ # resp.addresses[0].country #=> String
800
+ # resp.addresses[0].formatted #=> String
801
+ # resp.addresses[0].type #=> String
802
+ # resp.addresses[0].primary #=> Boolean
803
+ # resp.phone_numbers #=> Array
804
+ # resp.phone_numbers[0].value #=> String
805
+ # resp.phone_numbers[0].type #=> String
806
+ # resp.phone_numbers[0].primary #=> Boolean
807
+ # resp.user_type #=> String
808
+ # resp.title #=> String
809
+ # resp.preferred_language #=> String
810
+ # resp.locale #=> String
811
+ # resp.timezone #=> String
812
+ # resp.identity_store_id #=> String
432
813
  #
433
814
  # @see http://docs.aws.amazon.com/goto/WebAPI/identitystore-2020-06-15/DescribeUser AWS API Documentation
434
815
  #
@@ -439,6 +820,299 @@ module Aws::IdentityStore
439
820
  req.send_request(options)
440
821
  end
441
822
 
823
+ # Retrieves `GroupId` in an identity store.
824
+ #
825
+ # @option params [required, String] :identity_store_id
826
+ # The globally unique identifier for the identity store.
827
+ #
828
+ # @option params [required, Types::AlternateIdentifier] :alternate_identifier
829
+ # A unique identifier for an identity resource that is not the primary
830
+ # identifier. This value can be an identifier from an external identity
831
+ # provider (IdP) that is associated with the group or a unique
832
+ # attribute. For example, a unique `GroupDisplayName`.
833
+ #
834
+ # @return [Types::GetGroupIdResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
835
+ #
836
+ # * {Types::GetGroupIdResponse#group_id #group_id} => String
837
+ # * {Types::GetGroupIdResponse#identity_store_id #identity_store_id} => String
838
+ #
839
+ # @example Request syntax with placeholder values
840
+ #
841
+ # resp = client.get_group_id({
842
+ # identity_store_id: "IdentityStoreId", # required
843
+ # alternate_identifier: { # required
844
+ # external_id: {
845
+ # issuer: "ExternalIdIssuer", # required
846
+ # id: "ExternalIdIdentifier", # required
847
+ # },
848
+ # unique_attribute: {
849
+ # attribute_path: "AttributePath", # required
850
+ # attribute_value: "value", # required, value <Hash,Array,String,Numeric,Boolean,IO,Set,nil>
851
+ # },
852
+ # },
853
+ # })
854
+ #
855
+ # @example Response structure
856
+ #
857
+ # resp.group_id #=> String
858
+ # resp.identity_store_id #=> String
859
+ #
860
+ # @see http://docs.aws.amazon.com/goto/WebAPI/identitystore-2020-06-15/GetGroupId AWS API Documentation
861
+ #
862
+ # @overload get_group_id(params = {})
863
+ # @param [Hash] params ({})
864
+ def get_group_id(params = {}, options = {})
865
+ req = build_request(:get_group_id, params)
866
+ req.send_request(options)
867
+ end
868
+
869
+ # Retrieves the `MembershipId` in an identity store.
870
+ #
871
+ # @option params [required, String] :identity_store_id
872
+ # The globally unique identifier for the identity store.
873
+ #
874
+ # @option params [required, String] :group_id
875
+ # The identifier for a group in the identity store.
876
+ #
877
+ # @option params [required, Types::MemberId] :member_id
878
+ # An object that contains the identifier of a group member. Setting the
879
+ # `UserID` field to the specific identifier for a user indicates that
880
+ # the user is a member of the group.
881
+ #
882
+ # @return [Types::GetGroupMembershipIdResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
883
+ #
884
+ # * {Types::GetGroupMembershipIdResponse#membership_id #membership_id} => String
885
+ # * {Types::GetGroupMembershipIdResponse#identity_store_id #identity_store_id} => String
886
+ #
887
+ # @example Request syntax with placeholder values
888
+ #
889
+ # resp = client.get_group_membership_id({
890
+ # identity_store_id: "IdentityStoreId", # required
891
+ # group_id: "ResourceId", # required
892
+ # member_id: { # required
893
+ # user_id: "ResourceId",
894
+ # },
895
+ # })
896
+ #
897
+ # @example Response structure
898
+ #
899
+ # resp.membership_id #=> String
900
+ # resp.identity_store_id #=> String
901
+ #
902
+ # @see http://docs.aws.amazon.com/goto/WebAPI/identitystore-2020-06-15/GetGroupMembershipId AWS API Documentation
903
+ #
904
+ # @overload get_group_membership_id(params = {})
905
+ # @param [Hash] params ({})
906
+ def get_group_membership_id(params = {}, options = {})
907
+ req = build_request(:get_group_membership_id, params)
908
+ req.send_request(options)
909
+ end
910
+
911
+ # Retrieves the `UserId` in an identity store.
912
+ #
913
+ # @option params [required, String] :identity_store_id
914
+ # The globally unique identifier for the identity store.
915
+ #
916
+ # @option params [required, Types::AlternateIdentifier] :alternate_identifier
917
+ # A unique identifier for an identity resource that is not the primary
918
+ # identifier.
919
+ #
920
+ # @return [Types::GetUserIdResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
921
+ #
922
+ # * {Types::GetUserIdResponse#user_id #user_id} => String
923
+ # * {Types::GetUserIdResponse#identity_store_id #identity_store_id} => String
924
+ #
925
+ # @example Request syntax with placeholder values
926
+ #
927
+ # resp = client.get_user_id({
928
+ # identity_store_id: "IdentityStoreId", # required
929
+ # alternate_identifier: { # required
930
+ # external_id: {
931
+ # issuer: "ExternalIdIssuer", # required
932
+ # id: "ExternalIdIdentifier", # required
933
+ # },
934
+ # unique_attribute: {
935
+ # attribute_path: "AttributePath", # required
936
+ # attribute_value: "value", # required, value <Hash,Array,String,Numeric,Boolean,IO,Set,nil>
937
+ # },
938
+ # },
939
+ # })
940
+ #
941
+ # @example Response structure
942
+ #
943
+ # resp.user_id #=> String
944
+ # resp.identity_store_id #=> String
945
+ #
946
+ # @see http://docs.aws.amazon.com/goto/WebAPI/identitystore-2020-06-15/GetUserId AWS API Documentation
947
+ #
948
+ # @overload get_user_id(params = {})
949
+ # @param [Hash] params ({})
950
+ def get_user_id(params = {}, options = {})
951
+ req = build_request(:get_user_id, params)
952
+ req.send_request(options)
953
+ end
954
+
955
+ # Checks the user's membership in all requested groups and returns if
956
+ # the member exists in all queried groups.
957
+ #
958
+ # @option params [required, String] :identity_store_id
959
+ # The globally unique identifier for the identity store.
960
+ #
961
+ # @option params [required, Types::MemberId] :member_id
962
+ # An object containing the identifier of a group member.
963
+ #
964
+ # @option params [required, Array<String>] :group_ids
965
+ # A list of identifiers for groups in the identity store.
966
+ #
967
+ # @return [Types::IsMemberInGroupsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
968
+ #
969
+ # * {Types::IsMemberInGroupsResponse#results #results} => Array&lt;Types::GroupMembershipExistenceResult&gt;
970
+ #
971
+ # @example Request syntax with placeholder values
972
+ #
973
+ # resp = client.is_member_in_groups({
974
+ # identity_store_id: "IdentityStoreId", # required
975
+ # member_id: { # required
976
+ # user_id: "ResourceId",
977
+ # },
978
+ # group_ids: ["ResourceId"], # required
979
+ # })
980
+ #
981
+ # @example Response structure
982
+ #
983
+ # resp.results #=> Array
984
+ # resp.results[0].group_id #=> String
985
+ # resp.results[0].member_id.user_id #=> String
986
+ # resp.results[0].membership_exists #=> Boolean
987
+ #
988
+ # @see http://docs.aws.amazon.com/goto/WebAPI/identitystore-2020-06-15/IsMemberInGroups AWS API Documentation
989
+ #
990
+ # @overload is_member_in_groups(params = {})
991
+ # @param [Hash] params ({})
992
+ def is_member_in_groups(params = {}, options = {})
993
+ req = build_request(:is_member_in_groups, params)
994
+ req.send_request(options)
995
+ end
996
+
997
+ # For the specified group in the specified identity store, returns the
998
+ # list of all `GroupMembership` objects and returns results in paginated
999
+ # form.
1000
+ #
1001
+ # @option params [required, String] :identity_store_id
1002
+ # The globally unique identifier for the identity store.
1003
+ #
1004
+ # @option params [required, String] :group_id
1005
+ # The identifier for a group in the identity store.
1006
+ #
1007
+ # @option params [Integer] :max_results
1008
+ # The maximum number of results to be returned per request. This
1009
+ # parameter is used in all `List` requests to specify how many results
1010
+ # to return in one page.
1011
+ #
1012
+ # @option params [String] :next_token
1013
+ # The pagination token used for the `ListUsers`, `ListGroups` and
1014
+ # `ListGroupMemberships` API operations. This value is generated by the
1015
+ # identity store service. It is returned in the API response if the
1016
+ # total results are more than the size of one page. This token is also
1017
+ # returned when it is used in the API request to search for the next
1018
+ # page.
1019
+ #
1020
+ # @return [Types::ListGroupMembershipsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1021
+ #
1022
+ # * {Types::ListGroupMembershipsResponse#group_memberships #group_memberships} => Array&lt;Types::GroupMembership&gt;
1023
+ # * {Types::ListGroupMembershipsResponse#next_token #next_token} => String
1024
+ #
1025
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
1026
+ #
1027
+ # @example Request syntax with placeholder values
1028
+ #
1029
+ # resp = client.list_group_memberships({
1030
+ # identity_store_id: "IdentityStoreId", # required
1031
+ # group_id: "ResourceId", # required
1032
+ # max_results: 1,
1033
+ # next_token: "NextToken",
1034
+ # })
1035
+ #
1036
+ # @example Response structure
1037
+ #
1038
+ # resp.group_memberships #=> Array
1039
+ # resp.group_memberships[0].identity_store_id #=> String
1040
+ # resp.group_memberships[0].membership_id #=> String
1041
+ # resp.group_memberships[0].group_id #=> String
1042
+ # resp.group_memberships[0].member_id.user_id #=> String
1043
+ # resp.next_token #=> String
1044
+ #
1045
+ # @see http://docs.aws.amazon.com/goto/WebAPI/identitystore-2020-06-15/ListGroupMemberships AWS API Documentation
1046
+ #
1047
+ # @overload list_group_memberships(params = {})
1048
+ # @param [Hash] params ({})
1049
+ def list_group_memberships(params = {}, options = {})
1050
+ req = build_request(:list_group_memberships, params)
1051
+ req.send_request(options)
1052
+ end
1053
+
1054
+ # For the specified member in the specified identity store, returns the
1055
+ # list of all `GroupMembership` objects and returns results in paginated
1056
+ # form.
1057
+ #
1058
+ # @option params [required, String] :identity_store_id
1059
+ # The globally unique identifier for the identity store.
1060
+ #
1061
+ # @option params [required, Types::MemberId] :member_id
1062
+ # An object that contains the identifier of a group member. Setting the
1063
+ # `UserID` field to the specific identifier for a user indicates that
1064
+ # the user is a member of the group.
1065
+ #
1066
+ # @option params [Integer] :max_results
1067
+ # The maximum number of results to be returned per request. This
1068
+ # parameter is used in the `ListUsers` and `ListGroups` requests to
1069
+ # specify how many results to return in one page. The length limit is 50
1070
+ # characters.
1071
+ #
1072
+ # @option params [String] :next_token
1073
+ # The pagination token used for the `ListUsers`, `ListGroups`, and
1074
+ # `ListGroupMemberships` API operations. This value is generated by the
1075
+ # identity store service. It is returned in the API response if the
1076
+ # total results are more than the size of one page. This token is also
1077
+ # returned when it is used in the API request to search for the next
1078
+ # page.
1079
+ #
1080
+ # @return [Types::ListGroupMembershipsForMemberResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1081
+ #
1082
+ # * {Types::ListGroupMembershipsForMemberResponse#group_memberships #group_memberships} => Array&lt;Types::GroupMembership&gt;
1083
+ # * {Types::ListGroupMembershipsForMemberResponse#next_token #next_token} => String
1084
+ #
1085
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
1086
+ #
1087
+ # @example Request syntax with placeholder values
1088
+ #
1089
+ # resp = client.list_group_memberships_for_member({
1090
+ # identity_store_id: "IdentityStoreId", # required
1091
+ # member_id: { # required
1092
+ # user_id: "ResourceId",
1093
+ # },
1094
+ # max_results: 1,
1095
+ # next_token: "NextToken",
1096
+ # })
1097
+ #
1098
+ # @example Response structure
1099
+ #
1100
+ # resp.group_memberships #=> Array
1101
+ # resp.group_memberships[0].identity_store_id #=> String
1102
+ # resp.group_memberships[0].membership_id #=> String
1103
+ # resp.group_memberships[0].group_id #=> String
1104
+ # resp.group_memberships[0].member_id.user_id #=> String
1105
+ # resp.next_token #=> String
1106
+ #
1107
+ # @see http://docs.aws.amazon.com/goto/WebAPI/identitystore-2020-06-15/ListGroupMembershipsForMember AWS API Documentation
1108
+ #
1109
+ # @overload list_group_memberships_for_member(params = {})
1110
+ # @param [Hash] params ({})
1111
+ def list_group_memberships_for_member(params = {}, options = {})
1112
+ req = build_request(:list_group_memberships_for_member, params)
1113
+ req.send_request(options)
1114
+ end
1115
+
442
1116
  # Lists the attribute name and value of the group that you specified in
443
1117
  # the search. We only support `DisplayName` as a valid filter attribute
444
1118
  # path currently, and filter is required. This API returns minimum
@@ -448,13 +1122,13 @@ module Aws::IdentityStore
448
1122
  # @option params [required, String] :identity_store_id
449
1123
  # The globally unique identifier for the identity store, such as
450
1124
  # `d-1234567890`. In this example, `d-` is a fixed prefix, and
451
- # `1234567890` is a randomly generated string that contains number and
1125
+ # `1234567890` is a randomly generated string that contains numbers and
452
1126
  # lower case letters. This value is generated at the time that a new
453
1127
  # identity store is created.
454
1128
  #
455
1129
  # @option params [Integer] :max_results
456
1130
  # The maximum number of results to be returned per request. This
457
- # parameter is used in the `ListUsers` and `ListGroups` request to
1131
+ # parameter is used in the `ListUsers` and `ListGroups` requests to
458
1132
  # specify how many results to return in one page. The length limit is 50
459
1133
  # characters.
460
1134
  #
@@ -467,7 +1141,7 @@ module Aws::IdentityStore
467
1141
  #
468
1142
  # @option params [Array<Types::Filter>] :filters
469
1143
  # A list of `Filter` objects, which is used in the `ListUsers` and
470
- # `ListGroups` request.
1144
+ # `ListGroups` requests.
471
1145
  #
472
1146
  # @return [Types::ListGroupsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
473
1147
  #
@@ -495,6 +1169,11 @@ module Aws::IdentityStore
495
1169
  # resp.groups #=> Array
496
1170
  # resp.groups[0].group_id #=> String
497
1171
  # resp.groups[0].display_name #=> String
1172
+ # resp.groups[0].external_ids #=> Array
1173
+ # resp.groups[0].external_ids[0].issuer #=> String
1174
+ # resp.groups[0].external_ids[0].id #=> String
1175
+ # resp.groups[0].description #=> String
1176
+ # resp.groups[0].identity_store_id #=> String
498
1177
  # resp.next_token #=> String
499
1178
  #
500
1179
  # @see http://docs.aws.amazon.com/goto/WebAPI/identitystore-2020-06-15/ListGroups AWS API Documentation
@@ -514,13 +1193,13 @@ module Aws::IdentityStore
514
1193
  # @option params [required, String] :identity_store_id
515
1194
  # The globally unique identifier for the identity store, such as
516
1195
  # `d-1234567890`. In this example, `d-` is a fixed prefix, and
517
- # `1234567890` is a randomly generated string that contains number and
1196
+ # `1234567890` is a randomly generated string that contains numbers and
518
1197
  # lower case letters. This value is generated at the time that a new
519
1198
  # identity store is created.
520
1199
  #
521
1200
  # @option params [Integer] :max_results
522
1201
  # The maximum number of results to be returned per request. This
523
- # parameter is used in the `ListUsers` and `ListGroups` request to
1202
+ # parameter is used in the `ListUsers` and `ListGroups` requests to
524
1203
  # specify how many results to return in one page. The length limit is 50
525
1204
  # characters.
526
1205
  #
@@ -533,7 +1212,7 @@ module Aws::IdentityStore
533
1212
  #
534
1213
  # @option params [Array<Types::Filter>] :filters
535
1214
  # A list of `Filter` objects, which is used in the `ListUsers` and
536
- # `ListGroups` request.
1215
+ # `ListGroups` requests.
537
1216
  #
538
1217
  # @return [Types::ListUsersResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
539
1218
  #
@@ -561,6 +1240,41 @@ module Aws::IdentityStore
561
1240
  # resp.users #=> Array
562
1241
  # resp.users[0].user_name #=> String
563
1242
  # resp.users[0].user_id #=> String
1243
+ # resp.users[0].external_ids #=> Array
1244
+ # resp.users[0].external_ids[0].issuer #=> String
1245
+ # resp.users[0].external_ids[0].id #=> String
1246
+ # resp.users[0].name.formatted #=> String
1247
+ # resp.users[0].name.family_name #=> String
1248
+ # resp.users[0].name.given_name #=> String
1249
+ # resp.users[0].name.middle_name #=> String
1250
+ # resp.users[0].name.honorific_prefix #=> String
1251
+ # resp.users[0].name.honorific_suffix #=> String
1252
+ # resp.users[0].display_name #=> String
1253
+ # resp.users[0].nick_name #=> String
1254
+ # resp.users[0].profile_url #=> String
1255
+ # resp.users[0].emails #=> Array
1256
+ # resp.users[0].emails[0].value #=> String
1257
+ # resp.users[0].emails[0].type #=> String
1258
+ # resp.users[0].emails[0].primary #=> Boolean
1259
+ # resp.users[0].addresses #=> Array
1260
+ # resp.users[0].addresses[0].street_address #=> String
1261
+ # resp.users[0].addresses[0].locality #=> String
1262
+ # resp.users[0].addresses[0].region #=> String
1263
+ # resp.users[0].addresses[0].postal_code #=> String
1264
+ # resp.users[0].addresses[0].country #=> String
1265
+ # resp.users[0].addresses[0].formatted #=> String
1266
+ # resp.users[0].addresses[0].type #=> String
1267
+ # resp.users[0].addresses[0].primary #=> Boolean
1268
+ # resp.users[0].phone_numbers #=> Array
1269
+ # resp.users[0].phone_numbers[0].value #=> String
1270
+ # resp.users[0].phone_numbers[0].type #=> String
1271
+ # resp.users[0].phone_numbers[0].primary #=> Boolean
1272
+ # resp.users[0].user_type #=> String
1273
+ # resp.users[0].title #=> String
1274
+ # resp.users[0].preferred_language #=> String
1275
+ # resp.users[0].locale #=> String
1276
+ # resp.users[0].timezone #=> String
1277
+ # resp.users[0].identity_store_id #=> String
564
1278
  # resp.next_token #=> String
565
1279
  #
566
1280
  # @see http://docs.aws.amazon.com/goto/WebAPI/identitystore-2020-06-15/ListUsers AWS API Documentation
@@ -572,6 +1286,80 @@ module Aws::IdentityStore
572
1286
  req.send_request(options)
573
1287
  end
574
1288
 
1289
+ # For the specified group in the specified identity store, updates the
1290
+ # group metadata and attributes.
1291
+ #
1292
+ # @option params [required, String] :identity_store_id
1293
+ # The globally unique identifier for the identity store.
1294
+ #
1295
+ # @option params [required, String] :group_id
1296
+ # The identifier for a group in the identity store.
1297
+ #
1298
+ # @option params [required, Array<Types::AttributeOperation>] :operations
1299
+ # A list of `AttributeOperation` objects to apply to the requested
1300
+ # group. These operations might add, replace, or remove an attribute.
1301
+ #
1302
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1303
+ #
1304
+ # @example Request syntax with placeholder values
1305
+ #
1306
+ # resp = client.update_group({
1307
+ # identity_store_id: "IdentityStoreId", # required
1308
+ # group_id: "ResourceId", # required
1309
+ # operations: [ # required
1310
+ # {
1311
+ # attribute_path: "AttributePath", # required
1312
+ # attribute_value: "value", # value <Hash,Array,String,Numeric,Boolean,IO,Set,nil>
1313
+ # },
1314
+ # ],
1315
+ # })
1316
+ #
1317
+ # @see http://docs.aws.amazon.com/goto/WebAPI/identitystore-2020-06-15/UpdateGroup AWS API Documentation
1318
+ #
1319
+ # @overload update_group(params = {})
1320
+ # @param [Hash] params ({})
1321
+ def update_group(params = {}, options = {})
1322
+ req = build_request(:update_group, params)
1323
+ req.send_request(options)
1324
+ end
1325
+
1326
+ # For the specified user in the specified identity store, updates the
1327
+ # user metadata and attributes.
1328
+ #
1329
+ # @option params [required, String] :identity_store_id
1330
+ # The globally unique identifier for the identity store.
1331
+ #
1332
+ # @option params [required, String] :user_id
1333
+ # The identifier for a user in the identity store.
1334
+ #
1335
+ # @option params [required, Array<Types::AttributeOperation>] :operations
1336
+ # A list of `AttributeOperation` objects to apply to the requested user.
1337
+ # These operations might add, replace, or remove an attribute.
1338
+ #
1339
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1340
+ #
1341
+ # @example Request syntax with placeholder values
1342
+ #
1343
+ # resp = client.update_user({
1344
+ # identity_store_id: "IdentityStoreId", # required
1345
+ # user_id: "ResourceId", # required
1346
+ # operations: [ # required
1347
+ # {
1348
+ # attribute_path: "AttributePath", # required
1349
+ # attribute_value: "value", # value <Hash,Array,String,Numeric,Boolean,IO,Set,nil>
1350
+ # },
1351
+ # ],
1352
+ # })
1353
+ #
1354
+ # @see http://docs.aws.amazon.com/goto/WebAPI/identitystore-2020-06-15/UpdateUser AWS API Documentation
1355
+ #
1356
+ # @overload update_user(params = {})
1357
+ # @param [Hash] params ({})
1358
+ def update_user(params = {}, options = {})
1359
+ req = build_request(:update_user, params)
1360
+ req.send_request(options)
1361
+ end
1362
+
575
1363
  # @!endgroup
576
1364
 
577
1365
  # @param params ({})
@@ -585,7 +1373,7 @@ module Aws::IdentityStore
585
1373
  params: params,
586
1374
  config: config)
587
1375
  context[:gem_name] = 'aws-sdk-identitystore'
588
- context[:gem_version] = '1.17.0'
1376
+ context[:gem_version] = '1.20.0'
589
1377
  Seahorse::Client::Request.new(handlers, context)
590
1378
  end
591
1379