Instances

Let us describe instances with the help of a popular Zluri integration ex: Google Workspace. 

1. What are instances, and how can you view them? 

Ans: Go to the Sources -> Integrations menu on the dashboard and select Google Workspace. You can see the option Instances highlighted with a list below. These list items are the instances available for Google Workspace:

The integrations section allows you to add, remove, and customize instances for all integrations. Here, the term ‘Instance’ is a generic term which refers to each connection associated with an application. For example, when you integrate Google Workspace into the dashboard, multiple connections with different scope permissions for different use cases can exist. These connections are referred to as instances.

Scopes

Ans: In the previous section, we discussed how instances are connections you create for an application. With that perspective in mind, Scopes are the permissions required by Zluri to connect an instance. These scopes can be mapped to the capabilities that Zluri offers. In other words, to fetch/edit user data and other user metadata from an integration, you need to provide Zluri access to specific permissions and these permissions are called Scopes.

The following types of scopes are available for Google Workspace:

1. Required Scopes: These are the basic level permissions that are required to be enabled for each specific instance of Google Workspace. This is necessary to retrieve data from the organization's domain and its users. The screenshot above shows how each scope has been marked by a red asterisk on the right, indicating that this is mandatory.
2. Other Scopes:

These Scopes are utilised for Use cases other than discovering users and User metadata. These are utilised for executing workflow actions for adding a user to an app, assigning a license to a user etc while onboarding and Deleting user from the app, Revoking user license from the app etc while offboarding. You can provide permission to these scopes to utilise the Onboarding/Offboarding workflows and License provisioning capabilities in Zluri directly through workflow actions.

1. Scopes For Discovery: These scopes are necessary for fetching information like User data metadata, user group data, user group subscriptions data and user aliases data. Zluri only utilises these scopes only for fetching data, not for editing data. 
   The main reason for permitting these kinds of scopes is that they primarily harness the data from the background through one of Zluri’s five powerful discovery methods to trace the data and take relevant actions. Some of these are optional.
   

2. Scopes For Workflows: These scopes are required for workflow capabilities in Zluri; they allow Zluri to read and edit User data and metadata for your application. You can utilise the onboarding/offboarding and provisioning capabilities in Zluri by allowing these scopes on Zluri. These are optional, generally.
   

3. How do I check which scopes are connected/disconnected from my Google Workspace?

Ans: Go to the Integrations menu on the dashboard and select Google Workspace. Click on the name, and a side menu opens. Select the scopes button to open the Scopes menu and find the connected/disconnected scopes list. Ex:

• See info about users on your domain
• View groups on your domain
• View domains related to your customers
• View organization units on your domain
• View groups on your domain
• Manage data access permissions for users on your domain
• View usage reports for your G Suite domain
• View audit reports for your G Suite domain
• View and manage G Suite licenses for your domain

4. I opened my dashboard and did not find Google Workspace. How do I find it?

Ans: This may happen because your Google Workspace is under the connected integrations menu. Open the Integrations menu from the Dashboard. On the left you will see 3 options under For You - Recommended, Connected and Connection Requests. Select the Connected Option. If you do not see the Google Workspace option, type the same in the Search menu and it will appear in the search list.

5. I tried to add a new scope to my Google Workspace, and it failed. What should I do?

Ans: If there is an error in connecting a scope, you can re-attempt to connect the scope using a similar process with the same Reference URL. Click on the Add Instance button in the Google Workspace option. Enable the scope you want to add and proceed to the connection authorization request. If the connection authorization process does not work, you can try to get it done using the Send to a co-worker option. If your co-worker can also not authorise the connection, please contact the Support team.

6. What is the average sync time for Google Workspace SSO?

Ans: The sync time is approx. 24-48 hours.

7. How to validate user data for integration with Google Workspace?

To check user data for a particular application, open the Zluri Dashboard and navigate to the application -> user screen.

Google Workspace:

Download the google workspace users and filter the users with status = active. The user count should match the count from the Zluri application with source = Google Workspace and User application status = active.

8. How do I add/remove an instance from Google Workspace?

Ans: From the integrations menu in the Zluri dashboard, you can select the add instance button directly from the Google Workspace menu or browse catalogue option and access the Google Workspace from the Integrations catalogue menu. The Google Workspace window opens. On the top left, you can click on the Connect an instance button to connect an instance and select subsequent scopes for the same before sending for authorization.

Select the view instances option from the Google Workspace menu to delete an instance. This will take you to a separate Google Workspace menu under the Integrations menu in Dashboard. From here, you can view the list of instances that are disconnected or have some error under Google Workspace. To remove such an instance - select the three-dot menu on the top right of an instance and select the remove option.

Note: 

• You can also add an instance from the Google Workspace menu under the Integrations menu in Dashboard. Click the button “Add Instance” on the top right.
• The user will remove all existing data associated with Google Workspace and its scope by removing an existing instance. This data will no longer be available.

9. How do I connect/disconnect an instance from Google Workspace?

Ans: Open Google Workspace under the browse catalogue menu. Click on View All Instances. From the Google Workspace window that opens, you can see the list of instances that are connected/disconnected.

Click on the reconnect option in red below an instance to connect a disconnected instance. This will take you to the scope integration menu, and you will need to authorize the instance again, as previously discussed. 

To disconnect an instance, select the three-dot menu on the top right and select the Disconnect option. Remember that if you disconnect an instance, any new data will not be synced with Zluri Dashboard, but the previously synced data will still be available.

10. What should I do if my instance is disconnected due to a change in the admin account?

Ans: This may happen if the admin account is deactivated or the permissions associated with an admin account are changed due to the existing admin leaving the organization. In such cases, you can either add a new instance with new admin account credentials or reconnect an existing instance with the new admin account credentials.

Zluri recommends you choose the second option from above. This will ensure no loss of previously recorded data, and the dashboard will retrieve and sync the pre-existing data without any loss. In case a new instance has to be created, all previous data will be lost.