IdentityStore / Client / update_identity_store

update_identity_store

IdentityStore.Client.update_identity_store(**kwargs)

Updates the configuration of the specified identity store, including its network configuration.

See also: AWS API Documentation

Request Syntax

response = client.update_identity_store(
    IdentityStoreId='string',
    NetworkConfiguration={
        'VpceAccessRequired': True|False,
        'ApiRestrictSourceVpcs': [
            'string',
        ],
        'ApiAllowSourceIps': [
            'string',
        ],
        'ScimAllowSourceIps': [
            'string',
        ]
    }
)

Parameters:

• IdentityStoreId (string) –

  [REQUIRED]

  The globally unique identifier for the identity store.

  You can specify the identity store by ID or by Amazon Resource Name (ARN). For example, identity store ID d-1234567890 or identity store ARN arn:aws:identitystore::111122223333:identitystore/d-1234567890.

• NetworkConfiguration (dict) –

  The network configuration to apply to the identity store. This controls whether access through a virtual private cloud (VPC) endpoint is required and the source VPCs and IP addresses that are allowed to access the identity store.

  When you provide NetworkConfiguration in a request, the service performs a full replacement of the identity store’s current network configuration with the values you specify. Any values that you omit are cleared. To preserve or change the allowed source VPCs or IP address ranges, include the complete set of values that you want in the request. To clear a list, omit it; an empty list is not accepted.

  • VpceAccessRequired (boolean) – [REQUIRED]

    Specifies whether the identity store can be accessed only through a virtual private cloud (VPC) endpoint. When set to true, requests must originate from a VPC endpoint.

    This value must be set to either true or false when you provide NetworkConfiguration in a request.

  • ApiRestrictSourceVpcs (list) –

    A list of virtual private cloud (VPC) IDs that are allowed to access the identity store API operations. A request is denied unless it originates from a VPC in this list, or from an IP address in ApiAllowSourceIps if you specified one. If you don’t specify a value, access isn’t restricted to specific VPCs, but the VPC endpoint requirement set by VpceAccessRequired still applies.

    • (string) –

  • ApiAllowSourceIps (list) –

    A list of IP address CIDR ranges that are allowed to access the identity store API operations. A request from an IP address in this list bypasses the identity store’s other API network controls: it’s permitted even if it doesn’t come through a VPC endpoint required by VpceAccessRequired, and even if it doesn’t originate from a VPC in ApiRestrictSourceVpcs. If you don’t specify a value, no such IP address exception applies.

    • (string) –

  • ScimAllowSourceIps (list) –

    A list of IP address CIDR ranges that are allowed to access the identity store through the System for Cross-domain Identity Management (SCIM) protocol. Requests from IP addresses outside these ranges are denied. If you don’t specify a value, SCIM requests remain subject to the identity store’s other network controls, such as the VPC endpoint requirement set by VpceAccessRequired.

    For example, to allow SCIM traffic from the public internet while still requiring the identity store API operations to be accessed through a VPC endpoint, set VpceAccessRequired to true and set this value to 0.0.0.0/0.

    • (string) –

Return type:

dict

Returns:

Response Syntax

{
    'IdentityStoreId': 'string',
    'IdentityStoreArn': 'string'
}

Response Structure

• (dict) –

  • IdentityStoreId (string) –

    The globally unique identifier for the identity store.

  • IdentityStoreArn (string) –

    The Amazon Resource Name (ARN) of the identity store. For example, arn:aws:identitystore::111122223333:identitystore/d-1234567890.

Exceptions

• IdentityStore.Client.exceptions.ResourceNotFoundException

• IdentityStore.Client.exceptions.ThrottlingException

• IdentityStore.Client.exceptions.AccessDeniedException

• IdentityStore.Client.exceptions.ConflictException

• IdentityStore.Client.exceptions.InternalServerException

• IdentityStore.Client.exceptions.ValidationException