Class: Aws::IdentityStore::Client

Inherits:
Seahorse::Client::Base show all
Includes:
ClientStubs
Defined in:
gems/aws-sdk-identitystore/lib/aws-sdk-identitystore/client.rb

Overview

An API client for IdentityStore. To construct a client, you need to configure a :region and :credentials.

client = Aws::IdentityStore::Client.new(
  region: region_name,
  credentials: credentials,
  # ...
)

For details on configuring region and credentials see the developer guide.

See #initialize for a full list of supported configuration options.

Instance Attribute Summary

Attributes inherited from Seahorse::Client::Base

#config, #handlers

API Operations collapse

Instance Method Summary collapse

Methods included from ClientStubs

#api_requests, #stub_data, #stub_responses

Methods inherited from Seahorse::Client::Base

add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins

Methods included from Seahorse::Client::HandlerBuilder

#handle, #handle_request, #handle_response

Constructor Details

#initialize(options) ⇒ Client

Returns a new instance of Client.

Parameters:

  • options (Hash)

Options Hash (options):

  • :credentials (required, Aws::CredentialProvider)

    Your AWS credentials. This can be an instance of any one of the following classes:

    • Aws::Credentials - Used for configuring static, non-refreshing credentials.

    • Aws::SharedCredentials - Used for loading static credentials from a shared file, such as ~/.aws/config.

    • Aws::AssumeRoleCredentials - Used when you need to assume a role.

    • Aws::AssumeRoleWebIdentityCredentials - Used when you need to assume a role after providing credentials via the web.

    • Aws::SSOCredentials - Used for loading credentials from AWS SSO using an access token generated from aws login.

    • Aws::ProcessCredentials - Used for loading credentials from a process that outputs to stdout.

    • Aws::InstanceProfileCredentials - Used for loading credentials from an EC2 IMDS on an EC2 instance.

    • Aws::ECSCredentials - Used for loading credentials from instances running in ECS.

    • Aws::CognitoIdentityCredentials - Used for loading credentials from the Cognito Identity service.

    When :credentials are not configured directly, the following locations will be searched for credentials:

    • Aws.config[:credentials]
    • The :access_key_id, :secret_access_key, and :session_token options.
    • ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
    • ~/.aws/credentials
    • ~/.aws/config
    • EC2/ECS IMDS instance profile - When used by default, the timeouts are very aggressive. Construct and pass an instance of Aws::InstanceProfileCredentails or Aws::ECSCredentials to enable retries and extended timeouts. Instance profile credential fetching can be disabled by setting ENV['AWS_EC2_METADATA_DISABLED'] to true.
  • :region (required, String)

    The AWS region to connect to. The configured :region is used to determine the service :endpoint. When not passed, a default :region is searched for in the following locations:

    • Aws.config[:region]
    • ENV['AWS_REGION']
    • ENV['AMAZON_REGION']
    • ENV['AWS_DEFAULT_REGION']
    • ~/.aws/credentials
    • ~/.aws/config
  • :access_key_id (String)
  • :active_endpoint_cache (Boolean) — default: false

    When set to true, a thread polling for endpoints will be running in the background every 60 secs (default). Defaults to false.

  • :adaptive_retry_wait_to_fill (Boolean) — default: true

    Used only in adaptive retry mode. When true, the request will sleep until there is sufficent client side capacity to retry the request. When false, the request will raise a RetryCapacityNotAvailableError and will not retry instead of sleeping.

  • :client_side_monitoring (Boolean) — default: false

    When true, client-side metrics will be collected for all API requests from this client.

  • :client_side_monitoring_client_id (String) — default: ""

    Allows you to provide an identifier for this client which will be attached to all generated client side metrics. Defaults to an empty string.

  • :client_side_monitoring_host (String) — default: "127.0.0.1"

    Allows you to specify the DNS hostname or IPv4 or IPv6 address that the client side monitoring agent is running on, where client metrics will be published via UDP.

  • :client_side_monitoring_port (Integer) — default: 31000

    Required for publishing client metrics. The port that the client side monitoring agent is running on, where client metrics will be published via UDP.

  • :client_side_monitoring_publisher (Aws::ClientSideMonitoring::Publisher) — default: Aws::ClientSideMonitoring::Publisher

    Allows you to provide a custom client-side monitoring publisher class. By default, will use the Client Side Monitoring Agent Publisher.

  • :convert_params (Boolean) — default: true

    When true, an attempt is made to coerce request parameters into the required types.

  • :correct_clock_skew (Boolean) — default: true

    Used only in standard and adaptive retry modes. Specifies whether to apply a clock skew correction and retry requests with skewed client clocks.

  • :defaults_mode (String) — default: "legacy"

    See DefaultsModeConfiguration for a list of the accepted modes and the configuration defaults that are included.

  • :disable_host_prefix_injection (Boolean) — default: false

    Set to true to disable SDK automatically adding host prefix to default service endpoint when available.

  • :disable_request_compression (Boolean) — default: false

    When set to 'true' the request body will not be compressed for supported operations.

  • :endpoint (String)

    The client endpoint is normally constructed from the :region option. You should only configure an :endpoint when connecting to test or custom endpoints. This should be a valid HTTP(S) URI.

  • :endpoint_cache_max_entries (Integer) — default: 1000

    Used for the maximum size limit of the LRU cache storing endpoints data for endpoint discovery enabled operations. Defaults to 1000.

  • :endpoint_cache_max_threads (Integer) — default: 10

    Used for the maximum threads in use for polling endpoints to be cached, defaults to 10.

  • :endpoint_cache_poll_interval (Integer) — default: 60

    When :endpoint_discovery and :active_endpoint_cache is enabled, Use this option to config the time interval in seconds for making requests fetching endpoints information. Defaults to 60 sec.

  • :endpoint_discovery (Boolean) — default: false

    When set to true, endpoint discovery will be enabled for operations when available.

  • :ignore_configured_endpoint_urls (Boolean)

    Setting to true disables use of endpoint URLs provided via environment variables and the shared configuration file.

  • :log_formatter (Aws::Log::Formatter) — default: Aws::Log::Formatter.default

    The log formatter.

  • :log_level (Symbol) — default: :info

    The log level to send messages to the :logger at.

  • :logger (Logger)

    The Logger instance to send log messages to. If this option is not set, logging will be disabled.

  • :max_attempts (Integer) — default: 3

    An integer representing the maximum number attempts that will be made for a single request, including the initial attempt. For example, setting this value to 5 will result in a request being retried up to 4 times. Used in standard and adaptive retry modes.

  • :profile (String) — default: "default"

    Used when loading credentials from the shared credentials file at HOME/.aws/credentials. When not specified, 'default' is used.

  • :request_min_compression_size_bytes (Integer) — default: 10240

    The minimum size in bytes that triggers compression for request bodies. The value must be non-negative integer value between 0 and 10485780 bytes inclusive.

  • :retry_backoff (Proc)

    A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay. This option is only used in the legacy retry mode.

  • :retry_base_delay (Float) — default: 0.3

    The base delay in seconds used by the default backoff function. This option is only used in the legacy retry mode.

  • :retry_jitter (Symbol) — default: :none

    A delay randomiser function used by the default backoff function. Some predefined functions can be referenced by name - :none, :equal, :full, otherwise a Proc that takes and returns a number. This option is only used in the legacy retry mode.

    @see https://www.awsarchitectureblog.com/2015/03/backoff.html

  • :retry_limit (Integer) — default: 3

    The maximum number of times to retry failed requests. Only ~ 500 level server errors and certain ~ 400 level client errors are retried. Generally, these are throttling errors, data checksum errors, networking errors, timeout errors, auth errors, endpoint discovery, and errors from expired credentials. This option is only used in the legacy retry mode.

  • :retry_max_delay (Integer) — default: 0

    The maximum number of seconds to delay between retries (0 for no limit) used by the default backoff function. This option is only used in the legacy retry mode.

  • :retry_mode (String) — default: "legacy"

    Specifies which retry algorithm to use. Values are:

    • legacy - The pre-existing retry behavior. This is default value if no retry mode is provided.

    • standard - A standardized set of retry rules across the AWS SDKs. This includes support for retry quotas, which limit the number of unsuccessful retries a client can make.

    • adaptive - An experimental retry mode that includes all the functionality of standard mode along with automatic client side throttling. This is a provisional mode that may change behavior in the future.

  • :sdk_ua_app_id (String)

    A unique and opaque application ID that is appended to the User-Agent header as app/. It should have a maximum length of 50.

  • :secret_access_key (String)
  • :session_token (String)
  • :simple_json (Boolean) — default: false

    Disables request parameter conversion, validation, and formatting. Also disable response data type conversions. This option is useful when you want to ensure the highest level of performance by avoiding overhead of walking request parameters and response data structures.

    When :simple_json is enabled, the request parameters hash must be formatted exactly as the DynamoDB API expects.

  • :stub_responses (Boolean) — default: false

    Causes the client to return stubbed responses. By default fake responses are generated and returned. You can specify the response data to return or errors to raise by calling ClientStubs#stub_responses. See ClientStubs for more information.

    Please note When response stubbing is enabled, no HTTP requests are made, and retries are disabled.

  • :token_provider (Aws::TokenProvider)

    A Bearer Token Provider. This can be an instance of any one of the following classes:

    • Aws::StaticTokenProvider - Used for configuring static, non-refreshing tokens.

    • Aws::SSOTokenProvider - Used for loading tokens from AWS SSO using an access token generated from aws login.

    When :token_provider is not configured directly, the Aws::TokenProviderChain will be used to search for tokens configured for your profile in shared configuration files.

  • :use_dualstack_endpoint (Boolean)

    When set to true, dualstack enabled endpoints (with .aws TLD) will be used if available.

  • :use_fips_endpoint (Boolean)

    When set to true, fips compatible endpoints will be used if available. When a fips region is used, the region is normalized and this config is set to true.

  • :validate_params (Boolean) — default: true

    When true, request parameters are validated before sending the request.

  • :endpoint_provider (Aws::IdentityStore::EndpointProvider)

    The endpoint provider used to resolve endpoints. Any object that responds to #resolve_endpoint(parameters) where parameters is a Struct similar to Aws::IdentityStore::EndpointParameters

  • :http_proxy (URI::HTTP, String)

    A proxy to send requests through. Formatted like 'http://proxy.com:123'.

  • :http_open_timeout (Float) — default: 15

    The number of seconds to wait when opening a HTTP session before raising a Timeout::Error.

  • :http_read_timeout (Float) — default: 60

    The default number of seconds to wait for response data. This value can safely be set per-request on the session.

  • :http_idle_timeout (Float) — default: 5

    The number of seconds a connection is allowed to sit idle before it is considered stale. Stale connections are closed and removed from the pool before making a request.

  • :http_continue_timeout (Float) — default: 1

    The number of seconds to wait for a 100-continue response before sending the request body. This option has no effect unless the request has "Expect" header set to "100-continue". Defaults to nil which disables this behaviour. This value can safely be set per request on the session.

  • :ssl_timeout (Float) — default: nil

    Sets the SSL timeout in seconds.

  • :http_wire_trace (Boolean) — default: false

    When true, HTTP debug output will be sent to the :logger.

  • :ssl_verify_peer (Boolean) — default: true

    When true, SSL peer certificates are verified when establishing a connection.

  • :ssl_ca_bundle (String)

    Full path to the SSL certificate authority bundle file that should be used when verifying peer certificates. If you do not pass :ssl_ca_bundle or :ssl_ca_directory the the system default will be used if available.

  • :ssl_ca_directory (String)

    Full path of the directory that contains the unbundled SSL certificate authority files for verifying peer certificates. If you do not pass :ssl_ca_bundle or :ssl_ca_directory the the system default will be used if available.



395
396
397
# File 'gems/aws-sdk-identitystore/lib/aws-sdk-identitystore/client.rb', line 395

def initialize(*args)
  super
end

Instance Method Details

#create_group(params = {}) ⇒ Types::CreateGroupResponse

Creates a group within the specified identity store.

Examples:

Request syntax with placeholder values


resp = client.create_group({
  identity_store_id: "IdentityStoreId", # required
  display_name: "GroupDisplayName",
  description: "SensitiveStringType",
})

Response structure


resp.group_id #=> String
resp.identity_store_id #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :identity_store_id (required, String)

    The globally unique identifier for the identity store.

  • :display_name (String)

    A string containing the name of the group. This value is commonly displayed when the group is referenced. Administrator and AWSAdministrators are reserved names and can't be used for users or groups.

  • :description (String)

    A string containing the description of the group.

Returns:

See Also:



437
438
439
440
# File 'gems/aws-sdk-identitystore/lib/aws-sdk-identitystore/client.rb', line 437

def create_group(params = {}, options = {})
  req = build_request(:create_group, params)
  req.send_request(options)
end

#create_group_membership(params = {}) ⇒ Types::CreateGroupMembershipResponse

Creates a relationship between a member and a group. The following identifiers must be specified: GroupId, IdentityStoreId, and MemberId.

Examples:

Request syntax with placeholder values


resp = client.create_group_membership({
  identity_store_id: "IdentityStoreId", # required
  group_id: "ResourceId", # required
  member_id: { # required
    user_id: "ResourceId",
  },
})

Response structure


resp.membership_id #=> String
resp.identity_store_id #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :identity_store_id (required, String)

    The globally unique identifier for the identity store.

  • :group_id (required, String)

    The identifier for a group in the identity store.

  • :member_id (required, Types::MemberId)

    An object that contains the identifier of a group member. Setting the UserID field to the specific identifier for a user indicates that the user is a member of the group.

Returns:

See Also:



481
482
483
484
# File 'gems/aws-sdk-identitystore/lib/aws-sdk-identitystore/client.rb', line 481

def create_group_membership(params = {}, options = {})
  req = build_request(:create_group_membership, params)
  req.send_request(options)
end

#create_user(params = {}) ⇒ Types::CreateUserResponse

Creates a user within the specified identity store.

Examples:

Request syntax with placeholder values


resp = client.create_user({
  identity_store_id: "IdentityStoreId", # required
  user_name: "UserName",
  name: {
    formatted: "SensitiveStringType",
    family_name: "SensitiveStringType",
    given_name: "SensitiveStringType",
    middle_name: "SensitiveStringType",
    honorific_prefix: "SensitiveStringType",
    honorific_suffix: "SensitiveStringType",
  },
  display_name: "SensitiveStringType",
  nick_name: "SensitiveStringType",
  profile_url: "SensitiveStringType",
  emails: [
    {
      value: "SensitiveStringType",
      type: "SensitiveStringType",
      primary: false,
    },
  ],
  addresses: [
    {
      street_address: "SensitiveStringType",
      locality: "SensitiveStringType",
      region: "SensitiveStringType",
      postal_code: "SensitiveStringType",
      country: "SensitiveStringType",
      formatted: "SensitiveStringType",
      type: "SensitiveStringType",
      primary: false,
    },
  ],
  phone_numbers: [
    {
      value: "SensitiveStringType",
      type: "SensitiveStringType",
      primary: false,
    },
  ],
  user_type: "SensitiveStringType",
  title: "SensitiveStringType",
  preferred_language: "SensitiveStringType",
  locale: "SensitiveStringType",
  timezone: "SensitiveStringType",
})

Response structure


resp.user_id #=> String
resp.identity_store_id #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :identity_store_id (required, String)

    The globally unique identifier for the identity store.

  • :user_name (String)

    A unique string used to identify the user. The length limit is 128 characters. This value can consist of letters, accented characters, symbols, numbers, and punctuation. This value is specified at the time the user is created and stored as an attribute of the user object in the identity store. Administrator and AWSAdministrators are reserved names and can't be used for users or groups.

  • :name (Types::Name)

    An object containing the name of the user.

  • :display_name (String)

    A string containing the name of the user. This value is typically formatted for display when the user is referenced. For example, "John Doe."

  • :nick_name (String)

    A string containing an alternate name for the user.

  • :profile_url (String)

    A string containing a URL that might be associated with the user.

  • :emails (Array<Types::Email>)

    A list of Email objects containing email addresses associated with the user.

  • :addresses (Array<Types::Address>)

    A list of Address objects containing addresses associated with the user.

  • :phone_numbers (Array<Types::PhoneNumber>)

    A list of PhoneNumber objects containing phone numbers associated with the user.

  • :user_type (String)

    A string indicating the type of user. Possible values are left unspecified. The value can vary based on your specific use case.

  • :title (String)

    A string containing the title of the user. Possible values are left unspecified. The value can vary based on your specific use case.

  • :preferred_language (String)

    A string containing the preferred language of the user. For example, "American English" or "en-us."

  • :locale (String)

    A string containing the geographical region or location of the user.

  • :timezone (String)

    A string containing the time zone of the user.

Returns:

See Also:



606
607
608
609
# File 'gems/aws-sdk-identitystore/lib/aws-sdk-identitystore/client.rb', line 606

def create_user(params = {}, options = {})
  req = build_request(:create_user, params)
  req.send_request(options)
end

#delete_group(params = {}) ⇒ Struct

Delete a group within an identity store given GroupId.

Examples:

Request syntax with placeholder values


resp = client.delete_group({
  identity_store_id: "IdentityStoreId", # required
  group_id: "ResourceId", # required
})

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :identity_store_id (required, String)

    The globally unique identifier for the identity store.

  • :group_id (required, String)

    The identifier for a group in the identity store.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



632
633
634
635
# File 'gems/aws-sdk-identitystore/lib/aws-sdk-identitystore/client.rb', line 632

def delete_group(params = {}, options = {})
  req = build_request(:delete_group, params)
  req.send_request(options)
end

#delete_group_membership(params = {}) ⇒ Struct

Delete a membership within a group given MembershipId.

Examples:

Request syntax with placeholder values


resp = client.delete_group_membership({
  identity_store_id: "IdentityStoreId", # required
  membership_id: "ResourceId", # required
})

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :identity_store_id (required, String)

    The globally unique identifier for the identity store.

  • :membership_id (required, String)

    The identifier for a GroupMembership in an identity store.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



658
659
660
661
# File 'gems/aws-sdk-identitystore/lib/aws-sdk-identitystore/client.rb', line 658

def delete_group_membership(params = {}, options = {})
  req = build_request(:delete_group_membership, params)
  req.send_request(options)
end

#delete_user(params = {}) ⇒ Struct

Deletes a user within an identity store given UserId.

Examples:

Request syntax with placeholder values


resp = client.delete_user({
  identity_store_id: "IdentityStoreId", # required
  user_id: "ResourceId", # required
})

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :identity_store_id (required, String)

    The globally unique identifier for the identity store.

  • :user_id (required, String)

    The identifier for a user in the identity store.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



684
685
686
687
# File 'gems/aws-sdk-identitystore/lib/aws-sdk-identitystore/client.rb', line 684

def delete_user(params = {}, options = {})
  req = build_request(:delete_user, params)
  req.send_request(options)
end

#describe_group(params = {}) ⇒ Types::DescribeGroupResponse

Retrieves the group metadata and attributes from GroupId in an identity store.

If you have administrator access to a member account, you can use this API from the member account. Read about member accounts in the Organizations User Guide.

Examples:

Request syntax with placeholder values


resp = client.describe_group({
  identity_store_id: "IdentityStoreId", # required
  group_id: "ResourceId", # required
})

Response structure


resp.group_id #=> String
resp.display_name #=> String
resp.external_ids #=> Array
resp.external_ids[0].issuer #=> String
resp.external_ids[0].id #=> String
resp.description #=> String
resp.identity_store_id #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :identity_store_id (required, String)

    The globally unique identifier for the identity store, such as d-1234567890. In this example, d- is a fixed prefix, and 1234567890 is a randomly generated string that contains numbers and lower case letters. This value is generated at the time that a new identity store is created.

  • :group_id (required, String)

    The identifier for a group in the identity store.

Returns:

See Also:



741
742
743
744
# File 'gems/aws-sdk-identitystore/lib/aws-sdk-identitystore/client.rb', line 741

def describe_group(params = {}, options = {})
  req = build_request(:describe_group, params)
  req.send_request(options)
end

#describe_group_membership(params = {}) ⇒ Types::DescribeGroupMembershipResponse

Retrieves membership metadata and attributes from MembershipId in an identity store.

If you have administrator access to a member account, you can use this API from the member account. Read about member accounts in the Organizations User Guide.

Examples:

Request syntax with placeholder values


resp = client.describe_group_membership({
  identity_store_id: "IdentityStoreId", # required
  membership_id: "ResourceId", # required
})

Response structure


resp.identity_store_id #=> String
resp.membership_id #=> String
resp.group_id #=> String
resp.member_id.user_id #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :identity_store_id (required, String)

    The globally unique identifier for the identity store.

  • :membership_id (required, String)

    The identifier for a GroupMembership in an identity store.

Returns:

See Also:



790
791
792
793
# File 'gems/aws-sdk-identitystore/lib/aws-sdk-identitystore/client.rb', line 790

def describe_group_membership(params = {}, options = {})
  req = build_request(:describe_group_membership, params)
  req.send_request(options)
end

#describe_user(params = {}) ⇒ Types::DescribeUserResponse

Retrieves the user metadata and attributes from the UserId in an identity store.

If you have administrator access to a member account, you can use this API from the member account. Read about member accounts in the Organizations User Guide.

Examples:

Request syntax with placeholder values


resp = client.describe_user({
  identity_store_id: "IdentityStoreId", # required
  user_id: "ResourceId", # required
})

Response structure


resp.user_name #=> String
resp.user_id #=> String
resp.external_ids #=> Array
resp.external_ids[0].issuer #=> String
resp.external_ids[0].id #=> String
resp.name.formatted #=> String
resp.name.family_name #=> String
resp.name.given_name #=> String
resp.name.middle_name #=> String
resp.name.honorific_prefix #=> String
resp.name.honorific_suffix #=> String
resp.display_name #=> String
resp.nick_name #=> String
resp.profile_url #=> String
resp.emails #=> Array
resp.emails[0].value #=> String
resp.emails[0].type #=> String
resp.emails[0].primary #=> Boolean
resp.addresses #=> Array
resp.addresses[0].street_address #=> String
resp.addresses[0].locality #=> String
resp.addresses[0].region #=> String
resp.addresses[0].postal_code #=> String
resp.addresses[0].country #=> String
resp.addresses[0].formatted #=> String
resp.addresses[0].type #=> String
resp.addresses[0].primary #=> Boolean
resp.phone_numbers #=> Array
resp.phone_numbers[0].value #=> String
resp.phone_numbers[0].type #=> String
resp.phone_numbers[0].primary #=> Boolean
resp.user_type #=> String
resp.title #=> String
resp.preferred_language #=> String
resp.locale #=> String
resp.timezone #=> String
resp.identity_store_id #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :identity_store_id (required, String)

    The globally unique identifier for the identity store, such as d-1234567890. In this example, d- is a fixed prefix, and 1234567890 is a randomly generated string that contains numbers and lower case letters. This value is generated at the time that a new identity store is created.

  • :user_id (required, String)

    The identifier for a user in the identity store.

Returns:

See Also:



888
889
890
891
# File 'gems/aws-sdk-identitystore/lib/aws-sdk-identitystore/client.rb', line 888

def describe_user(params = {}, options = {})
  req = build_request(:describe_user, params)
  req.send_request(options)
end

#get_group_id(params = {}) ⇒ Types::GetGroupIdResponse

Retrieves GroupId in an identity store.

If you have administrator access to a member account, you can use this API from the member account. Read about member accounts in the Organizations User Guide.

Examples:

Request syntax with placeholder values


resp = client.get_group_id({
  identity_store_id: "IdentityStoreId", # required
  alternate_identifier: { # required
    external_id: {
      issuer: "ExternalIdIssuer", # required
      id: "ExternalIdIdentifier", # required
    },
    unique_attribute: {
      attribute_path: "AttributePath", # required
      attribute_value: "value", # required, value <Hash,Array,String,Numeric,Boolean,IO,Set,nil>
    },
  },
})

Response structure


resp.group_id #=> String
resp.identity_store_id #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :identity_store_id (required, String)

    The globally unique identifier for the identity store.

  • :alternate_identifier (required, Types::AlternateIdentifier)

    A unique identifier for a user or group that is not the primary identifier. This value can be an identifier from an external identity provider (IdP) that is associated with the user, the group, or a unique attribute. For the unique attribute, the only valid path is displayName.

Returns:

See Also:



945
946
947
948
# File 'gems/aws-sdk-identitystore/lib/aws-sdk-identitystore/client.rb', line 945

def get_group_id(params = {}, options = {})
  req = build_request(:get_group_id, params)
  req.send_request(options)
end

#get_group_membership_id(params = {}) ⇒ Types::GetGroupMembershipIdResponse

Retrieves the MembershipId in an identity store.

If you have administrator access to a member account, you can use this API from the member account. Read about member accounts in the Organizations User Guide.

Examples:

Request syntax with placeholder values


resp = client.get_group_membership_id({
  identity_store_id: "IdentityStoreId", # required
  group_id: "ResourceId", # required
  member_id: { # required
    user_id: "ResourceId",
  },
})

Response structure


resp.membership_id #=> String
resp.identity_store_id #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :identity_store_id (required, String)

    The globally unique identifier for the identity store.

  • :group_id (required, String)

    The identifier for a group in the identity store.

  • :member_id (required, Types::MemberId)

    An object that contains the identifier of a group member. Setting the UserID field to the specific identifier for a user indicates that the user is a member of the group.

Returns:

See Also:



997
998
999
1000
# File 'gems/aws-sdk-identitystore/lib/aws-sdk-identitystore/client.rb', line 997

def get_group_membership_id(params = {}, options = {})
  req = build_request(:get_group_membership_id, params)
  req.send_request(options)
end

#get_user_id(params = {}) ⇒ Types::GetUserIdResponse

Retrieves the UserId in an identity store.

If you have administrator access to a member account, you can use this API from the member account. Read about member accounts in the Organizations User Guide.

Examples:

Request syntax with placeholder values


resp = client.get_user_id({
  identity_store_id: "IdentityStoreId", # required
  alternate_identifier: { # required
    external_id: {
      issuer: "ExternalIdIssuer", # required
      id: "ExternalIdIdentifier", # required
    },
    unique_attribute: {
      attribute_path: "AttributePath", # required
      attribute_value: "value", # required, value <Hash,Array,String,Numeric,Boolean,IO,Set,nil>
    },
  },
})

Response structure


resp.user_id #=> String
resp.identity_store_id #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :identity_store_id (required, String)

    The globally unique identifier for the identity store.

  • :alternate_identifier (required, Types::AlternateIdentifier)

    A unique identifier for a user or group that is not the primary identifier. This value can be an identifier from an external identity provider (IdP) that is associated with the user, the group, or a unique attribute. For the unique attribute, the only valid paths are userName and emails.value.

Returns:

See Also:



1054
1055
1056
1057
# File 'gems/aws-sdk-identitystore/lib/aws-sdk-identitystore/client.rb', line 1054

def get_user_id(params = {}, options = {})
  req = build_request(:get_user_id, params)
  req.send_request(options)
end

#is_member_in_groups(params = {}) ⇒ Types::IsMemberInGroupsResponse

Checks the user's membership in all requested groups and returns if the member exists in all queried groups.

If you have administrator access to a member account, you can use this API from the member account. Read about member accounts in the Organizations User Guide.

Examples:

Request syntax with placeholder values


resp = client.is_member_in_groups({
  identity_store_id: "IdentityStoreId", # required
  member_id: { # required
    user_id: "ResourceId",
  },
  group_ids: ["ResourceId"], # required
})

Response structure


resp.results #=> Array
resp.results[0].group_id #=> String
resp.results[0].member_id.user_id #=> String
resp.results[0].membership_exists #=> Boolean

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :identity_store_id (required, String)

    The globally unique identifier for the identity store.

  • :member_id (required, Types::MemberId)

    An object containing the identifier of a group member.

  • :group_ids (required, Array<String>)

    A list of identifiers for groups in the identity store.

Returns:

See Also:



1106
1107
1108
1109
# File 'gems/aws-sdk-identitystore/lib/aws-sdk-identitystore/client.rb', line 1106

def is_member_in_groups(params = {}, options = {})
  req = build_request(:is_member_in_groups, params)
  req.send_request(options)
end

#list_group_memberships(params = {}) ⇒ Types::ListGroupMembershipsResponse

For the specified group in the specified identity store, returns the list of all GroupMembership objects and returns results in paginated form.

If you have administrator access to a member account, you can use this API from the member account. Read about member accounts in the Organizations User Guide.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_group_memberships({
  identity_store_id: "IdentityStoreId", # required
  group_id: "ResourceId", # required
  max_results: 1,
  next_token: "NextToken",
})

Response structure


resp.group_memberships #=> Array
resp.group_memberships[0].identity_store_id #=> String
resp.group_memberships[0].membership_id #=> String
resp.group_memberships[0].group_id #=> String
resp.group_memberships[0].member_id.user_id #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :identity_store_id (required, String)

    The globally unique identifier for the identity store.

  • :group_id (required, String)

    The identifier for a group in the identity store.

  • :max_results (Integer)

    The maximum number of results to be returned per request. This parameter is used in all List requests to specify how many results to return in one page.

  • :next_token (String)

    The pagination token used for the ListUsers, ListGroups and ListGroupMemberships API operations. This value is generated by the identity store service. It is returned in the API response if the total results are more than the size of one page. This token is also returned when it is used in the API request to search for the next page.

Returns:

See Also:



1173
1174
1175
1176
# File 'gems/aws-sdk-identitystore/lib/aws-sdk-identitystore/client.rb', line 1173

def list_group_memberships(params = {}, options = {})
  req = build_request(:list_group_memberships, params)
  req.send_request(options)
end

#list_group_memberships_for_member(params = {}) ⇒ Types::ListGroupMembershipsForMemberResponse

For the specified member in the specified identity store, returns the list of all GroupMembership objects and returns results in paginated form.

If you have administrator access to a member account, you can use this API from the member account. Read about member accounts in the Organizations User Guide.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_group_memberships_for_member({
  identity_store_id: "IdentityStoreId", # required
  member_id: { # required
    user_id: "ResourceId",
  },
  max_results: 1,
  next_token: "NextToken",
})

Response structure


resp.group_memberships #=> Array
resp.group_memberships[0].identity_store_id #=> String
resp.group_memberships[0].membership_id #=> String
resp.group_memberships[0].group_id #=> String
resp.group_memberships[0].member_id.user_id #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :identity_store_id (required, String)

    The globally unique identifier for the identity store.

  • :member_id (required, Types::MemberId)

    An object that contains the identifier of a group member. Setting the UserID field to the specific identifier for a user indicates that the user is a member of the group.

  • :max_results (Integer)

    The maximum number of results to be returned per request. This parameter is used in the ListUsers and ListGroups requests to specify how many results to return in one page. The length limit is 50 characters.

  • :next_token (String)

    The pagination token used for the ListUsers, ListGroups, and ListGroupMemberships API operations. This value is generated by the identity store service. It is returned in the API response if the total results are more than the size of one page. This token is also returned when it is used in the API request to search for the next page.

Returns:

See Also:



1245
1246
1247
1248
# File 'gems/aws-sdk-identitystore/lib/aws-sdk-identitystore/client.rb', line 1245

def list_group_memberships_for_member(params = {}, options = {})
  req = build_request(:list_group_memberships_for_member, params)
  req.send_request(options)
end

#list_groups(params = {}) ⇒ Types::ListGroupsResponse

Lists all groups in the identity store. Returns a paginated list of complete Group objects. Filtering for a Group by the DisplayName attribute is deprecated. Instead, use the GetGroupId API action.

If you have administrator access to a member account, you can use this API from the member account. Read about member accounts in the Organizations User Guide.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_groups({
  identity_store_id: "IdentityStoreId", # required
  max_results: 1,
  next_token: "NextToken",
  filters: [
    {
      attribute_path: "AttributePath", # required
      attribute_value: "SensitiveStringType", # required
    },
  ],
})

Response structure


resp.groups #=> Array
resp.groups[0].group_id #=> String
resp.groups[0].display_name #=> String
resp.groups[0].external_ids #=> Array
resp.groups[0].external_ids[0].issuer #=> String
resp.groups[0].external_ids[0].id #=> String
resp.groups[0].description #=> String
resp.groups[0].identity_store_id #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :identity_store_id (required, String)

    The globally unique identifier for the identity store, such as d-1234567890. In this example, d- is a fixed prefix, and 1234567890 is a randomly generated string that contains numbers and lower case letters. This value is generated at the time that a new identity store is created.

  • :max_results (Integer)

    The maximum number of results to be returned per request. This parameter is used in the ListUsers and ListGroups requests to specify how many results to return in one page. The length limit is 50 characters.

  • :next_token (String)

    The pagination token used for the ListUsers and ListGroups API operations. This value is generated by the identity store service. It is returned in the API response if the total results are more than the size of one page. This token is also returned when it is used in the API request to search for the next page.

  • :filters (Array<Types::Filter>)

    A list of Filter objects, which is used in the ListUsers and ListGroups requests.

Returns:

See Also:



1325
1326
1327
1328
# File 'gems/aws-sdk-identitystore/lib/aws-sdk-identitystore/client.rb', line 1325

def list_groups(params = {}, options = {})
  req = build_request(:list_groups, params)
  req.send_request(options)
end

#list_users(params = {}) ⇒ Types::ListUsersResponse

Lists all users in the identity store. Returns a paginated list of complete User objects. Filtering for a User by the UserName attribute is deprecated. Instead, use the GetUserId API action.

If you have administrator access to a member account, you can use this API from the member account. Read about member accounts in the Organizations User Guide.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_users({
  identity_store_id: "IdentityStoreId", # required
  max_results: 1,
  next_token: "NextToken",
  filters: [
    {
      attribute_path: "AttributePath", # required
      attribute_value: "SensitiveStringType", # required
    },
  ],
})

Response structure


resp.users #=> Array
resp.users[0].user_name #=> String
resp.users[0].user_id #=> String
resp.users[0].external_ids #=> Array
resp.users[0].external_ids[0].issuer #=> String
resp.users[0].external_ids[0].id #=> String
resp.users[0].name.formatted #=> String
resp.users[0].name.family_name #=> String
resp.users[0].name.given_name #=> String
resp.users[0].name.middle_name #=> String
resp.users[0].name.honorific_prefix #=> String
resp.users[0].name.honorific_suffix #=> String
resp.users[0].display_name #=> String
resp.users[0].nick_name #=> String
resp.users[0].profile_url #=> String
resp.users[0].emails #=> Array
resp.users[0].emails[0].value #=> String
resp.users[0].emails[0].type #=> String
resp.users[0].emails[0].primary #=> Boolean
resp.users[0].addresses #=> Array
resp.users[0].addresses[0].street_address #=> String
resp.users[0].addresses[0].locality #=> String
resp.users[0].addresses[0].region #=> String
resp.users[0].addresses[0].postal_code #=> String
resp.users[0].addresses[0].country #=> String
resp.users[0].addresses[0].formatted #=> String
resp.users[0].addresses[0].type #=> String
resp.users[0].addresses[0].primary #=> Boolean
resp.users[0].phone_numbers #=> Array
resp.users[0].phone_numbers[0].value #=> String
resp.users[0].phone_numbers[0].type #=> String
resp.users[0].phone_numbers[0].primary #=> Boolean
resp.users[0].user_type #=> String
resp.users[0].title #=> String
resp.users[0].preferred_language #=> String
resp.users[0].locale #=> String
resp.users[0].timezone #=> String
resp.users[0].identity_store_id #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :identity_store_id (required, String)

    The globally unique identifier for the identity store, such as d-1234567890. In this example, d- is a fixed prefix, and 1234567890 is a randomly generated string that contains numbers and lower case letters. This value is generated at the time that a new identity store is created.

  • :max_results (Integer)

    The maximum number of results to be returned per request. This parameter is used in the ListUsers and ListGroups requests to specify how many results to return in one page. The length limit is 50 characters.

  • :next_token (String)

    The pagination token used for the ListUsers and ListGroups API operations. This value is generated by the identity store service. It is returned in the API response if the total results are more than the size of one page. This token is also returned when it is used in the API request to search for the next page.

  • :filters (Array<Types::Filter>)

    A list of Filter objects, which is used in the ListUsers and ListGroups requests.

Returns:

See Also:



1435
1436
1437
1438
# File 'gems/aws-sdk-identitystore/lib/aws-sdk-identitystore/client.rb', line 1435

def list_users(params = {}, options = {})
  req = build_request(:list_users, params)
  req.send_request(options)
end

#update_group(params = {}) ⇒ Struct

For the specified group in the specified identity store, updates the group metadata and attributes.

Examples:

Request syntax with placeholder values


resp = client.update_group({
  identity_store_id: "IdentityStoreId", # required
  group_id: "ResourceId", # required
  operations: [ # required
    {
      attribute_path: "AttributePath", # required
      attribute_value: "value", # value <Hash,Array,String,Numeric,Boolean,IO,Set,nil>
    },
  ],
})

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :identity_store_id (required, String)

    The globally unique identifier for the identity store.

  • :group_id (required, String)

    The identifier for a group in the identity store.

  • :operations (required, Array<Types::AttributeOperation>)

    A list of AttributeOperation objects to apply to the requested group. These operations might add, replace, or remove an attribute.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



1472
1473
1474
1475
# File 'gems/aws-sdk-identitystore/lib/aws-sdk-identitystore/client.rb', line 1472

def update_group(params = {}, options = {})
  req = build_request(:update_group, params)
  req.send_request(options)
end

#update_user(params = {}) ⇒ Struct

For the specified user in the specified identity store, updates the user metadata and attributes.

Examples:

Request syntax with placeholder values


resp = client.update_user({
  identity_store_id: "IdentityStoreId", # required
  user_id: "ResourceId", # required
  operations: [ # required
    {
      attribute_path: "AttributePath", # required
      attribute_value: "value", # value <Hash,Array,String,Numeric,Boolean,IO,Set,nil>
    },
  ],
})

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :identity_store_id (required, String)

    The globally unique identifier for the identity store.

  • :user_id (required, String)

    The identifier for a user in the identity store.

  • :operations (required, Array<Types::AttributeOperation>)

    A list of AttributeOperation objects to apply to the requested user. These operations might add, replace, or remove an attribute.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



1509
1510
1511
1512
# File 'gems/aws-sdk-identitystore/lib/aws-sdk-identitystore/client.rb', line 1509

def update_user(params = {}, options = {})
  req = build_request(:update_user, params)
  req.send_request(options)
end