Admin

The Admin section lets you manager Cockpit users, AdminCentral groups, and Organisations.

It’s a good idea to manage access to your DX Cloud subscription. You an easily handle this using the Admin section in your Cockpit. Here, you can create and manage users, and create user groups for your subscription as well as perform administrative operations like password resets, or creating business units (Organisations).

Manage users

You can manage existing users directly from the Cockpit under the Access section. This includes:

Adding a user

You can add a new user to your DX Cloud subscription directly from the Cockpit under the Access section.

  1. Go to Admin > Users.

  2. Click Add.

    1. Give the user a First Name.

    2. Give the user a Last Name.

    3. Input the user email.

    4. If desired, click Active to immediately activate the user upon creation.

    5. Add the desired roles for the user.

      Roles list

      Role Sections Description

      cdn-api-access-control-read

      CDN

      cdn-api-access-control-write

      CDN

      cdn-api-blocked-ips-read

      CDN

      cdn-api-blocked-ips-write

      CDN

      cdn-api-geofencing-read

      CDN

      cdn-api-geofencing-write

      CDN

      cdn-api-object-responses-read

      CDN

      cdn-api-object-responses-write

      CDN

      cdn-api-purge-all

      CDN

      cdn-api-purge-url

      CDN

      cdn-api-segmented-caching-read

      CDN

      cdn-api-segemented-caching-write

      CDN

      cdn-api-waiting-room-read

      CDN

      cdn-api-waiting-room-write

      CDN

      certificate-api-read

      certificate-api-write

      cluster-api-ingress-read

      cluster-api-ingress-write

      cockpit-support

      Predefined set of roles associated with the support group.

      cockpit-business

      Predefined set of roles associated with the business group.

      cockpit-developer

      Predefined set of roles associated with the developer group.

      cockpit-devops

      Predefined set of roles associated with the devops group.

      logs-api-audit-read

      logs-read

      redirect-api-read

      redirect-api-write

      subscription-api-read

      subscription-api-write

      user-api-read

      user-api-write

    6. Don’t forget to click Add.

      create new user

User types and roles

The user list allows you to quickly understand the type of user and whether the user is active.

  • Active Active users are represented by a green badge.

  • Inactive Active users are represented by a gold badge.

  • Unverified Unverified users are represented by a red badge.

You can also see the type of user, or rather how the user was created:

  • idp: created and managed via your Identity Provider.

  • Cockpit: created in the Cockpit.

  • magnolian: a Magnolia user; this is typically Magnolia support or someone in the DX Cloud team.

user type and status

User roles

User roles define what users are allowed to do and what section of the Cockpit they can access.

  • Available: roles that are not selected and therefore not assigned to the selected user.

  • Selected: roles that are selected and therefore assigned to the selected user.

  • Effective: reflects all assigned roles that are selected and those inherited from a user group.

Roles list

Role Sections Description

cdn-api-access-control-read

CDN

cdn-api-access-control-write

CDN

cdn-api-blocked-ips-read

CDN

cdn-api-blocked-ips-write

CDN

cdn-api-geofencing-read

CDN

cdn-api-geofencing-write

CDN

cdn-api-object-responses-read

CDN

cdn-api-object-responses-write

CDN

cdn-api-purge-all

CDN

cdn-api-purge-url

CDN

cdn-api-segmented-caching-read

CDN

cdn-api-segemented-caching-write

CDN

cdn-api-waiting-room-read

CDN

cdn-api-waiting-room-write

CDN

certificate-api-read

certificate-api-write

cluster-api-ingress-read

cluster-api-ingress-write

cockpit-support

Predefined set of roles associated with the support group.

cockpit-business

Predefined set of roles associated with the business group.

cockpit-developer

Predefined set of roles associated with the developer group.

cockpit-devops

Predefined set of roles associated with the devops group.

logs-api-audit-read

logs-read

redirect-api-read

redirect-api-write

subscription-api-read

subscription-api-write

user-api-read

user-api-write

To edit the roles assigned to each user:

  1. Go to Admin > Users.

  2. Scroll to the desired user.

  3. Editing roles depends on the user type:

    • For IDP users

    • Cockpit created users

    1. Click Edit roles next to your desired user.

    2. Click the role(s) you want to assign to the user.

    3. Click Save.

    1. Click Edit next to your desired user.

    2. Scroll down to the Roles section.

    3. Click the role(s) you want to assign to the user.

    4. Click Save.

Editing a user

  1. Go to Admin > Users.

  2. Scroll to the desired user.

  3. Click Edit.

  4. In the dialog window, edit the user as needed.

  5. Don’t forget to click Edit.

Deleting users

  1. Go to Admin > Users.

  2. Scroll to the desired user.

  3. Click Delete.

  4. In the dialog window, click Delete to confirm that you definitely want to delete the user.

Reset user passwords

You can reset a user’s password directly from the Cockpit under the Access section.

For your information

If you’re using SSO for your DX Cloud subscription, you are unable to reset the password of those users logging in via single sign-on, as the password is managed via the oidc provider.

  1. Go to Admin > Users.

  2. Scroll to the desired user.

  3. Click Edit.

  4. In the dialog window, click Reset password.

    When successful, a Password reset email is sent to the user. There, they will follow instructions to create a new password.

    reset password

Create user group

You can create a new user to your DX Cloud subscription directly from the Cockpit under the Admin section.

  1. Go to Admin > AdminCentral groups.

  2. Click Add.

    1. Give the group a meaningful name.

    2. Click the users that you want to add to the group.

      If you accidentally click the wrong user, you can click them again and they’ll return to the Available group.
    3. Don’t forget to click Add.

      create user group

Group access AdminCentral

If using the SSO module for authentication, you need to ensure the groups created in the Cockpit are granted access via the configuration in the SSO module.

  1. Create a group in the Cockpit.

    No special roles are needed for AdminCentral access.
  2. Assign users to the group. These are the users who you want to be able to access AdminCentral.

  3. In the SSO module, ensure the group name created in the Cockpit is defined in the config.yaml file. See the SSO module configuration section for more details.

    path: /.magnolia/admincentral
    callbackUrl: http://localhost:8080/.auth
    postLogoutRedirectUri: http://localhost:8080/.magnolia/admincentral
    authorizationGenerators:
      - name: groupsAuthorization
        groups:
          targetProperty: groups
          mappings:
            - name: /COCKPIT_GROUP (1)
              targetGroups: (2)
                - editors
              targetRoles: (3)
                - editor
    1 Where /COCKPIT_GROUP is the name of the group you created in the Cockpit. If using Keycloak, the leading / is mandatory.
    2 Defines the target group for the mapped group.
    3 Defines any particular target roles for the group.

Add Organisation

You can create an Organisation so that you can group access to certain parts of your DX Cloud project based on a business unit or organisation. You can define access to clusters, domains, and namespaces this way and explicitly choose the users that are part of the unit.

  1. Go to Admin > Organisations.

  2. Click Add.

    1. Give the organisation a meaningful name.

    2. Give the organisation a meaningful description.

    3. Choose the Cluster Ids for which you want to grant access.

    4. Choose the Domains for which you want to grant access.

    5. Choose the Namespaces for which you want to grant access.

    6. Click the users that you want to add to the organisation.

      If you accidentally click the wrong user, you can click them again and they’ll return to the Available group.
    7. Don’t forget to click Add.

      create business unit

Feedback

PaaS

×

Location

This widget lets you know where you are on the docs site.

You are currently perusing through the Magnolia PaaS docs.

Main doc sections

DX Core Headless PaaS Legacy Cloud Incubator modules