credentials_post_authenticate {civis}

Authenticate against a remote host

Description

Authenticate against a remote host

Usage

credentials_post_authenticate(url, remote_host_type, username, password)

Arguments

url

string required. The URL to your host.

remote_host_type

string required. 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

username

string required. The username for the credential.

password

string required. The password for the credential.

Value

A list containing the following elements:

id

integer, The ID of the credential.

name

string, The name identifying the credential

type

string, The credential's type.

username

string, The username for the credential.

description

string, A long description of the credential.

owner

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

user

list, A list containing the following elements:

• id integer, The ID of this user.

• name string, This user's name.

• username string, This user's username.

• initials string, This user's initials.

• online boolean, Whether this user is online.

remoteHostId

integer, The ID of the remote host associated with this credential.

remoteHostName

string, The name of the remote host associated with this credential.

state

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

createdAt

string, The creation time for this credential.

updatedAt

string, The last modification time for this credential.

default

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