THE SAMPLE CODE ON THIS REPOSITORY IS PROVIDED "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT.
THE USAGE OF THIS SAMPLE IS AT YOUR OWN RISK AND THERE IS NO SUPPORT RELATED TO IT.
powerSync is an extension for powerJobs to integrate with Autodesk Construction Cloud (ACC) and Fusion Team.
powerSync requires coolOrange powerJobs to be installed on the Autodesk Vault Job Processor and on the Autodesk Vault Clients.
Coming soon...
Coming soon...
Coming soon...
Coming soon...
Coming soon...
powerSync contains PowerShell functions (cmdlets) for Autodesk Platform Services (APS) OAuth authentication. The cmdlets are bundled in a PowerShell module called powerAPS and support 2-legged and 3-legged OAuth authentication incl. PKCE. including UI for 3-legged user authentication in PowerShell and Autodesk Vault.
OAuth tokens are refreshed automatically during the objects lifespan.
To use it in a PowerShell script, the powerAPS module must be imported:
Import-Module powerAPSOpens a connection to Autodesk Platform Services (APS) using the APS Authentication API. Once connected the global variable $ApsConnection can be used to communicate with APS.
| Parameter | Description | Mandatory | Remarks |
|---|---|---|---|
| ClientId | Client ID of the APS Application | true | |
| ClientSecret | Client Secret of the APS Application | false | Not needed when app is of type 'PKCE' |
| CallbackUrl | URL-encoded callback URL that the end user will be redirected to after completing the authorization flow | false | This must match the pattern of the callback URL field of the APS App's registration Not needed for 2-legged authentication |
| Scope | Please see https://aps.autodesk.com/en/docs/oauth/v2/developers_guide/scopes/ for more details | false | Default: 'data:read data:write' |
| AccountId | Autodesk Account ID (used in the 'x-user-id' Request Header") | false | Not needed when app is 3-legged |
| Username | Autodesk Email Address | false | |
| Password | Autodesk Password | false | |
| Visible | Dialog always visible, even if all required parameters are provided | false | |
| Express | Skip the Username and Consent pages, if possible | false |
3-legged example: fully automated incl. 'Import-Module' and Hubs query
Doesn't displays a login window, automatically fills out username and password and agrees the APS consent. Once authenticated, all APS hubs are listed:
Import-Module powerAPS
$apsParameters = @{
"ClientId" = $clientId
"ClientSecret" = $clientSecret
"CallbackUrl" = $callbackUrl
"Scope" = $scope
"Username" = $username
"Password" = $password
}
$result = Open-APSConnection @apsParameters -Express
if (-not $result) {
throw "Cannot connect to APS"
}
$parameters = @{
"Uri" = "https://developer.api.autodesk.com/project/v1/hubs"
"Method" = "Get"
"Headers" = $ApsConnection.RequestHeaders
}
$response = Invoke-RestMethod @parameters
foreach ($hub in $response.data) {
Write-Host $hub.attributes.name
}3-legged example: username automated
Displays a login window, automatically fills out username and waits until the user enters the password. Once entered, powerAPS automatically agrees the consent and closes the window :
$apsParameters = @{
"ClientId" = $clientId
"ClientSecret" = $clientSecret
"CallbackUrl" = $callbackUrl
"Scope" = $scope
"Username" = $username
}
$result = Open-APSConnection @apsParameters -Express -Visible
...3-legged example: username automated (PKCE)
Displays a login window, fills out username automatically and waits until the user enters the password. Once entered, powerAPS automatically agrees the consent and closes the window:
$apsParameters = @{
"ClientId" = $clientId
"CallbackUrl" = $callbackUrl
"Scope" = $scope
"Username" = $username
}
$result = Open-APSConnection @apsParameters -Express -Visible
...2-legged example
Doesn't displays the login window, no need for username, password or consent:
$apsParameters = @{
"ClientId" = $clientId
"ClientSecret" = $clientSecret
"AccountId" = $accountId
"Scope" = $scope
}
$result = Open-APSConnection @apsParameters
...Closes an existing APS connection and removes the $ApsConnection object.
none
Close-APSConnectionOnce authenticated with Open-ApsConnection this global object is available until Close-ApsConnection is called or the underlying PowerShell session ends.
| Name | Type | Remarks |
|---|---|---|
| Token | String | The bearer token including the prefix "Bearer" |
| Issued | DateTime | The time the token has been issued |
| Lifespan | Integer | The overall lifespan of the token in seconds |
| ExpiresIn | Integer | The remaining lifespan of the token in seconds |
| ValidUntil | DateTime | The time until the token is valid |
| RefreshToken | String | The refresh token that is beeing used for the next automatic refresh |
| ClientId | String | The client ID this token is associated to |
| AuthType | Enum | The type of the authentication. Either 'TwoLegged' or 'ThreeLegged' |
| Scope | String | The scope of the authentication |
| CallbackUrl | String | The callback URL of the authentication |
| Username | String | The username of the authentication |
| RequestHeader | HashTable | A HashTable that can be used for the Invoke-RestMethod header parameter. "Authorization"="<BEARER TOKEN" for 3-legged, and "Authorization"="<BEARER TOKEN" + "x-user-id" = AccountId for 2-legged |
Coming soon...