Skip to main content

Get

Description

Retrieve a credential.

Request

HTTP Method: GET

ParameterDescription
idThe ID of the credential to retrieve.
curl -X GET \
https://<tenant-domain>/api/v1/user_credentials/<credential-id> \
-H 'content-type: application/json' \
-H 'x-user-email: <email-address>' \
-H 'x-user-token: <api-token>'

Response

A successful request will return a JSON object describing the selected 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.
aws_assumed_role_external_idExternal ID for AWS assumed role, if exists.

Sample response

{
"id": 1,
"name": "tines_github_credential",
"mode": "TEXT",
"team_id": 2,
"folder_id": 1,
"read_access": "TEAM",
"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
}