# CodeCredentialsUserDiscoveryOptions (/docs/auth/api/interfaces/CodeCredentialsUserDiscoveryOptions)



[@kysoql/auth](/docs/auth/api) / CodeCredentialsUserDiscoveryOptions

Options for headless authorization that discovers the Salesforce user from
a login hint.

## Extends [#extends]

* `CodeCredentialsAuthorizationBase`

## Properties [#properties]

| Property                                                             | Modifier   | Type                             | Description                                                                         | Inherited from                                   |
| -------------------------------------------------------------------- | ---------- | -------------------------------- | ----------------------------------------------------------------------------------- | ------------------------------------------------ |
| <a id="api-property-loginhint" /> `loginHint`                        | `readonly` | `string`                         | Headless user-discovery identifier passed to the Apex discovery handler.            | -                                                |
| <a id="api-property-password" /> `password`                          | `readonly` | `string`                         | Salesforce password supplied to the headless credentials flow.                      | -                                                |
| <a id="api-property-customdata" /> `customData?`                     | `readonly` | `string`                         | Application-defined data forwarded to the Salesforce user-discovery handler.        | -                                                |
| <a id="api-property-username" /> `username?`                         | `readonly` | `undefined`                      | Not accepted in user-discovery mode; Salesforce resolves the user from `loginHint`. | -                                                |
| <a id="api-property-credentialsplacement" /> `credentialsPlacement?` | `readonly` | `"body"`                         | User-discovery credentials must be sent in the POST body.                           | -                                                |
| <a id="api-property-siteurl" /> `siteUrl`                            | `readonly` | `string`                         | Experience Cloud site base URL, including a site path when configured.              | `CodeCredentialsAuthorizationBase.siteUrl`       |
| <a id="api-property-clientid" /> `clientId`                          | `readonly` | `string`                         | Connected App consumer key / OAuth client ID.                                       | `CodeCredentialsAuthorizationBase.clientId`      |
| <a id="api-property-redirecturi" /> `redirectUri`                    | `readonly` | `string`                         | Redirect URI registered with the Connected App.                                     | `CodeCredentialsAuthorizationBase.redirectUri`   |
| <a id="api-property-codechallenge" /> `codeChallenge?`               | `readonly` | `string`                         | PKCE S256 challenge paired with the verifier used during code exchange.             | `CodeCredentialsAuthorizationBase.codeChallenge` |
| <a id="api-property-scope" /> `scope?`                               | `readonly` | `string` \| readonly `string`\[] | OAuth scopes requested from Salesforce.                                             | `CodeCredentialsAuthorizationBase.scope`         |
| <a id="api-property-state" /> `state?`                               | `readonly` | `string`                         | Opaque state value returned unchanged for request correlation.                      | `CodeCredentialsAuthorizationBase.state`         |
| <a id="api-property-uvidhint" /> `uvidHint?`                         | `readonly` | `string`                         | Plain UVID body parameter. Mutually exclusive with uvidHintToken.                   | `CodeCredentialsAuthorizationBase.uvidHint`      |
| <a id="api-property-uvidhinttoken" /> `uvidHintToken?`               | `readonly` | `string`                         | JWT-based access token containing a UVID, sent as the Uvid-Hint header.             | `CodeCredentialsAuthorizationBase.uvidHintToken` |