-
Notifications
You must be signed in to change notification settings - Fork 132
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Showing
19 changed files
with
482 additions
and
13 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,40 @@ | ||
## apictl get api-logging | ||
|
||
Display a list of API loggers in an environment | ||
|
||
### Synopsis | ||
|
||
Display a list of API loggers available for the APIs in the environment specified | ||
|
||
``` | ||
apictl get api-logging [flags] | ||
``` | ||
|
||
### Examples | ||
|
||
``` | ||
apictl get api-logging -e dev --tenant-domain carbon.super | ||
apictl get api-logging --api-id bf36ca3a-0332-49ba-abce-e9992228ae06 -e dev --tenant-domain carbon.super | ||
``` | ||
|
||
### Options | ||
|
||
``` | ||
-i, --api-id string API ID | ||
-e, --environment string Environment of the APIs which the API loggers should be displayed | ||
--format string Pretty-print API loggers using Go Templates. Use "{{ jsonPretty . }}" to list all fields | ||
-h, --help help for api-logging | ||
--tenant-domain string Tenant Domain | ||
``` | ||
|
||
### Options inherited from parent commands | ||
|
||
``` | ||
-k, --insecure Allow connections to SSL endpoints without certs | ||
--verbose Enable verbose mode | ||
``` | ||
|
||
### SEE ALSO | ||
|
||
* [apictl get](apictl_get.md) - Get APIs/APIProducts/Applications or revisions of a specific API/APIProduct in an environment or Get the log level of each API in an environment or Get the environments | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,38 @@ | ||
## apictl mi add role | ||
|
||
Add new role to a Micro Integrator | ||
|
||
### Synopsis | ||
|
||
Add a new role with the name specified by the command line argument [role-name] to a Micro Integrator in the environment specified by the flag --environment, -e | ||
|
||
``` | ||
apictl mi add role [role-name] [flags] | ||
``` | ||
|
||
### Examples | ||
|
||
``` | ||
To add a new role | ||
apictl mi add role [role-name] -e dev | ||
NOTE: The flag (--environment (-e)) is mandatory | ||
``` | ||
|
||
### Options | ||
|
||
``` | ||
-e, --environment string Environment of the micro integrator to which a new user should be added | ||
-h, --help help for role | ||
``` | ||
|
||
### Options inherited from parent commands | ||
|
||
``` | ||
-k, --insecure Allow connections to SSL endpoints without certs | ||
--verbose Enable verbose mode | ||
``` | ||
|
||
### SEE ALSO | ||
|
||
* [apictl mi add](apictl_mi_add.md) - Add new users or loggers to a Micro Integrator instance | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,41 @@ | ||
## apictl mi delete role | ||
|
||
Delete a role from the Micro Integrator | ||
|
||
### Synopsis | ||
|
||
Delete a role with the name specified by the command line argument [role-name] from a Micro Integrator in the environment specified by the flag --environment, -e | ||
|
||
``` | ||
apictl mi delete role [role-name] [flags] | ||
``` | ||
|
||
### Examples | ||
|
||
``` | ||
To delete a role | ||
apictl mi delete role [role-name] -e dev | ||
To delete a role in a secondary user store | ||
apictl mi delete role [role-name] -d [domain] -e dev | ||
NOTE: The flag (--environment (-e)) is mandatory | ||
``` | ||
|
||
### Options | ||
|
||
``` | ||
-d, --domain string Select the domain of the role | ||
-e, --environment string Environment of the Micro Integrator from which a role should be deleted | ||
-h, --help help for role | ||
``` | ||
|
||
### Options inherited from parent commands | ||
|
||
``` | ||
-k, --insecure Allow connections to SSL endpoints without certs | ||
--verbose Enable verbose mode | ||
``` | ||
|
||
### SEE ALSO | ||
|
||
* [apictl mi delete](apictl_mi_delete.md) - Delete users from a Micro Integrator instance | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,45 @@ | ||
## apictl mi get roles | ||
|
||
Get information about roles | ||
|
||
### Synopsis | ||
|
||
Get information about the roles in primary and secondary user stores. | ||
List all roles of the Micro Integrator in the environment specified by the flag --environment, -e | ||
|
||
``` | ||
apictl mi get roles [role-name] [flags] | ||
``` | ||
|
||
### Examples | ||
|
||
``` | ||
To list all the roles | ||
apictl mi get roles -e dev | ||
To get details about a role by providing the role name | ||
apictl mi get roles [role-name] -e dev | ||
To get details about a role in a secondary user store | ||
apictl mi get roles [role-name] -d [domain] -e dev | ||
NOTE: The flag (--environment (-e)) is mandatory | ||
``` | ||
|
||
### Options | ||
|
||
``` | ||
-d, --domain string Filter roles by domain | ||
-e, --environment string Environment to be searched | ||
--format string Pretty-print using Go Templates. Use "{{ jsonPretty . }}" to list all fields | ||
-h, --help help for roles | ||
``` | ||
|
||
### Options inherited from parent commands | ||
|
||
``` | ||
-k, --insecure Allow connections to SSL endpoints without certs | ||
--verbose Enable verbose mode | ||
``` | ||
|
||
### SEE ALSO | ||
|
||
* [apictl mi get](apictl_mi_get.md) - Get information about artifacts deployed in a Micro Integrator instance | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,38 @@ | ||
## apictl mi update user | ||
|
||
Update roles of a user in a Micro Integrator | ||
|
||
### Synopsis | ||
|
||
Update the roles of a user named [user-name] specified by the command line arguments in a Micro Integrator in the environment specified by the flag --environment, -e | ||
|
||
``` | ||
apictl mi update user [user-name] [flags] | ||
``` | ||
|
||
### Examples | ||
|
||
``` | ||
To update the roles | ||
apictl mi update user [user-name] -e dev | ||
NOTE: The flag (--environment (-e)) is mandatory | ||
``` | ||
|
||
### Options | ||
|
||
``` | ||
-e, --environment string Environment of the Micro Integrator of which the user's roles should be updated | ||
-h, --help help for user | ||
``` | ||
|
||
### Options inherited from parent commands | ||
|
||
``` | ||
-k, --insecure Allow connections to SSL endpoints without certs | ||
--verbose Enable verbose mode | ||
``` | ||
|
||
### SEE ALSO | ||
|
||
* [apictl mi update](apictl_mi_update.md) - Update log level of Loggers in a Micro Integrator instance | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,40 @@ | ||
## apictl set api-logging | ||
|
||
Set the log level for an API in an environment | ||
|
||
### Synopsis | ||
|
||
Set the log level for an API in the environment specified | ||
|
||
``` | ||
apictl set api-logging [flags] | ||
``` | ||
|
||
### Examples | ||
|
||
``` | ||
apictl set api-logging --api-id bf36ca3a-0332-49ba-abce-e9992228ae06 --log-level full -e dev --tenant-domain carbon.super | ||
apictl set api-logging --api-id bf36ca3a-0332-49ba-abce-e9992228ae06 --log-level off -e dev --tenant-domain carbon.super | ||
``` | ||
|
||
### Options | ||
|
||
``` | ||
-i, --api-id string API ID | ||
-e, --environment string Environment of the API which the log level should be set | ||
-h, --help help for api-logging | ||
--log-level string Log Level | ||
--tenant-domain string Tenant Domain | ||
``` | ||
|
||
### Options inherited from parent commands | ||
|
||
``` | ||
-k, --insecure Allow connections to SSL endpoints without certs | ||
--verbose Enable verbose mode | ||
``` | ||
|
||
### SEE ALSO | ||
|
||
* [apictl set](apictl_set.md) - Set configuration parameters or per API log levels | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.