< Back
Connect-Delegate365
Post
NAME Connect-Delegate365
SYNOPSIS
Connects to the API in Delegate365.
SYNTAX
Connect-Delegate365 [-WebApiSasKey] <string> [-WebApiBaseUrl] <string> [<CommonParameters>]
DESCRIPTION
Connect-Delegate365 connects to the API in Delegate365. Use this command to connect to your Delegate365 tenant at
the beginning of any PowerShell commands or scripts. This command requires a WebApiBaseUrl and a WebApiSasKey
parameter. The WebApiBaseUrl is the URI of your Delegate365 tenant, as https://[mycompany].delegate365.com. The
WebApiSasKey must be provided by your Delegate365 Portal Admin. It's a key that identifies your admin account and
is specific for your use. The key is a string as "123456..". Keep this key well and do not hand it over to other
persons, it's your personal access to the API. As output, an informational string is returned. If no error occurs,
it should respond with "successfully connected" within some seconds. After a successful connection is established,
you can start working with the Delegate365 cmdlets. Afterwards, use Disconnect-Delegate365 to close the
connection. Use Get-Command -Module Delegate365 to see a list of available commands in this module, or Get-Help
[command] for information about a specific command. Happy automating with Delegate365!
PARAMETERS
-WebApiSasKey <string>
The API-key can be generated by a Portal Admin in the Delegate365 portal in the administration/administrators
menu for each admin. Select a user and click Edit admin. In the user pane, scroll down to the WebApiKey field
and generate a new key if needed anytime.
Required? true
Position? 0
Default value
Accept pipeline input? false
Accept wildcard characters? false
-WebApiBaseUrl <string>
The Base-URL is the URL of your Delegate365 portal, e.g. https://mycompany.delegate365.com
Required? true
Position? 1
Default value
Accept pipeline input? false
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
OUTPUTS
System.String
---------- EXAMPLE 1 ----------
$apiKey = '123456...'
$baseUrl = 'https://mycompany.delegate365.com'
Connect-Delegate365 -WebApiSasKey $apiKey -WebApiBaseUrl $baseUrl
Connect to your Delegate365 API with your key and your portal-URL.
RELATED LINKS
Delegate365 support https://support.delegate365.com/
SYNOPSIS
Connects to the API in Delegate365.
SYNTAX
Connect-Delegate365 [-WebApiSasKey] <string> [-WebApiBaseUrl] <string> [<CommonParameters>]
DESCRIPTION
Connect-Delegate365 connects to the API in Delegate365. Use this command to connect to your Delegate365 tenant at
the beginning of any PowerShell commands or scripts. This command requires a WebApiBaseUrl and a WebApiSasKey
parameter. The WebApiBaseUrl is the URI of your Delegate365 tenant, as https://[mycompany].delegate365.com. The
WebApiSasKey must be provided by your Delegate365 Portal Admin. It's a key that identifies your admin account and
is specific for your use. The key is a string as "123456..". Keep this key well and do not hand it over to other
persons, it's your personal access to the API. As output, an informational string is returned. If no error occurs,
it should respond with "successfully connected" within some seconds. After a successful connection is established,
you can start working with the Delegate365 cmdlets. Afterwards, use Disconnect-Delegate365 to close the
connection. Use Get-Command -Module Delegate365 to see a list of available commands in this module, or Get-Help
[command] for information about a specific command. Happy automating with Delegate365!
PARAMETERS
-WebApiSasKey <string>
The API-key can be generated by a Portal Admin in the Delegate365 portal in the administration/administrators
menu for each admin. Select a user and click Edit admin. In the user pane, scroll down to the WebApiKey field
and generate a new key if needed anytime.
Required? true
Position? 0
Default value
Accept pipeline input? false
Accept wildcard characters? false
-WebApiBaseUrl <string>
The Base-URL is the URL of your Delegate365 portal, e.g. https://mycompany.delegate365.com
Required? true
Position? 1
Default value
Accept pipeline input? false
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
OUTPUTS
System.String
---------- EXAMPLE 1 ----------
$apiKey = '123456...'
$baseUrl = 'https://mycompany.delegate365.com'
Connect-Delegate365 -WebApiSasKey $apiKey -WebApiBaseUrl $baseUrl
Connect to your Delegate365 API with your key and your portal-URL.
RELATED LINKS
Delegate365 support https://support.delegate365.com/