Home
...
Listing (ssd api-management list)
Roles Listing (ssd api-management list roles)

Roles Listing (ssd api-management list roles)

The `ssd api-management list roles` command allows you to list the access roles available on Sensedia API Platform.

NOTE
You can use the ssd api-management list roles command or its shortened version ssd apim list roles.

Usage

The ssd api-management list roles command can be followed by flags with their respective arguments:

If no flag is specified, all available roles will be listed and the display type will be the one specified in the configuration file (see ssd configure).

Available flags

The following flags can be used with the ssd api-management list roles command:

Flag	Type	Description
-h, --help		Displays help for the command
-n, --permissionName	string	Lists only roles that have permission for a specific functionality. E.g.: `--permissionName "APIS"`
-t, --permissionType	string	Filters the list of roles by access type. E.g.: `--permissionType "VIEW"`, `--permissionType "EDIT"`
-o, --output	string	Specifies the display type of the information. E.g.: `-o json`, `-o table`
-p, --page	int	Specifies from which page to display the information. E.g.: `--page 1`
-q, --query	string	Filters the information to be returned. E.g.: `--query "Admin"`
-s, --size	int	Number of resources to be listed. E.g.: `--size 100`

Global Flags

Flag	Type	Description
-c, --config	string	Configuration file (default: `$HOME/.sensedia/config.json`)
--profile	string	The configuration profile you want to use (default: "default")
--verbose		Lists all requests made by the command. It is possible to store this information in a TXT file instead of displaying it on the terminal. E.g.: `$ ssd (api-management \| apim) list apis --verbose 2> log.txt`

How happy are you with this page?

Plans Listing (ssd api-management list plans)

Users Listing (ssd api-management list users)