client.credentials.list

A method of the Credentials endpoint.

list(*, type: str = None, remote_host_id: int = None, default: bool = None, system_credentials: bool = None, users: str = None, name: str = None, provider: str = None, limit: int = None, page_num: int = None, order: str = None, order_dir: str = None, iterator: bool = None) → ListResponse | PaginatedResponse

List credentials

API URL: GET /credentials

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

Parameters:

typestr, 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, OAuth User, Salesforce User, Salesforce Client, and TableauUser. Specify multiple values as a comma-separated list (e.g., “A,B”).

remote_host_idint, optional

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

defaultbool, optional

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

system_credentialsbool, optional

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

usersstr, 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.

namestr, 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.

providerstr, optional

If specified, only return OAuth User credentials for this OAuth provider (e.g. “salesforce”).

limitint, optional

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

page_numint, optional

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

orderstr, optional

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

order_dirstr, optional

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

iteratorbool, optional

If True, return a generator (specifically, a civis.PaginatedResponse object) to iterate over all responses. Use it when more results than the maximum allowed by ‘limit’ are needed. When True, ‘page_num’ is ignored. If False, return a civis.ListResponse object (= a list of civis.Response objects), whose size is determined by ‘limit’. Defaults to False.

Returns:

civis.ListResponse | civis.PaginatedResponse

• 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.