Skip to content

Cognito Identity  >  Operations  >  unlink_identity

unlink_identity

Operation

unlink_identity(input: UnlinkIdentityInput, plugins: list[Plugin] | None = None) -> UnlinkIdentityOutput

Unlinks a federated identity from an existing account. Unlinked logins will be considered new identities next time they are seen. Removing the last linked login will make this identity inaccessible.

This is a public API. You do not need any credentials to call this API.

Parameters:

Name Type Description Default
input UnlinkIdentityInput

An instance of UnlinkIdentityInput.

 required
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

 None

Returns:

Type Description
UnlinkIdentityOutput

An instance of UnlinkIdentityOutput.

Input

UnlinkIdentityInput dataclass

Input to the UnlinkIdentity action.

Attributes

identity_id class-attribute instance-attribute 
identity_id: str | None = None

A unique identifier in the format REGION:GUID.

logins class-attribute instance-attribute 
logins: dict[str, str] | None = None

A set of optional name-value pairs that map provider names to provider tokens.

logins_to_remove class-attribute instance-attribute 
logins_to_remove: list[str] | None = None

Provider names to unlink from this identity.

Output

UnlinkIdentityOutput dataclass

Dataclass for UnlinkIdentityOutput structure.