client.credentials.get

A method of the Credentials endpoint.

Get a credential

API URL: GET /credentials/{id}

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

Parameters:

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.