IdentityStore / Client / get_user_id

get_user_id¶

IdentityStore.Client.get_user_id(**kwargs)¶

Retrieves the UserId in an identity store.

Note

If you have access to a member account, you can use this API operation from the member account. For more information, see Limiting access to the identity store from member accounts in the IAM Identity Center User Guide.

Request Syntax

response = client.get_user_id(
    IdentityStoreId='string',
    AlternateIdentifier={
        'ExternalId': {
            'Issuer': 'string',
            'Id': 'string'
        },
        'UniqueAttribute': {
            'AttributePath': 'string',
            'AttributeValue': {...}|[...]|123|123.4|'string'|True|None
        }
    }
)

Parameters:

IdentityStoreId (string) –
[REQUIRED]

The globally unique identifier for the identity store.
AlternateIdentifier (dict) –
[REQUIRED]

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.

Note
This is a Tagged Union structure. Only one of the following top level keys can be set: ExternalId, UniqueAttribute.
- ExternalId (dict) –
  
  The identifier issued to this resource by an external identity provider.
  - Issuer (string) – [REQUIRED]
    
    The issuer for an external identifier.
  - Id (string) – [REQUIRED]
    
    The identifier issued to this resource by an external identity provider.
- UniqueAttribute (dict) –
  
  An entity attribute that’s unique to a specific entity.
  - AttributePath (string) – [REQUIRED]
    
    A string representation of the path to a given attribute or sub-attribute. Supports JMESPath.
  - AttributeValue (document) – [REQUIRED]
    
    The value of the attribute. This is a Document type. This type is not supported by Java V1, Go V1, and older versions of the CLI.

Return type:

dict

Returns:

Response Syntax

{
    'IdentityStoreId': 'string',
    'UserId': 'string'
}

Response Structure

(dict) –
- IdentityStoreId (string) –
  
  The globally unique identifier for the identity store.
- UserId (string) –
  
  The identifier for a user in the identity store.

Exceptions

IdentityStore.Client.exceptions.ResourceNotFoundException
IdentityStore.Client.exceptions.ThrottlingException
IdentityStore.Client.exceptions.AccessDeniedException
IdentityStore.Client.exceptions.InternalServerException
IdentityStore.Client.exceptions.ValidationException