List

Description

Retrieve a list of credentials.

Request

HTTP Method: GET

Parameter Description
team_id Optional List actions for the given team
folder_id Optional List actions for the given folder
per_page Optional Set the number of results returned per page. Defaults to 20.
page Optional Specify the page of results to return if there are multiple pages. Defaults to page 1.
filter Optional Filter by one of: UNUSED_IN_ACTIONS, UNRESTRICTED, RESTRICTED 
curl -X GET \
  https://<<META.tenant.domain>>/api/v1/user_credentials \
  -H 'content-type: application/json' \
  -H 'Authorization: Bearer <<CREDENTIAL.tines_api_key>>'

Response

A successful request will return a JSON Array describing credentials in the Tines tenant.

Field description

Parameter Description
id credential ID.
name Name of the credential.
mode Describes the type of credential (TEXT, JWT, OAUTH, AWS, MTLS, HTTP_REQUEST_AGENT, MULTI_REQUEST).
team_id ID of team to which the credential belongs.
folder_id ID of folder to which the credential belongs.
read_access Control where this credential can be used (TEAM, GLOBAL, SPECIFIC_TEAMS).
shared_team_slugs List of teams' slugs where this credential can be used when read_access is SPECIFIC_TEAMS, otherwise empty.
description Description of the credential.
slug An underscored representation of the credential name.
created_at ISO 8601 Timestamp representing date and time the credential was created.
updated_at ISO 8601 Timestamp representing date and time the credential was last updated.
aws_assumed_role_external_id External ID for AWS assumed role, if exists.
aws_authentication_type The authentication method with AWS, key-based-access or role-based-access(KEY, ROLE, INSTANCE_PROFILE), if exists.
allowed_hosts Array of domains where this credential can only be used in HTTP requests.
metadata Key/value metadata for use in HTTP requests alongside the credential value.
restriction_type The type of restriction applied to the use of the credential (RESTRICTED,RESTRICTED_TO_CREDENTIALS ,UNRESTRICTED )
test_credential_enabled A boolean value stating if the credential is enabled for using a test credential
test_credential Data specific to the test credential (created_at and updated_at)
owner An object representing the user who owns this credential. By default, the owner is the user who created the credential.

Sample response

{
  "user_credentials": [
    {
      "id": 1,
      "name": "tines_github_credential",
      "mode": "TEXT",
      "team_id": 2,
      "folder_id": 1,
      "read_access": "TEAM",
      "shared_team_slugs": [],
      "slug": "tines_github_credential",
      "created_at": "2021-03-26T12:34:16.540Z",
      "updated_at": "2021-03-26T12:34:16.540Z",
      "description": "",
      "aws_assumed_role_external_id": null,
      "aws_authentication_type": null,
      "allowed_hosts": [],
      "metadata": {  },
      "restriction_type": "UNRESTRICTED",
      "test_credential_enabled": false,
      "owner": {
        "user_id": 1,
        "first_name": "Jane",
        "last_name": "Doe",
        "email": "jane@tines.io"
      }

    }
  ]
  "meta": {
    "current_page": "https://<<META.tenant.domain>>/api/v1/user_credentials?per_page=1&page=1",
    "previous_page": null,
    "next_page": null,
    "next_page_number": null,
    "per_page": 1,
    "pages": 1,
    "count": 1
  }
}
Was this helpful?