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



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

Options for building a Salesforce OAuth authorization URL.

## Properties [#properties]

| Property                                               | Modifier   | Type                             | Description                                                                        |
| ------------------------------------------------------ | ---------- | -------------------------------- | ---------------------------------------------------------------------------------- |
| <a id="api-property-loginurl" /> `loginUrl`            | `readonly` | `string`                         | Salesforce login or My Domain base URL used for authorization.                     |
| <a id="api-property-clientid" /> `clientId`            | `readonly` | `string`                         | Connected App consumer key / OAuth client ID.                                      |
| <a id="api-property-redirecturi" /> `redirectUri`      | `readonly` | `string`                         | Redirect URI registered with the Connected App.                                    |
| <a id="api-property-scope" /> `scope?`                 | `readonly` | `string` \| readonly `string`\[] | Requested OAuth scopes; arrays are serialized as a space-delimited value.          |
| <a id="api-property-state" /> `state?`                 | `readonly` | `string`                         | Opaque state value returned unchanged by Salesforce for request correlation.       |
| <a id="api-property-nonce" /> `nonce?`                 | `readonly` | `string`                         | OpenID Connect nonce used to correlate an ID token with the authorization request. |
| <a id="api-property-prompt" /> `prompt?`               | `readonly` | `string`                         | OAuth `prompt` parameter forwarded to Salesforce.                                  |
| <a id="api-property-loginhint" /> `loginHint?`         | `readonly` | `string`                         | Optional username/login hint forwarded to Salesforce.                              |
| <a id="api-property-display" /> `display?`             | `readonly` | `string`                         | Salesforce `display` parameter for the authorization UI.                           |
| <a id="api-property-codechallenge" /> `codeChallenge?` | `readonly` | `string`                         | PKCE S256 code challenge paired with the verifier used during token exchange.      |