Managing Users and Clients

  3 minute read  

To access BeeYard, you need to create a User with a username and password. An email address is used as a username. Each User can be assigned multiple Roles, and each Role defines the User’s authorized actions.

For more information about the layout, refer to the Users and roles description.

Users

The User page displays a list of existing Users, along with their assigned Roles.

Add User

  1. To create a new User click the Add user button

    Add User
    Figure 1. Add User

  2. Enter the User’s name, last name, and email (which will serve as the username).

    Add new User
    Figure 2. Add new User

  3. Assign Roles to the User from the Roles section.

    Add new User Roles
    Figure 3. Add new User Roles

  4. Click the Add button to create the User.

Show User details

  1. Click the Show details button to view the User’s details.

    User details button
    Figure 4. Show details
    User details
    Figure 5. Details

Edit User

  1. Click the Edit user button to modify the User’s assigned Roles or password.

    Edit roles
    Figure 6. Edit User
    Edit roles panel
    Figure 7. Edit User Roles
    Change password
    Figure 8. Change password

Disable User

  1. Click the Disable user button to deactivate the User.

    Disable User
    Figure 9. Disable User
Note
 A disabled User cannot authenticate. You can restore a disabled User later if needed.

Restore User

A disabled User is highlighted and can be restored.

Restore User
Figure 10. Restore User

Roles

In the Roles section, you can define new Roles and modify existing ones.

Roles determine the actions that Users can perform in BeeYard.

Add Role

  1. Click the Add role button to create a new Role.

    Add role
    Figure 11. Add role

  2. Provide a name, description, and select the desired Authorities from the list.

    Add new role
    Figure 12. Add new role

Change Authorities

  1. To modify the list of active Authorities for a Role click the Edit authorities button.

    Edit authorities
    Figure 13. Edit authorities

  2. Select the desired Authorities from the list.

    Change authorities
    Figure 14. Change authorities

Delete role

Roles cannot be disabled, only removed.

  1. Click the Delete role button to remove a Role.

Delete role
Figure 15. Delete role

Authorities

This section lists all available built-in Authorities that can be assigned to Roles.

Clients

Clients are machine Users represented by a Client ID and a Client secret. They can be assigned Roles in the same way as Users.

Add Client

  1. Click the Add client button to create a new Client.

    Add Client
    Figure 16. Add Client

  2. Set the Client ID and select the desired Roles.

    Add new Client
    Figure 17. Add new Client
    Add new Client Roles
    Figure 18. Add new Client Roles

Show Client details

  1. Click the Show details button to view the details of a Client.

    Display Client details
    Figure 19. Display Client details
    Client details
    Figure 20. Client details

Edit Client

  1. Click the Edit client button to modify the Client’s assigned Roles or update the password.

    Edit Client
    Figure 21. Edit Client
    Edit Client’s Roles
    Figure 22. Edit Client’s Roles

Regenerate Client secret

  1. Click the Regenerate client secret button to generate a new Client secret.

    Regenerate Client secret
    Figure 23. Regenerate Client secret

  2. Confirm this action in the new popup window.

Disable Client

  1. Click the Disable client button to deactivate a Client.

    Disable Client
    Figure 24. Disable Client

Restore Client

  1. Click the Restore client button to restore a previously disabled Client. This option is only available for disabled Clients.

    Restore Client
    Figure 25. Restore Client