credentials_list {civis}

List credentials

Description

List credentials

Usage

credentials_list(
  type = NULL,
  remote_host_id = NULL,
  default = NULL,
  system_credentials = NULL,
  users = NULL,
  name = NULL,
  limit = NULL,
  page_num = NULL,
  order = NULL,
  order_dir = NULL
)

Arguments

type

string optional. The type (or types) of credentials to return. One or more of: Amazon Web Services S3, Bitbucket, CASS/NCOA PAF, Certificate, Civis Platform, Custom, Database, Google, Github, Salesforce User, Salesforce Client, and TableauUser. Specify multiple values as a comma-separated list (e.g., "A,B").

remote_host_id

integer optional. The ID of the remote host associated with the credentials to return.

default

boolean optional. If true, will return a list with a single credential which is the current user's default credential.

system_credentials

boolean optional. If true, will only return system credentials. System credentials can only be created and viewed by Civis Admins.

users

string optional. A comma-separated list of user ids. If specified, returns set of credentials owned by the users that requesting user has at least read access on.

name

string optional. If specified, will be used to filter the credentials returned. Will search across name and will return any full name containing the search string.

limit

integer optional. Number of results to return. Defaults to its maximum of 1000.

page_num

integer optional. Page number of the results to return. Defaults to the first page, 1.

order

string optional. The field on which to order the result set. Defaults to updated_at. Must be one of: updated_at, created_at, name.

order_dir

string optional. Direction in which to sort, either asc (ascending) or desc (descending) defaulting to desc.

Value

An array containing the following fields:

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.