> ## Documentation Index
> Fetch the complete documentation index at: https://docs-staging-actions-triggers-prototype.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# LoginMembers

Login screen members interface extending base members

```ts Example theme={null}
export interface LoginMembers extends BaseMembers {
  screen: ScreenMembersOnLogin;
  transaction: TransactionMembersOnLogin;
  /**
   * Performs login with username/password
   * @param payload The login options
   */
  login(payload: LoginOptions): Promise<void>;
  /**
   * Performs login with social provider
   * @param payload The social login options
   */
  federatedLogin(payload: FederatedLoginOptions): Promise<void>;
  /**
   * Picks country code for phone number input
   * @param payload Optional custom options
   */
  pickCountryCode(payload?: CustomOptions): Promise<void>;
  /**
   * Gets the active identifier types for the login screen
   * @returns An array of active identifier types or null if none are active
   * @utilityFeature
   */
  getLoginIdentifiers(): IdentifierType[] | null;
}
```

## Properties

<ParamField body="branding" type={<span><a href="/docs/libraries/acul/react-sdk/API-Reference/Types/interfaces/BrandingMembers">BrandingMembers</a></span>} />

<ParamField body="client" type={<span><a href="/docs/libraries/acul/react-sdk/API-Reference/Types/interfaces/ClientMembers">ClientMembers</a></span>} />

<ParamField body="organization" type={<span><a href="/docs/libraries/acul/react-sdk/API-Reference/Types/interfaces/OrganizationMembers">OrganizationMembers</a></span>} />

<ParamField body="prompt" type={<span><a href="/docs/libraries/acul/react-sdk/API-Reference/Types/interfaces/PromptMembers">PromptMembers</a></span>} />

<ParamField body="screen" type={<span><a href="/docs/libraries/acul/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnLogin">ScreenMembersOnLogin</a></span>} />

<ParamField body="tenant" type={<span><a href="/docs/libraries/acul/react-sdk/API-Reference/Types/interfaces/TenantMembers">TenantMembers</a></span>} />

<ParamField body="transaction" type={<span><a href="/docs/libraries/acul/react-sdk/API-Reference/Types/interfaces/TransactionMembersOnLogin">TransactionMembersOnLogin</a></span>} />

<ParamField body="untrustedData" type={<span><a href="/docs/libraries/acul/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>} />

<ParamField body="user" type={<span><a href="/docs/libraries/acul/react-sdk/API-Reference/Types/interfaces/UserMembers">UserMembers</a></span>} />

## Methods

<ParamField body="federatedLogin" type="Promise<void>">
  Performs login with social provider

  <Expandable title="Parameters">
    <ParamField body="payload" type={<span><a href="/docs/libraries/acul/react-sdk/API-Reference/Types/interfaces/FederatedLoginPayloadOptions">FederatedLoginPayloadOptions</a></span>}>
      The social login options

      **Properties**

      <ParamField body="connection" type="string">
        The social connection name to use
      </ParamField>
    </ParamField>
  </Expandable>
</ParamField>

<ParamField body="getLoginIdentifiers" type={<span><a href="/docs-v2/main//docs/libraries/acul/react-sdkScreens/type-aliases/IdentifierType">IdentifierType</a>[]</span>}>
  **`Utility Feature`**

  Gets the active identifier types for the login screen

  An array of active identifier types or null if none are active
</ParamField>

<ParamField body="login" type="Promise<void>">
  Performs login with username/password

  <Expandable title="Parameters">
    <ParamField body="payload" type={<span><a href="/docs/libraries/acul/react-sdk/API-Reference/Types/interfaces/LoginPayloadOptions">LoginPayloadOptions</a></span>}>
      The login options

      **Properties**

      <ParamField body="captcha?" type="string">
        Optional captcha value if required
      </ParamField>

      <ParamField body="password" type="string">
        The password for authentication
      </ParamField>

      <ParamField body="username" type="string">
        The username/email to login with
      </ParamField>
    </ParamField>
  </Expandable>
</ParamField>

<ParamField body="pickCountryCode" type="Promise<void>">
  Picks country code for phone number input

  <Expandable title="Parameters">
    <ParamField body="payload?" type={<span><a href="/docs/libraries/acul/react-sdk/API-Reference/Types/interfaces/CustomOptions">CustomOptions</a></span>}>
      Optional custom options
    </ParamField>
  </Expandable>
</ParamField>