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

AuthConfig

Represents authentication options for a communityor custom domain that was created by using My Domain.
The fields for this object control the login options that show up on the login page for users of a community or custom domain.
  • Logging in with a username and password
  • Using SAML for single sign-on
  • Authentication provider logins from a third-party service, such as Facebook or Twitter
This object is available in API version 32.0 and later.

Supported Calls

describeSObjects(), query(), retrieve()

Special Access Rules

You must have “View Setup and Configuration” permission to view the settings.

Fields

Field Name Details
AuthOptionsAuthProvider
Type
boolean
Properties
Filter
Description

If true, at least one Auth. Provider is selected to show up on the login page, and this object has child AuthConfigProvider objects for each provider.
AuthOptionsSaml
Type
boolean
Properties
Filter
Description

If true, at least one SAML configuration is selected to show up on the login page. If the organization has only one SAML configuration, this value indicates whether that configuration is selected to show up on the login page. If the organization has multiple SAML configurations, see the child AuthConfigProvider objects for each configuration.
AuthOptionsUsernamePassword
Type
boolean
Properties
Filter
Description

If true, the login option for a username and password appears on the login page.
DeveloperName
Type
string
Properties
Filter, Group, Sort
Description
The name of the domain created using My Domain or, for communities, a concatenated string of community name_community prefix.
IsActive
Type
boolean
Properties
Defaulted on create, Filter, Group, Sort
Description

Whether this configuration is in use.
Language
Type
picklist
Properties
Filter, Group, Restricted picklist, Sort
Description

The language for the organization.
MasterLabel
Type
string
Properties
Filter, Group, Sort
Description
The text that’s used to identify the Visualforce page in Setup.
NamespacePrefix
Type
string
Properties
Filter, Group, Sort
Description
The namespace prefix associated with this object. Each Developer Edition organization that creates a managed package has a unique namespace prefix. Limit: 15 characters. You can refer to a component in a managed package by using the namespacePrefix__componentName notation.

The namespace prefix can have one of the following values:

  • In Developer Edition organizations, the namespace prefix is set to the namespace prefix of the organization for all objects that support it. There is an exception if an object is in an installed managed package. In that case, the object has the namespace prefix of the installed managed package. This is the namespace prefix of the Developer Edition organization of the package developer.
  • In organizations that are not Developer Edition organizations, NamespacePrefix is only set for objects that are part of an installed managed package. There is no namespace prefix for all other objects.
Type
Type
picklist
Properties
Filter, Group, Restricted picklist, Sort
Description
The organization type for this object.
  • Org (includes custom domains)
  • Community
  • Site
  • Portal
Url
Type
string
Properties
Filter, Group, idLookup, Sort
Description

The login URL of the organization for this AuthConfig object. Each URL has only one associated AuthConfig object.