Example

Resource archiving

Scenario

An Afi partner has an external management system with a user interface for their customers where Microsoft 365 or Google Workspace (G Suite) resources are managed. They want to add an Archive feature to the interface so that a customer can back up a resource's data, then safely remove the resource from their Google Workspace or Microsoft 365 domain and release its license.

Inputs

Since a partner application is managing Microsoft 365 or Google Workspace resources, it should know the corresponding tenant and resource unique IDs in these systems. Such IDs are called 'external' in the API documentation as they refer to identifiers assigned by external systems and allow you to unambiguously refer to the resources in the APIs.

Warning

Note that tenant/domain name, resource email, and its name are all ambiguous identifiers and should be avoided when referring to the object.

API usage diagram