Description

Use a HTTP POST request to create a AWS user credential.

Request

HTTP Method: POST

Parameter Description
name Name of the user credential.
mode Describes the type of credential (AWS)
team_id ID of Tines Team where the user credential will be located.
folder_id Optional ID of folder to which the user credential will be located
read_access Optional Control where this credential can be used (TEAM, GLOBAL). default: TEAM
aws_authentication_type The authentication method with AWS, key-based-access or role-based-access(KEY,ROLE)
aws_access_key The access key from your AWS Security Credentials
aws_secret_key The access secret from your AWS Security Credentials
aws_assumed_role_arn Required for role-based-access The ARN of the role you wish to assume, e.g.: arn:aws:iam::123456789012:role/write-access-role
aws_assumed_role_external_id Optional The external ID to be used when making the request

Sample request

curl -X POST \
  https://<tenant-domain>/api/v1/user_credentials \
  -H 'content-type: application/json' \
  -H 'x-user-email: <email-address>' \
  -H 'x-user-token: <api-token>' \
  -d '{
        "name": "foo",
        "value": "bar",
        "mode": "AWS",
        "team_id": 2,
        "aws_authentication_type": "KEY",
        "aws_access_key": "v_access_key",
        "aws_secret_key": "v_secret_key",
    }'

Response

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

Field description

Parameter Description
id User credential ID.
name Name of the user credential.
mode Describes the type of credential (TEXT, JWT, OAUTH, AWS, MTLS, HTTP_REQUEST_AGENT)
team_id ID of team to which the user credential belongs.
folder_id ID of folder to which the user credential belongs.
read_access Control where this credential can be used.
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.

Sample response

{
  "id": 1,
  "name": "tines_api_credential",
  "mode": "AWS",
  "team_id": 2,
  "folder_id": 1,
  "created_at": "2021-03-26T12:34:16.540Z",
  "updated_at": "2021-03-26T12:34:16.540Z"
}