Skip to main content

Create: JWT type

Description

Use a HTTP POST request to create a JWT tokens credential.

Request

HTTP Method: POST

ParameterDescription
nameName of the credential.
modeDescribes the type of credential (JWT)
jwt_algorithmThe algorithm to be used when computing the JWT
jwt_payloadThe payload to be included in the JWT
jwt_auto_generate_time_claimsAuto generate ‘iat’ & ‘exp’ claims
jwt_private_keyThe private key to be used to sign the JWT
team_idID of Tines Team where the credential will be located.
folder_idOptional ID of folder to which the credential will be located
read_accessOptional Control where this credential can be used (TEAM, GLOBAL). default: TEAM
descriptionOptional Description of the credential. default: "" (empty string).

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": "JWT",
"team_id": 2,
"jwt_algorithm": "RS256",
"jwt_payload": { "key": "value" },
"jwt_auto_generate_time_claims": true,
"jwt_private_key": "<private-key>"
}'

Response

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

Field description

ParameterDescription
idcredential ID.
nameName of the credential.
modeDescribes the type of credential (TEXT, JWT, OAUTH, AWS, MTLS, HTTP_REQUEST_AGENT)
team_idID of team to which the credential belongs.
folder_idID of folder to which the credential belongs.
read_accessControl where this credential can be used.
descriptionDescription of the credential.
slugAn underscored representation of the credential name
created_atISO 8601 Timestamp representing date and time the credential was created.
updated_atISO 8601 Timestamp representing date and time the credential was last updated.

Sample response

{
"id": 1,
"name": "tines_api_credential",
"mode": "JWT",
"team_id": 2,
"folder_id": 1,
"read_access": "TEAM",
"slug": "tines_api_credential",
"created_at": "2021-03-26T12:34:16.540Z",
"updated_at": "2021-03-26T12:34:16.540Z",
"description": ""
}