Role Creation (ssd api-management create role)

The ssd api-management create role command allows you to create an access role on Sensedia API Platform.

You can use the ssd api-management create role command or its shortened version ssd apim create role.

For more specific information, refer to the documentation on access roles on Sensedia API Platform.


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

ssd api-management create role [flags]

If no flag is specified, the interactive mode will be activated.

When creating a role, you must set access permission to at least one feature.
In the direct mode, this is done through the flag -p, --permission, as in the following example:

$ ssd api-management create role "Basic Role" --permission "alert:view;edit, analytics:view, apps:edit"

The access types available for each feature are:

  • view (viewing permission);

  • edit (edit permission);

  • view;edit (viewing and edit permission).

You can set permission to access the following features:

  • access_tokens

  • alert

  • analytics

  • apis

  • apis_health

  • api_connectors

  • apps

  • attributes

  • audit

  • cache_control

  • callbacks

  • certificate

  • dashboard

  • data_obfuscation

  • developers

  • environments

  • events_hub

  • health_checks

  • impact_analysis

  • inbound_address

  • integrations

  • ldap

  • mail_settings

  • multi-factor_authentication

  • notifications

  • oauth

  • open_banking

  • organizations

  • plans

  • roles

  • secrets

  • teams

  • trace

  • trace_decrypt

  • users

  • workflow

The -d, --description flag allows you to add a description to the role:

$ ssd api-management create role "Basic role" --description "Role for simple users" --permission "alert:view;edit, analytics:view, apps:edit"

Available flags

The following flags can be used with the ssd api-management create role command:

Flag Type Description

-d, --description


Role description

-h, --help

Displays help for the command

-p, --permission


Sets access types to features for the role. E.g.: --permission "alert:view;edit"

Global Flags




-c, --config


Configuration file (default: $HOME/.sensedia/config.json)



The configuration profile you want to use (default: "default")


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

Thanks for your feedback!

Share your suggestions with us!
Click here and then [+ Submit idea]