1. Home
  2. ...
  3. Creation (ssd api-management create)
  4. Role Creation (ssd api-management create role)

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.
NOTE

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

TIP

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

Usage

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

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:

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:

Available flags

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

Flag
Type
Description
-d, --descriptionstringRole description
-h, --helpDisplays help for the command
-p, --permissionstringSets access types to features for the role. E.g.: --permission "alert:view;edit"

Global Flags

Flag
Type
Description
-c, --configstringConfiguration file (default: $HOME/.sensedia/config.json)
--profilestringThe configuration profile you want to use (default: "default")
--verboseLists 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?

We use cookies to enhance your experience on our site. By continuing to browse, you agree to our use of cookies.Learn more