credentials_post: Create a credential

In civis: R Client for the 'Civis Platform API'

Create a credential

Description

Create a credential

Usage

credentials_post(
  type,
  username,
  password,
  name = NULL,
  description = NULL,
  remote_host_id = NULL,
  user_id = NULL,
  state = NULL,
  system_credential = NULL,
  default = NULL,
  oauth = NULL
)

Arguments

type	string required. The type of credential. Note: only these credentials can be created or edited via this API ["Amazon Web Services S3", "CASS/NCOA PAF", "Certificate", "Civis Platform", "Custom", "Database", "Google", "Salesforce User", "Salesforce Client", "TableauUser"]
username	string required. The username for the credential.
password	string required. The password for the credential.
name	string optional. The name identifying the credential.
description	string optional. A long description of the credential.
remote_host_id	integer optional. The ID of the remote host associated with the credential.
user_id	integer optional. The ID of the user the credential is created for. Note: This attribute is only accepted if you are a Civis Admin User.
state	string optional. The U.S. state for the credential. Only for VAN credentials.
system_credential	boolean optional. Boolean flag that sets a credential to be a system credential. System credentials can only be created by Civis Admins and will create a credential owned by the Civis Robot user.
default	boolean optional. Whether or not the credential is a default. Only for Database credentials.
oauth	boolean optional. Whether or not the credential is an OAuth 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.
oauth	boolean, Whether or not the credential is an OAuth credential.

civis documentation built on Aug. 30, 2025, 1:08 a.m.