Unlink Identity

cognitoidentity_unlink_identity

R Documentation

Unlinks a federated identity from an existing account¶

Description¶

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.

Usage¶

cognitoidentity_unlink_identity(IdentityId, Logins, LoginsToRemove)

Arguments¶

IdentityId

[required] A unique identifier in the format REGION:GUID.

Logins

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

LoginsToRemove

[required] Provider names to unlink from this identity.

Value¶

An empty list.

Request syntax¶

svc$unlink_identity(
  IdentityId = "string",
  Logins = list(
    "string"
  ),
  LoginsToRemove = list(
    "string"
  )
)