libssh2\_agent\_userauth(3) libssh2 libssh2\_agent\_userauth(3)

# [NAME](#NAME)

libssh2\_agent\_userauth - authenticate a session with a public key, with the help of ssh-agent

# [SYNOPSIS](#SYNOPSIS)

```
#include <libssh2.h>
int
libssh2_agent_userauth(LIBSSH2_AGENT *agent,


                       const char *username,


                       struct libssh2_agent_publickey *identity);
```

# [DESCRIPTION](#DESCRIPTION)

*agent* - ssh-agent handle as returned by [**libssh2\_agent\_init(3)**](/man/os/libssh2/libssh2_agent_init.3)

*username* - Remote user name to authenticate as.

*identity* - Public key to authenticate with, as returned by [**libssh2\_agent\_get\_identity(3)**](/man/os/libssh2/libssh2_agent_get_identity.3)

Attempt public key authentication with the help of ssh-agent.

# [RETURN VALUE](#RETURN_VALUE)

Returns 0 if succeeded, or a negative value for error.

# [AVAILABILITY](#AVAILABILITY)

Added in libssh2 1.2

# [SEE ALSO](#SEE_ALSO)

[**libssh2\_agent\_init(3)**](/man/os/libssh2/libssh2_agent_init.3) [**libssh2\_agent\_get\_identity(3)**](/man/os/libssh2/libssh2_agent_get_identity.3) [**libssh2\_agent\_sign(3)**](/man/os/libssh2/libssh2_agent_sign.3)

23 Dec 2009 libssh2

---

Document: libssh2_agent_userauth(3) from libssh2 1.11.1-r11 (Chainguard OS)
Source: https://github.com/libssh2/libssh2.git