Object Reference for Salesforce and Force.com

Clouds with binary code floating aboveCloud with binary code floating above

No Results

Search Tips:

  • Please consider misspellings
  • Try different search keywords
PDF

Newer Version Available

This content describes an older version of this product. View Latest

ThirdPartyAccountLink

Represents the list of external users who authenticated using an Auth. Provider.

A list of third-party account links is generated when users of an organization authenticate using an external Auth. Provider. Use this object to list and revoke a given user's social sign-on connections (such as Facebook©). This object is available in API version 32.0 and later.

Supported Calls

describeSObjects(), query()

Fields

Field Name Details
Handle
Type
string
Properties
Filter, Nillable, Sort
Description
The username in the third-party system.
IsNotSsoUsable
Type
boolean
Properties
Defaulted on create, Filter, Group, Sort
Description
Support for single sign-on.

If true, the link cannot be used for a single sign-on flow. It is only available OAuth access and refresh tokens.
Provider
Type
string
Properties
Filter, Group, Nillable, Sort
Description
The third-party account provider name.
RemoteIdentifier
Type
string
Properties
Filter, Group, Nillable, Sort
Description
The unique ID for the user in the third-party system.
SsoProvider
Type
AuthProvider
Properties
Filter, Group, Nillable, Sort
Description
The foreign key to the AuthProvider of the third-party system.
SsoProviderId
Type
reference
Properties
Filter, Group, Nillable, Sort
Description
The ID associated with the SsoProvider value.
SsoProviderName
Type
string
Properties
Filter, Group, Nillable, Sort
Description
The name associated with the AuthProvider of the third-party system, in case the user has no access to the provider foreign key (the SsoProvider value).
ThirdPartyAccountLinkKey
Type
string
Properties
Filter, Group, Nillable, Sort
Description
A concatenated string including the organization ID, the SsoProviderId value, the SsoProvider value, and the RemoteIdentifier value.
UserId
Type
reference
Properties
Filter, Group, Nillable, Sort
Description
The Salesforceuser associated with this third-party account link.

Usage

Use this object makes to build custom screens to manage a user’s third-party account links.

Administrators (with the “Manage Users” permission) querying this object can see all the links for all users in the organization. Without the “Manage Users” permission, users can only retrieve thier own links. A user may not have access to the SsoProvider value (the foreign key). In this case, use the SsoProviderName to render the name of the provider for the associated link.

Use the Apex method Auth.AuthToken.revokeAccess() to revoke a link.