Use the Create consumer app operation to create a consumer application
in a specified catalog for a consumer organization in API Connect.
Create consumer application
The create consumer app creates a consumer application in the specified catalog
for a specific consumer organization in the API Connect instance. User confirmation is required
before this operation is performed.
Table 1. Parameters
| Parameter |
Type |
Required |
Description |
title |
string |
Required if name is not provided. |
The displayed title of the consumer application. |
name |
string |
Required if title is not provided. |
The unique name (identifier) of the consumer application. |
consumer_org |
string |
Required |
The name of the consumer organization under which the application will be created. |
catalog |
string |
Optional |
The name of the catalog in which to create the consumer application. If not specified,
"sandbox" is used by default. |
You can use the following prompts to create a consumer application:
Table 2. Create a consumer application
| Action |
Prompts |
Commands |
| Create a consumer app |
- Create a consumer application by title (default catalog:
sandbox)
create consumer app with the title test app for consumer org test-org
- Create a consumer application by name to a specific catalog, for example, test
create consumer app with the name test-app for consumer org test-org in catalog test
- Create a consumer application by name and title to a specific catalog, for example, test
create consumer app with the title test app and the name test-app for consumer org test-org in catalog test
|
- Create a Consumer App by title (default catalog:
sandbox)
/create_consumer_app title:test app consumer_org:test-org
- Create a Consumer App by name to a specific catalog, for example, test
/create_consumer_app name:test-app consumer_org:test-org
- Create a Consumer App by name and title to a specific catalog, for example, test
create_consumer_app title:test app name:test app consumer_org:test-org
|
List consumer application credentials
This tool allows to list credentials from the given consumer application and consumer
organization in the catalog from API Connect instance.
Table 3. Parameters
| Parameter |
Type |
Required |
Description |
consumer_app |
string |
Yes |
The name of the consumer application. |
consumer_org |
string |
Yes |
The name of the consumer organization. |
catalog |
string |
Optional |
The name of the target catalog. If not specified, Sandbox is used by
default. |
You can use the following prompts to create a consumer application credentials:
Table 4. List consumer application
credentials
| Action |
Prompts |
Commands |
| List consumer application credential |
|
List consumer application credential by title (default catalog:
sandbox) /list_consumer_app_credentials consumer_name:test-app consumer_org:test-org
/list_consumer_app_credentials consumer_name:test-app consumer_org:test-org catalog:test
|
Create subscription
You can create a subscription for a consumer application to a product or API within a consumer
organization and catalog in the API Connect instance. User
confirmation is required before this operation is performed.
Table 5. Parameters
| Parameter |
Type |
Required |
Description |
api_name |
string |
Required if product_name is not provided. |
The name of the API to subscribe to. |
product_name |
string |
Required if api_name is not provided. |
The name of the product to subscribe to. |
consumer_app |
string |
Optional |
The name of the consumer application. If not specified, and only one consumer application
exists in the system, that application is used by default. |
consumer_org |
string |
Optional |
The name of the consumer organization. If not specified, and only one consumer organization
exists in the system, that organization is used by default. |
plan |
string |
Optional |
The name of the plan to use for the subscription. If not specified, and the product contains
only one plan, that plan is used by default. |
catalog |
string |
Optional |
The name of the target catalog where the subscription is created. If not specified,
"sandbox" is used by default. |
You can use following prompts to create a subscription:
Table 6. Create subscription
| Action |
Prompts |
Commands |
| Create subscription |
- Create a subscription by API name (default catalog:
sandbox)
create subscription for api sample-api
- Create a subscription by API name to a specific catalog, for example,
test
create subscription for api sample-api to catalog test
- Create a subscription by the Product name to a specific catalog, for example,
test
create subscription for product sample-product to catalog test
- Create a subscription by API name by using a specific plan to a specific
catalog
create subscription for api sample-api using plan default-plan to catalog test
- Create a subscription by API name to a specific consumer app and consumer org to a specific
catalog
create subscription for api sample-api for consumer app test-app and consumer org test-org in catalog test
|
- Create a subscription by API name (default catalog:
sandbox)
/create_subscription api_name:sample-api
- Create a subscription by API name to a specific catalog, for example,
test
/create_subscription api_name:sample-api catalog:test
- Create a subscription by the Product name to a specific catalog, for example,
test
/create_subscription product_name:sample-product catalog:test
- Create a subscription by API name by using a specific plan to a specific
catalog
/create_subscription api_name:sample-api plan:default-plan catalog:test
- Create a subscription by API name to a specific consumer app and consumer org to a specific
catalog
/create_subscription api_name:sample-api consumer_app:test-app consumer_org:test-org catalog:test
|
List subscription
You can list subscriptions of an application from the API Connect instance.
Table 7. Parameters
| Parameter |
Type |
Required |
Description |
api_name |
string |
Optional |
The name of the API. |
product_name |
string |
Optional |
The name of the product. |
consumer_app |
string |
Optional |
The name of the consumer application. |
consumer_org |
string |
Optional |
The name of the target organization. If not specified, Sandbox is used by
default. |
You can use following prompts to list subscriptions:
Table 8. List subscription
| Action |
Prompts |
Commands |
| List subscription |
- List subscriptions by API name (default catalog:
sandbox)
list subscriptions for api sample-api
- List subscriptions by API name from a specific catalog, for example,
test
list subscriptions for api sample-api from catalog test
- List subscriptions by product name from a specific catalog, for example,
test
list subscriptions for product sample-api from catalog test
- List subscriptions by consumer application name and consumer org name from specific
catalog
list subscriptions for consumer app test-app and consumer org test-org from catalog test
|
- List subscription by API name (default catalog:
sandbox)
/list_subscriptions api_name:sample-api
- List subscription by API name to a specific catalog, for example,
test
/list_subscriptions api_name:sample-api catalog:test
- List subscription by the Product name to a specific catalog, for example,
test
/list_subscriptions product_name:sample-product catalog:test
- List subscription by API name by using a specific plan to a specific
catalog
/list_subscriptions consumer_app:test-app consumer_org:test-org catalog:test
|