client.remote_hosts.post_authenticate

A method of the Remote Hosts endpoint.

post_authenticate(id: int, *, credential_id: int = None, username: str = None, password: str = None) → Response

Authenticate against a remote host using either a credential or a user name and password

API URL: POST /remote_hosts/{id}/authenticate

import civis
client = civis.APIClient()
response = client.remote_hosts.post_authenticate(...)

Parameters:

idint

The ID of the remote host.

credential_idint, optional

The credential ID.

usernamestr, optional

The user name for remote host.

passwordstr, optional

The password for remote host.

Returns:

None

Response code 204: success