Get

Description

Retrieve a credential.

Request

HTTP Method: GET

Parameter Description
id The 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

Parameter Description
id credential ID.
name Name of the credential.
mode Describes the type of credential (TEXT, JWT, OAUTH, AWS, MTLS, HTTP_REQUEST_AGENT)
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.
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.

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,
  "aws_authentication_type": null
}
Was this helpful?