Create: HTTP Request type

Description

Use a HTTP POST request to create a HTTP Request credential.

Request

HTTP Method: POST

Parameter Description
name Name of the credential.
mode Describes the type of credential (HTTP_REQUEST_AGENT)
team_id ID of Tines Team where the credential will be located.
http_request_options JSON object representing the Agents::HTTPRequestAgent Options
http_request_location_of_token Location of token from response
http_request_secret Optional Secret value to save in an http request. This can be referenced as secret in the HTTP request options builder.
http_request_ttl Optional Time to live (TTL) in seconds. Not sending this value during an update/PUT operation will update it to null.
folder_id Optional ID of folder to which the credential will be located
read_access Optional Control where this credential can be used (TEAM, GLOBAL, SPECIFIC_TEAMS). default: TEAM. (SPECIFIC_TEAMS is a premium feature. Reach out to find out more.)
shared_team_slugs Optional List of teams' slugs where this credential can be used. Required to set read_access to SPECIFIC_TEAMS. default: [] (empty array).
description Optional Description of the credential. default: "" (empty string).
metadata Optional Key/value metadata relevant to the credential that can be referenced via the INFO path.
allowed_hosts Optional Array of domains where this credential can only be used in HTTP requests. Domain matching supports wildcards.
live_credential_id Optional ID of the live credential

Sample request

The <<secret>> maps to the value provided to the http_request_secret key as described above.

curl -X POST \
  https://<<META.tenant.domain>>/api/v1/user_credentials \
  -H 'content-type: application/json' \
  -H 'Authorization: Bearer <<CREDENTIAL.tines_api_key>>' \
  -d '{
      "name": "http credential",
      "mode": "HTTP_REQUEST_AGENT",
      "team_id": 2,
      "http_request_options": {
        "url": "http://www.example.com",
        "content_type": "json",
        "method": "post",
        "payload": {
          "key": "value",
          "secret": "I can reference the \\<<secret>> as needed in the payload."
        },
        "headers": {}
      },
      "http_request_location_of_token": "\\=credential_name.body.token",
      "http_request_secret": "secret_value"
    }'

Response

A successful request will return a JSON object describing the created credential.

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.
allowed_hosts Array of domains where this credential can only be used in HTTP requests.
metadata Key/value metadata relevant to the credential
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)

Sample response

{
  "id": 1,
  "name": "tines_api_credential",
  "mode": "HTTP_REQUEST_AGENT",
  "team_id": 2,
  "folder_id": 1,
  "read_access": "TEAM",
  "shared_team_slugs": [],
  "slug": "tines_api_credential",
  "created_at": "2021-03-26T12:34:16.540Z",
  "updated_at": "2021-03-26T12:34:16.540Z",
  "description": "",
  "allowed_hosts": [],
  "metadata": {},
  "restriction_type": "UNRESTRICTED",
  "test_credential_enabled": false
}
Was this helpful?