Client Operations
Create a client
flow client create-client [OPTIONS]
Options
parameters | short-format | long-format | required | type | description |
---|---|---|---|---|---|
app_name | - | --app-name |
yes | str | App name for the client |
Usage
flow client create-client --app-name xxx
Delete a client
flow client delete-client [OPTIONS]
Options
parameters | short-format | long-format | required | type | description |
---|---|---|---|---|---|
app_id | - | --app-id |
yes | str | App ID for the client |
Usage
flow client delete-client --app-id xxx
Querying Client Information by Filtering Conditions
flow client query-client [OPTIONS]
Options
parameters | short-format | long-format | required | type | description |
---|---|---|---|---|---|
app_id | - | --app-id |
no | str | App ID for the client |
app_name | - | --app-name |
no | str | App name for the client |
Usage
flow client query-client --app-id xxx --app-name xxx
Create partner site
flow client create-site [OPTIONS]
Options
parameters | short-format | long-format | required | type | description |
---|---|---|---|---|---|
party_id | -p |
--party-id |
yes | str | Site ID |
Usage
flow client create-site -p xxx
Delete partner site
flow client delete-site [OPTIONS]
Options
parameters | short-format | long-format | required | type | description |
---|---|---|---|---|---|
party_id | -p |
--party-id |
yes | str | Site ID |
Usage
flow client delete-site -p xxx
Query partner site
flow client query-site [OPTIONS]
Options
parameters | short-format | long-format | required | type | description |
---|---|---|---|---|---|
party_id | -p |
--party-id |
yes | str | Site ID |
Usage
flow client query-site -p xxx
Establishing Partnership with a Site
flow client create-partner [OPTIONS]
Options
parameters | short-format | long-format | required | type | description |
---|---|---|---|---|---|
party_id | -p |
--party-id |
yes | str | Site ID |
app_id | - | --app-id |
yes | str | App ID for the client |
app_token | - | --app-token |
yes | str | App token for the site |
Usage
flow client create-partner -p xxx --app-id xxx --app-token xxx
Disassociating Partnership with a Site.
flow client delete-partner [OPTIONS]
Options
parameters | short-format | long-format | required | type | description |
---|---|---|---|---|---|
party_id | -p |
--party-id |
yes | str | Site ID |
Usage
flow client delete-partner -p xxx
Querying Sites with Established Partnerships.
flow client query-partner [OPTIONS]
Options
parameters | short-format | long-format | required | type | description |
---|---|---|---|---|---|
party_id | -p |
--party-id |
no | str | Site ID |
Usage
flow client query-partner -p xxx