Skip to main content
GET
/
apps
/
{app_id}
/
custom_credentials
List Custom Credentials
curl --request GET \
  --url http://localhost:3001/portal-api/apps/{app_id}/custom_credentials \
  --header 'Authorization: <api-key>'
[
  {
    "ID": 123,
    "Alias": "<string>",
    "PlanID": "<string>",
    "AuthenticationMethod": "<string>",
    "ProductIDs": [
      123
    ],
    "KeyID": "<string>",
    "ProviderID": 123,
    "ClientTypeID": 123
  }
]

Authorizations

​
Authorization
string
header
required

Path Parameters

​
app_id
string
required

The ID of the application.

Query Parameters

​
limit
integer

Maximum number of records to return for this request. Overrides the row count only, not the page offset (which is always based on per_page), so use per_page for pagination rather than combining limit with page. Defaults to the per_page value.

​
per_page
integer
default:20

Items per page. Defaults to the resource-specific page count if configured, otherwise 20

​
page
integer
default:1

Page number. Defaults to 1 when omitted

Response

200 - application/json

A list of custom credentials

​
ID
integer

Unique identifier for the custom credential

​
Alias
string

Alias for the custom credential

​
Type
enum<string>

Type of the custom credential

Available options:
CREDENTIAL_TYPE_TYK_MANAGED,
CREDENTIAL_TYPE_CUSTOM
​
PlanID
string

Plan ID associated with the custom credential

​
AuthenticationMethod
string

Authentication method used for the custom credential

​
ProductIDs
integer[]

List of product IDs associated with the custom credential

​
AuthTokenType
enum<string>

Type of authentication token used

Available options:
AUTH_TOKEN_TYPE_CUSTOM,
AUTH_TOKEN_STANDARD
​
KeyID
string

Key ID for the custom credential

​
ProviderID
integer

ID for OAuth2.0 provider

​
ClientTypeID
integer

ID for OAuth2.0 client type