Manage Guest Templates, Policies, and Owners

EasyLife 365 Collaboration API enables the management of guest account templates, policies, and owners.

Permissions

Permission Type	Permissions (Scope)
Delegated (work or school account)	https://api.easylife365.cloud/admin/Config.ReadWrite.All
Application	https://api.easylife365.cloud/admin/Collab.Manage.ReadWrite.All, https://api.easylife365.cloud/admin/Collab.Config.ReadWrite.All

note

Either application permission grants access to this endpoint. Collab.Manage.ReadWrite.All is limited to the manage endpoints, while Collab.Config.ReadWrite.All also grants the rest of the EasyLife 365 Collaboration administration API. Entra ID does not infer one role from the other, so the application must hold at least one of them explicitly.

Application permissions always require admin consent. See Create Application Registration for the app-only setup.

HTTP Request

PATCH https://api.easylife365.cloud/admin/collab/v1/manage/guests/{guest-id}/
Content-Type: application/json

HTTP Request Headers

Header	Value
Authorization	Bearer token. (Required)
Content-Type	application/json

Request Body

Property	Type	Description
templateId	String	ID of the Guest Template (Optional)
policyId	String	ID of the Guest Policy (Optional)
primaryOwnerId	String	Entra ID of the Guest's primary owner (Optional)
secondaryOwnerId	String	Entra ID of the Guest's secondary owner (Optional)

Consider the following basic rules

• all values are optional. If you do not specify and value, no change will be applied
• if you want to assign a template and the policy, you need to specify both values explicitly
• if you want to clear a value (e.g. removing a policy), then pass as a value "00000000-0000-0000-0000-000000000000"

Rules

• All fields are optional. If a value is not specified, no changes will be made.
• To assign both a template and policy, you must explicitly specify both values.
• To clear a field (e.g., removing a policy), use "00000000-0000-0000-0000-000000000000" as the value.

Response

A successful request returns the updated guest account information.

Example 1: Assign a template and a policy to the guest

This example assigns a template and policy to the guest account with ID 57523d68-2913-4fc0-8f91-af100f37562f.

PATCH https://api.easylife365.cloud/admin/collab/v1/manage/guests/57523d68-2913-4fc0-8f91-af100f37562f/
Content-Type: application/json

{
  "templateId": "3b20926e-8ff5-4d8a-b0c6-ddd765df6821",
  "policyId": "ad869549-d693-4d20-8879-402d5ed3d991"
}

Example 2: Clear the policy for a guest

This example clears the policy for the guest with ID 57523d68-2913-4fc0-8f91-af100f37562f.

PATCH https://api.easylife365.cloud/admin/collab/v1/manage/guests/57523d68-2913-4fc0-8f91-af100f37562f/
Content-Type: application/json

{
  "policyId": "00000000-0000-0000-0000-000000000000"
}

Example 3: Assign a primary and secondary owner to a guest

This example assigns a primary and secondary owner to the guest with ID 57523d68-2913-4fc0-8f91-af100f37562f.

PATCH https://api.easylife365.cloud/admin/collab/v1/manage/guests/57523d68-2913-4fc0-8f91-af100f37562f/
Content-Type: application/json

{
  "primaryOwnerId": "00d0c474-abd1-4dda-a516-646a5046647c",
  "secondaryOwnerId": "56a64fe6-4de3-4489-9719-0a3776c7399b"
}