Admin Guide

Background

When logged in as an M365 Global Admin, a number of features and configurations are available to administrators.

Integrating with other organisations

Manage API Keys

If you would like to share your address book, you must generate an API Key to provide secure access to your organisation's data.

Create a new API Key

1. Open the app as a Global Admin.
2. Click the API Keys tab
3. Click the Generate new API Key button
4. Provide the name of the organisation you intend to share the key with.
5. Provide the App IP Address if you have been given one. Note: By entering an IP address here, you will limit access to your API Key to traffic originating from the app instance with that IP address. This feature is similar to applying a WAF whitelist rule. You can apply additional Azure WAF rules to your instance to further secure your application and data.
6. Click Submit. A new API Key will be shown on the table in the API Keys tab.

You can copy and share this API Key along with your External API Endpoint URL to enable another organisation to access your address book.

Editing an API Key

1. Open the app as a Global Admin.
2. Click the API Keys tab
3. Click the ··· menu icon next to the API Key you wish to edit
4. Click the Edit API Key link
5. From this screen, you can edit the Organisation Name and the App IP Address settings.
6. Click the Save button to publish changes.

Deleting an API Key

1. Open the app as a Global Admin.
2. Click the API Keys tab
3. Click the ··· menu icon next to the API Key you wish to delete
4. Click the Delete API Key link
5. Click the Confirm button to finalise deleting the API Key.

Obtaining your External API Endpoint URL

In order for other app instances to connect and read from your address book, they need to provide an Endpoint URL. You can obtain your app instances Endpoint URL from your Azure Resource Group.

1. Open the Azure Portal
2. Open the Resource Group created during the deployment process.
3. In this Resource Group, open the resource called wa-police-directory-external
4. Your External API Endpoint URL can be found next the URL heading in the Essentials section:

This is the URL you need to provide along with your API Key to another organisation.

Partner Connections

To read another organisation's address book, you must establish a new Partner Connection.

Add a new address book

1. Open the app as a Global Admin.
2. Click the Partner Connections tab
3. Click the Connect to a new partner button
4. Provide the name of the organisation.
5. Provide the API Key you have been given
6. Provide the Endpoint URL you have been given
7. Click the Save button

You should now be able to read from your partner's address book

Edit an existing partner connection

1. Open the app as a Global Admin.
2. Click the Partner Connections tab
3. Click the ··· menu icon next to the connection you wish to edit
4. Click the Edit Connection Details link
5. From this screen, you can edit the Organisation Name, the API key and External API Endpoint URL.
6. Click the Save button to publish changes.

Delete an existing partner connection

1. Open the app as a Global Admin.
2. Click the Partner Connections tab
3. Click the ··· menu icon next to the API Key you wish to delete
4. Click the Delete Connection link
5. Click the Confirm button to finalise deleting partner connection.

App Configuration

Enable manual mode to disable MS Graph API/Azure AD sync

Some organisations may limit access to the Graph API or their Active Directory instance for security reasons. GovAddressBook supports a manual-mode where users can set their own profile details without a sync service running from AD.

To enable manual mode:

1. Open the Azure Portal
2. Open the Resource Group created during the deployment process.
3. In this Resource Group, open the resource called wa-police-directory-teams
4. Click Configuration from the left-hand navigation.
5. Click the Pencil edit icon next to the entry called MANUAL_MODE
6. Change the contents of the Value field to TRUE
7. Click OK to save.

The following functionality is limited in manual-mode:

• No initial profile-sync

  Normally, when a user loads the app for the first time their profile information is drawn from AD. This isn't possible in manual-mode.

• Removal of profile field restrictions

  In the default full-sync mode, end-users are limited to modifying their display name, pronouns and location. In manual-mode, they can edit their basic profile information, including their role, department and contact details.

• No auto-deletion of users

  GovAddressBook normally removes users from the app who have been removed from AD. Manual-mode removes this automatic sync.

• No sync of profile information

  There is no regular synchronisation of profile information from AD. As users' information changes, it will need to be updated in GovAddressBook manually to stay current.

• No out of office sync

  If a user is Out of Office, in manual-mode the Out of Office profile indicator won't show. Currently, there is no way to manually set this.

User management

Admins can manage the profiles of their users from within the app

Editing profile details

1. Open the app as a Global Admin.
2. Open the profile of the user you wish to edit it
3. Click the ··· menu icon next the profile Display Name
4. Click Edit Profile details to edit basic profile information, or click Add new Custom Field to insert a new custom field
5. You can also edit or remove existing custom fields by clicking the Pencil or Bin icons next to each field.

Removing profiles

1. Open the app as a Global Admin.
2. Open the profile of the user you wish to edit it
3. Click the ··· menu icon next the profile Display Name
4. Click the Delete this profile link
5. Click Submit on the confirmation dialog to finish deleting the user. Note: If the user opens the GovAddressBook app again, this will recreate their profile as-new.