Cephable Portal

This guide provides insights for users of the Cephable Portal, detailing how to effectively manage organization members, billing, and projects. It offers step-by-step instructions for admins and SDK developers, ensuring a smooth experience in configuring permissions, inviting new members, and integrating SDKs. Additionally, resellers can learn to manage their organizations and license keys efficiently.

Cordellia
|
37 steps
|
2 minutes

Cephable Plus, Professional, Education, and SDK Users have access to the Cephable Portal to manage organization members, billing, custom information, and projects. In the dashboard, you will see a listing of all the organizations you are part of, or manage.

A listing of 8 organizations appear for the user. There is a side menu that also expands the high level details for each organization.

To access details of an organization, you can click on the relevant organization from the dashboard page. Or, alternatively click any of the items in the side menu for the relevant organization.

The user is clicking on an organization called Shristi Plus. And there is a rectangle around Shristi Plus in the Side Menu that also has expanded items: Settings, Members, Invites, and Projects.

To manage billing information, organization details, or custom information for members of your organization to see - Click Settings.

In the organization home page for your respective organization, there are clickable cards for Members, Inviting New Members, Projects, and Settings.

If you are the admin for your organization, you can configure additional details in the Settings Page. Things like Organization Name, Description, Resources, and Billing can be managed / edited here.

The page rendered is "Shristi Plus Settings", so for your organization it would change to <Your Organization Name> Settings. The top level has configurable details to change your Organization Name and Description. There is an arrow pointing to Organization Name and Description that can be edited.

As an admin, you can edit resources that all members of your organization can see and interact with. This is in markdown format, which allows you to add links, images, headers, details, and more.

The click target is in the Edit Resources Editor. There is a preview on the right that shows what the final resources will render like for a user.

At the bottom of the Settings page, there is a high level overview of the permissions you have as a user. In this case, this user has all available permissions. After that, there is billing information with an external billing portal to help you manage your organization's subscription.

A rectangle around "About Me" and corresponding details highlight what permissions you have as a user for this organization. Below that, the click target focuses on a Manage Billing button that links to an external link.

You can access any of the pages or come back to your organization's main page from the side menu too.

The page is back on Shristi Plus main organization page. The click target is on Shristi Plus in the side menu.

To invite a new member, from the Invites Page or the View Members Page, click "Add a Member" button. If you have exceeded the max limit of your organization, you will be asked to upgrade to add more seats in your subscription.

On the top right of either of these pages, there is a "Add a Member" button that lets you invite new members to the organization as part of your current subscription.

If you have not exceeded your max limit on seats, a dialog appears that lets you add a user's email and permissions when inviting them to an organization. If a user does not have an account with Cephable, the email sent with inviting them to the organization also asks them to create an account at that time.

There is a dialog for inviting users that comes up. The first box is email. Then there are a list of permissions that you need to configure for the user based on your organization needs. This includes billing permissions, viewing other organization members, managing other members, etc.

When inviting a new member to the organization, all permissions they have by default are OFF so they come in as a member without being able to manage parts of the organization in the portal. To toggle any permission, Click the toggle by the permission that they should have. If you give the inviting member admin permission, then it gives ALL permissions.

The click target hover is on View Members. If this is turned on, then the associated member will be able to see all the other members that are part of this Cephable Organization.

When you are ready to send the invitation, click Send Invite. Then, the user associated with the email you input gets an email invite to accept the organization invitation. Be sure to check spam and filter emails if not received within 30 minutes.

There is a send invite button at the bottom of the dialog that allows you to complete the invite request.

In the View Members page, you have a high level view of what permissions all the users in the organizations have. If you have access to edit details of the members, the edit button lets you do that. And you can also remove members from an organization here. Including yourself.

The click target is on the edit button of an existing user. This is on the right side for each user in the listing.

To edit existing member permission, a similar dialog to the Invite Member dialog appears. At the top, you can see the existing permissions that this user has. And within the dialog, the permissions they have are toggled ON. You can manage and configure these to give a user more or less permissions.

A rectangle to highlight the user's existing permissions is drawn. The click target is in the body of the dialog that has configurable permissions similar to the org invite dialog.

When you are done editing permissions, you can click Save and the user will immediately get those new permissions. You may need to refresh page for changes to be shown in the portal.

Click target is on the save button at the bottom of the edit permissions dialog.

Now, we will be switching to using the portal as a Cephable SDK Developer.

The click target is focused on Shristi SDK + Auth Org in the Side Panel.

For SDK Developers, their organization page will show a "View Projects" button in the Projects card. For non SDK Developers, this button will have information on how to procure a Cephable SDK License, to integrate features directly into a different project.

There is a button link for "View Projects" in the main organization page for SDK users. This is available for Cephable SDK License Users.

The projects page, lists all the auth clients and device types this organization has access to. To create a new project, click "Create a Project" in the top right. For other developer resources, you can click Developer at the bottom left of the portal.

Click target on "Create a Project" in top right, and rectangle around "Developer" button in bottom left.

For your project to integrate with Cephable SDK's and API's, start by adding your App Name.

First step in creating a project is project details. This asks you to add an app name.

Then, click Next and download the relevant Cephable SDK that you need for your project. To use these SDK's you need to have an auth client id and secret for your project, which you will create in the next steps.

At the moment, Cephable offers SDK for JavaScript and .NET, with more coming.

Step 3: Configure your Authorization Client. This includes adding redirects for after your project has been authenticated.

This includes information like origin host, token url, and token redirect urls all used during authentication.

Step 4: Define Scopes that your project would like to access endpoints on behalf of the end users. This includes Read / Write access for user permissions, onboarding, commands, devices, profiles, and more.

There is a long list of read / write permissions a project can take on behalf of a user.

Step 5: Add Device Types that can be used to register devices of these device types. Device Type determines actions and data that your devices can access. This can be things like a device accesses Cephable Desktop App microphone inputs, but your device type supports Xbox or Playstation Controllers.

Click target is on the dropdown for the device type.

Focus on the dropdown to select an existing device type for your project, or add a new one.

First dropdown for device type selection is focused.

At the bottom, you can select from existing device types or Add a new device type that is specific to your needs.

Click target is at the bottom, on "Add a Device Type" option.

Here, you can create the device type with supported features and the identifying name. Then, every user will have a device registered of this device type that then allows the SDK developer to have end to end integrations with events and profiles. Save changes when ready.

A dialog to create a device type appears.

Let's transition to Cephable Portal for Resellers!

The portal is back on the dashboard. Now, the click target is on Shristi Reseller Organization.

Notice that for reseller organizations, the portal organization dashboard has more available options outside of member management, project management, and billing settings. Resellers can use the Cephable Portal to also manage their managed organizations (organizations created from reseller license keys), and manage reseller billing information.

The organization dashboard has 2 new cards now - Managed Organizations and Manage License Keys.

To purchase license keys for reseller use, click the Purchase License Keys Button.

Click target is on Purchase, for purchasing license keys.

In the Purchase License Keys page, you can see the available products that are available for resellers. To purchase any of these, click on the Purchase button for the associated product.

Click target on Cephable Professional Resale Seat Product.

To manage license keys for reseller use, click the License Keys Page.

This License Keys Page allows you to assign organizations to unassigned license keys, or manage organizations that are associated with assigned license keys. To assign a license key, click on an unassigned license and add Organization Name and Custom Billing URL for your reseller organization to manage.

There is a dialog to assign a license key to an organization. This has details to input Organization Name, Description, and Custom Billing URL

As a reseller, you can also edit and manage organizations created from reseller license keys. From the organization dashboard of your Reseller organization, click Managed Organizations.

Click target on manage organizations button link from specific organization dashboard page.

In the Managed Organizations page, you can view the organizations that the reseller manages.

Click target is on the first managed organization for this reseller.

Clicking any of these organizations brings up a dialog that allows you to edit the Organization Name, Description, and Custom Billing URL. The Custom Billing URL is the most important info on how you want to redirect your managed organizations to pay your reseller organization for the license seat that you have purchased from Cephable.\ \ The Manage Billing button lets the *Reseller* manage their Cephable License Subscription for that license key assigned to the organization.

A dialog to edit organization details appears. At the top, there are buttons for Manage Billing (your license subscription with Cephable) and View Organization. Then, there is Organization Name, Description, and Custom Billing URL that you want the managed organization to redirect to.

To view the organization details of your managed organization, click "View Organization" from this dialog.

Click target on "View Organization" for the managed organization.

Notice that the managed organization page looks similar to the organization dashboard page. So you can view, edit, manage these organization details as if you were the admin or member of this managed organization. However, to identify which organization you are configuring, the managed org pages will have a "Managed" tag at the top left of the page.

The click target is on the "Managed" tag in the top left of the organization details page.

Notice that the Managed tag appears in all the org pages for the managed org when accessing the details as a reseller.

On the Members page for the managed org, and the click target is on the "Managed" tag in the top left.