Working with Cayosoft Administrator Service using Public API

---

Content: 

 

Initiate connection to Cayosoft Administrator Service

Connect-CGraphAdminService 

• [-AuthType <Windows | Office365>]
• [-Credential <PSCredential>]
• [-UserInteractionRequired <Switch>]
• [-Server <string>]
• [-ApplicationID <string>]

 

Description

The Connect-CGraphAdminService attempts to initiate a connection to the Cayosoft Administrator Service. Run this command from a Windows PowerShell.

 

Parameters 

-AuthType

Specifies the authentication type. It can be Office365 or Windows. If the authentication type is not specified, Windows authentication is used.

 

-Credential

Specifies the credential to use to connect to Cayosoft Administrator Service. Specifies the credential to use to connect to Azure Active Directory. To obtain a PSCredential object, use the Get-Credential cmdlet.

 

-UserInteractionRequired

Specifies that user interaction is required to complete the request. 

 

-Server

Specifies the Cayosoft Administrator Service FQDN name.

 

-ApplicationID

Specifies the application ID in Azure AD > App Registrations (Preview) > Cayosoft Administrator API Access.

 

Example 1: Initiate connection to Cayosoft Administrator Service

Connect-CGraphAdminService 

This command attempts to initiate a connection to the local Cayosoft Administrator Service, using Active Directory credentials of the currently logged-in user. Run this command from a Windows PowerShell ISE or command prompt.

 

Example 2: Connect to the local Cayosoft Administrator Service, using Office 365 authentication

$creds = Get-Credential 

Connect-CGraphAdminService -AuthType Office365 -Credential $creds 

 

Example 3: Connect to local Cayosoft Administrator Service, using Office 365 authentication with user interaction

Connect-CGraphAdminService -AuthType Office365 -UserInteractionRequired 

A Sign in to your account dialog would appear. Select or enter the name of the account and password:

If your account is set up with MFA, follow the instructions on the dialog:

 

Example 4: Connect to remote Cayosoft Administrator Service with default port using windows integrated authentication

Connect-CGraphAdminService -Server "<remote host>" 

 

Example 5: Connect to remote Cayosoft Administrator Service on a specific port using windows integrated authentication

Connect-CGraphAdminService -Server "<remote host>:13999"  

 

Example 6: Connect to Cayosoft Administrator Service using O365 authentication and application ID

$creds = Get-Credential 

Connect-CGraphAdminService -AuthType Office365 -Credential $creds -ApplicationId "<appId>" 

 

Enumerating Cayosoft Automation Rules

Example 1: Enumerate Cayosoft Administrator rules

Get-CGraph rules

This command enumerates Cayosoft Administrator rules: call Get-CGraph command with object type rules as a parameter.

  

 

Updating Cayosoft Automation Rules

Example 1: Execute a Cayosoft automation rule by rule name

Set-CGraph rules -Name "RuleName"  

 

Example 2: Execute a Cayosoft automation rule by rule ID

Set-CGraph rules -Identifier "GUID" 

1. Switch to Design mode
2. On Query tab find Rule ID setting
3. Copy Rule ID value

 

Example 3: Execute a Cayosoft runbook by runbook name

Set-CGraph rules -Name "<runbook name>" 

 

Example 4: Execute a Cayosoft runbook by runbook ID

Set-CGraph rules -Identifier <runbook ID>