Admin actions
What you can do
As an Organization Management Portal Admin, you can:
- View the applications your organization has access to
- Manage users, including:
- Create, edit and delete a user
- Add, edit, and delete the roles associated with a user
- Resend a registration email during sign-up/Reset user multifactor authentication (MFA)
- Manage API clients, including:
- Create, edit, disable, and delete API clients (API machine to machine) from your organization
- Add, edit, and delete the scopes associated with an API client
- Access a script for the Get Token command for a specific API client
Terminology
Term | Explanation |
|---|---|
Users | Human users from your organization that use Cross River applications |
API clients | Agents that use Cross River applications |
Partners | Your different types of offerings or product groups. You assign users to a partner or partners. Partners are preconfigured by Cross River for you. |
Applications | Cross River applications that your users have permissions to access |
Roles | Define what features your organization’s users can see and the permissions they have in the Cross River applications that your organization uses. You can apply roles to different applications, per user. Roles are preconfigured by Cross River for your organization. |
Scopes | Define access for an organization's client applications via the Cross River API to user data. You control the abilities and limits (meaning, the "scope") of the client application within a Cross River application. Scopes are also known as protected resources. Scopes are preconfigured by Cross River for your organization. |
Log into the portal
IMPORTANT
Be sure you include the organization management portal outgoing IP address 66.206.202.116 in your list of addresses to be allowed at your end.
Once you have completed initial access registration, access the appropriate version of the portal from these URLs:
- https://orgmanagementsandbox.crbcos.com/ (sandbox)
- https://orgmanagement.crbcos.com/ (production)
Navigate in the portal
Once in the portal you see your dashboard, displaying data about your applications, users, API clients and partners. Navigate from the tree on the left.
Manage users
Click Users in the left-hand navigation to see a list of your users and to perform related actions.
View user details
On the main user screen, for each user, see:
- Full name
- Username
- Phone number
- Registration status (Completed, pending, blocked)
- How many applications the user can access
- How many roles have been assigned to the user
- User access level in Org Management
- Last login date
- Creation date
Click the three-dot menu on the right for a specific user and select View Details. More details appear on the right of the screen, including specific roles per application.
Create user
Click Actions, and select New User. A pane opens on the right.
Enter the all following required information for the user:
- First name
- Last name
- Phone number
- Email address
If the user will also be an admin for your organization, select Organization Administrator.
For each application your user needs access to, select that application from the tree, and the relevant roles to apply.
Click Save. The user now appears in your list of users.
Edit user name and roles
Click the three-dot menu on the right for a specific user and select Edit User.
Fields available to edit include:
- First and last name
- Applications the user can access
- Roles the user has for each application
Resend registration email
If the user has not yet registered you can resend the registration email.
Click the three-dot menu on the right for a specific user and select Resend Registration Email.
If this option does not appear, the user already registered.
Follow the onscreen instructions to resend the email.
Reset multifactor authentication (MFA)
If the user is already registered you can reset their authentication.
Click the three-dot menu on the right for a specific user and select Reset MFA.
If this option does not appear, the user is not registered yet.
Enter the user phone number in the Reset MFA pane.
Do not use spaces or hyphens. Do include the area code.
Click Save.
The user phone number updates and the MFA is reset.
Delete user
Click the three-dot menu on the right for a specific user and select Delete User.
Manage API clients
Click API clients in the left-hand navigation to see tiles representing each API client you have created and information about that client.
View API client details
On the main API clients screen, for each user, see a tile that includes:
- Client name
- Client ID
- Number of scopes assigned to that client
- Number of applications the client can access
- Creation date
- Description (if added)
- Organization name
- Partner name (if added)
Hover over a tile to reveal the hamburger menu (three parallel lines).
Hover the hamburger menu and click View. More details appear on the right of the screen.
Create API client
Click Actions, and select New Client. A pane opens on the right.
Enter the following information for the client:
- Details tab:
- Client ID (required)
- Client name (required)
- Description of the client. This field is searchable.
- Partner tab:
- Partner name. You can search for this if you are not sure of the exact name.
- Scopes tab:
- Scopes to be added to the client. You can search for these if you are not sure of the exact names.
- Secrets tab:
- Click + New Secret to generate a new secret for the client
Click Save. The API client tile appears on the main screen.
View applications
Click Applications in the left-hand navigation to drill down to details about your applications.
For each Cross River application you can see how many roles and scopes your users and API clients have.
To drill down further:
- Hover over a tile to reveal the hamburger menu (three parallel lines).
- Hover the hamburger menu and click View. More details appear on the right of the screen.
View partners
Click Partner in the left-hand navigation to drill down to details about your applications.
For each partner your organization manages, you can see information about that partner.
To see the properties of the partner:
- Hover over a tile to reveal the hamburger menu (three parallel lines).
- Hover the hamburger menu and click View. More details appear on the right of the screen.
Find a specific user, client, application or partner
Every screen has a filter button on the right. Each screen filter is unique to the screen, however all screens include a free text filter.