NEnexla
Credentials

Get All Credentials

Returns all data credentials accessible to the authenticated user.

get/data_credentials

Request

Query parameters

access_role'collaborator' | 'operator' | 'admin' | 'owner'

Add this query parameter to a request to view resources for which the authenticated user has permission.

  1. collaborator: Resources to which the user has access via the collaborator or higher permissions.
  2. operator: Resources to which the user has access via the operator or higher permissions.
  3. admin: Resources to which the user has access via the administrator or owner permissions.
  4. owner: Resources created by the user. Note that the absence of this property in the request is treated as owner, so you do not need to set access_role=owner in the query.
credentials_typestring

(Optional) Set this to the type of credentials you want to filter by. Connection type or vendor name can be used there.

Headers

Accept'application/vnd.nexla.api.v1+json' | 'application/json'

Setting to application/vnd.nexla.api.v1+json is recommended.

Response

Success

idinteger
namestring
descriptionstring nullable
access_rolesstring[]

This property reflects all the permissions the user/team/organization has to this resource.

  1. collaborator: The user/team/organization can view the resource but not make any modifications to it.
  2. operator: The user/team/organization can view the resource and can activate/pause it, but not make any other modifications to it.
  3. administrator: The user/team/organization has complete administrative rights to this resource.
  4. owner: This user created the resource and so has complete administrative rights to it.
credentials_versionstring
credentials_typestring
verified_statusstring
verified_atstring date-time
copied_from_idinteger nullable
updated_atstring date-time
created_atstring date-time
template_configobject nullable

Changes

No recorded changes to this operation across all 1 revision of this API.