mix nerves_hub.org (nerves_hub_cli v0.11.1) View Source

Manages an organization

Managing user roles

The following functions allow the management of user roles within your organization. Roles are a way of granting users a permission level so they may perform actions for your org. The following is a list of valid roles in order of highest role to lowest role:

  • admin
  • delete
  • write
  • read

NervesHub will validate all actions with your user role. If an action you are trying to perform requires write, the user performing the action will be required to have an org role of write or higher (admin, delete).

Managing user roles in your org will require that your user has the org role of admin.

user list

List the users and their role for the organization.

mix nerves_hub.org user list

user add

Add an existing user to an org with a role.

mix nerves_hub.org user add USERNAME ROLE

user update

Update an existing user in your org with a new role.

mix nerves_hub.org user update USERNAME ROLE

user remove

Remove an existing user from having a role in your organization.

mix nerves_hub.org user remove USERNAME

Link to this section Summary

Link to this section Functions

Specs

render_help() :: no_return()

Callback implementation for Mix.Task.run/1.

Link to this function

user_add(org, username, role, auth \\ nil)

View Source
Link to this function

user_remove(org, username)

View Source
Link to this function

user_update(org, username, role)

View Source