- Switchboard API
- Connect API
- connections
- connection
- actions
- definitions
- credentials
- protocols
- auth-schemes
API Reference
List Credentials
ListCredentials returns a paginated list of Credentials, ordered with most recently updated first. Customising the sort behaviour is not currently supported but may be added in the future. Similarly with filtering, this will be implemented in a future release.
Cookie authentication used by the Versori Platform.
Authorizations
Cookie authentication used by the Versori Platform.
Path Parameters
Query Parameters
Response
ID is the unique identifier of the Credential.
CredentialType denotes the type of the credential which determines what the Credential's data
property will
contain.
- none: No credential is required to authenticate with the Connection.
- string: The credential is a string value, such as an API key or password.
- binary: The credential is a binary value, such as a private key, certificate or other file.
- basic-auth: The credential is a username and password to be used for basic authentication.
- oauth2-client: The credential is an OAuth2 client ID and secret to be used for OAuth2 authentication.
- oauth2-token: The credential is an OAuth2 access_token to be used for OAuth2 authentication.
none
, string
, binary
, basic-auth
, oauth2-client
, oauth2-token
Name is the name of the Credential.
Type is a unique identifier of the AuthScheme, this is a kebab-case formatted string, see enum values for possible options.
none
, api-key
, basic-auth
, oauth2
, google-service-account
, hmac
CredentialUsages is a list of references to the Connections which are using this Credential. To aid performance, this field will only be defined for specific endpoints. An undefined property means that the usages have not been loaded, whereas an empty array indicates that the credential is not used by any connections.
CredentialUsageEnvironment contains the information about an Environment which is using a Credential. This also includes a summary of the Connection it belongs to.
ID is the unique identifier of the Environment. Typically this is only used internally and most (if not all)
public-facing APIs will use the name
in combination with the Connection's id
instead.
Name is the name of the Environment.
Slug is the kebab-case name of the Environment.
ConnectionSummaryBase exposes a summary of a Connection irrespective of protocol.
ID is the unique identifier of the Connection.
OrganisationID is the unique identifier of the Organisation that owns the Connection.
Name is the user-provided name of the Connection
ProtocolType denotes the set of all valid connection types.
http
, bigquery
CreatedAt is the time at which the ConnectionVersion was created.
UpdatedAt is the time at which the ConnectionVersion was last updated, including any changes to child resources.
CreatedAt is the time the Environment was created.
UpdatedAt is the time the Environment was last updated.
Errors is a list of errors which occurred when attempting to validate the credential. This will only be defined if the credential is invalid.