Skip to main content
POST
/
apps
/
{app_id}
/
custom_credentials
Create a Custom Credential
curl --request POST \
  --url http://localhost:3001/portal-api/apps/{app_id}/custom_credentials \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '{
  "Alias": "<string>",
  "Type": "CREDENTIAL_TYPE_TYK_MANAGED",
  "PlanID": 123,
  "AuthenticationMethod": "<string>",
  "ProductIDs": [
    123
  ],
  "AuthTokenType": "AUTH_TOKEN_CUSTOM",
  "KeyID": "<string>",
  "CredentialKey": "<string>",
  "CredentialSecret": "<string>",
  "ProviderID": 123,
  "ClientTypeID": 123
}'
{
  "ID": 123,
  "Alias": "<string>",
  "Type": "CREDENTIAL_TYPE_TYK_MANAGED",
  "PlanID": "<string>",
  "AuthenticationMethod": "<string>",
  "ProductIDs": [
    123
  ],
  "AuthTokenType": "AUTH_TOKEN_CUSTOM",
  "KeyID": "<string>",
  "ProviderID": 123,
  "ClientTypeID": 123,
  "CreatedAt": "2023-06-25 13:37",
  "UpdatedAt": "2023-06-25 13:37"
}

Authorizations

​
Authorization
string
header
required

Path Parameters

​
app_id
string
required

Body

application/json
​
Alias
string
​
Type
enum<string>
Available options:
CREDENTIAL_TYPE_TYK_MANAGED,
CREDENTIAL_TYPE_CUSTOM
​
PlanID
integer
​
AuthenticationMethod
string
​
ProductIDs
integer[]
​
AuthTokenType
enum<string>
Available options:
AUTH_TOKEN_CUSTOM,
AUTH_TOKEN_STANDARD
​
KeyID
string
​
CredentialKey
string
​
CredentialSecret
string
​
ProviderID
integer
​
ClientTypeID
integer

Response

​
ID
integer
​
Alias
string
​
Type
enum<string>
Available options:
CREDENTIAL_TYPE_TYK_MANAGED,
CREDENTIAL_TYPE_CUSTOM
​
PlanID
string
​
AuthenticationMethod
string
​
ProductIDs
integer[]
​
AuthTokenType
enum<string>
Available options:
AUTH_TOKEN_CUSTOM,
AUTH_TOKEN_STANDARD
​
KeyID
string
​
ProviderID
integer
​
ClientTypeID
integer
​
CreatedAt
string
Example:
​
UpdatedAt
string
Example: