client.credentials.post_authenticate

A method of the Credentials endpoint.

post_authenticate(url: str, remote_host_type: str, username: str, password: str) → Response

Authenticate against a remote host

API URL: POST /credentials/authenticate

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

Parameters:

urlstr

The URL to your host.

remote_host_typestr

The type of remote host. One of: RemoteHostTypes::Bigquery, RemoteHostTypes::Bitbucket, RemoteHostTypes::GitSSH, RemoteHostTypes::Github, RemoteHostTypes::GoogleDoc, RemoteHostTypes::JDBC, RemoteHostTypes::Postgres, RemoteHostTypes::Redshift, RemoteHostTypes::S3Storage, and RemoteHostTypes::Salesforce

usernamestr

The username for the credential.

passwordstr

The password for the credential.

Returns:

civis.Response

• idint

  The ID of the credential.

• namestr

  The name identifying the credential

• typestr

  The credential’s type.

• usernamestr

  The username for the credential.

• descriptionstr

  A long description of the credential.

• ownerstr

  The username of the user who this credential belongs to. Using user.username is preferred.

• usercivis.Response

  • idint

    The ID of this user.

  • namestr

    This user’s name.

  • usernamestr

    This user’s username.

  • initialsstr

    This user’s initials.

  • onlinebool

    Whether this user is online.

• remote_host_idint

  The ID of the remote host associated with this credential.

• remote_host_namestr

  The name of the remote host associated with this credential.

• statestr

  The U.S. state for the credential. Only for VAN credentials.

• created_atstr (time)

  The creation time for this credential.

• updated_atstr (time)

  The last modification time for this credential.

• defaultbool

  Whether or not the credential is a default. Only for Database credentials.

• oauthbool

  Whether or not the credential is an OAuth credential.

• providerstr

  For OAuth User credentials: the OAuth provider (e.g. “salesforce”).

• provider_metadatacivis.Response

  For OAuth User credentials: non-secret provider metadata, e.g. the instance_url and granted scopes for Salesforce. Never contains tokens.