**Source URL:** https://limited.veevavault.dev/medical/omnichannel/api-reference/26.1/methods/onlogin

# onLogin()

Notifies Vault when a user has successfully authenticated and sets the `AgentStatus`.

## Parameters

<FieldTable>
| Name | Type | Description |
| --- | --- | --- |
| `agentStatus`<Requiredness type="optional" /> | `AgentStatus` | The user's telephony status. Allowed values are `AgentStatus.AVAILABLE` and `AgentStatus.OFFLINE`. If not provided, the default is `AgentStatus.OFFLINE`. |
</FieldTable>

## Example

<CodeExample title="">
```javascript
import { omniconnectEvent, AgentStatus} from "./vault-medical-omniconnect-25.1.2-release12649.js";

// Authenticate user with OFFLINE agent status
function userAuthenticatedWithOfflineStatus() {
    omniconnectEvent.onLogin()
}

// Authenticate user with AVAILABLE agent status
function userAuthenticatedWithAvailableStatus() {
    omniconnectEvent.onLogin(AgentStatus.AVAILABLE)
}
```
</CodeExample>

---

**Previous:** [onDisconnect()](/medical/omnichannel/api-reference/26.1/methods/ondisconnect)  
**Next:** [onLogout()](/medical/omnichannel/api-reference/26.1/methods/onlogout)