Adopted script originally created by zincarla (https://github.com/zincarla/AdobeUMInterface) and converted it to a PowerShell Module for Azure Automation, providing cmdlets to communicate with the Adobe User Management API.
Available from PowerShell Gallery:
https://www.powershellgallery.com/packages/AdobeUM.AzureAD
See the following link for an example Runbook the Syncs an Azure AD Group with an Adobe Group:
https://github.com/mrptsai/AdobeUMRunbook
Description
Import a certificate with a private key from file
Parameters
- CertPwd - Password to open PFX Bitbucket UserID and Password
- CertPath - Path to PFX File (ClientID) and Secret
Examples
Import-PFXCert `
-CertPwd "ASDF"
-CertPath "C:\Cert.pfx"Description
Converts a byte[], to a Base64URL encoded string
Parameters
- Item - A byte[]
Examples
ConvertTo-Base64URL `
-Item "VGhpcyBpcyBhIHRlc3Q="Description
Converts a Base64Url string, to a decoded ASCII string.
Parameters
- Item - A base64url string Bitbucket Account
Examples
ConvertFrom-Base64URL `
-Item "VGhpcyBpcyBhIHRlc3Q"Description
Converts a Base64Url string, to a .Net base64 string.
Parameters
- Item - A base64url string
Examples
ConvertFrom-Base64URLToBase64 `
-Item "VGhpcyBpcyBhIHRlc3Q"Description
Converts a Base64Url string, to a decoded ASCII string.
Parameters
- Item - A base64url string Bitbucket Account
Examples
ConvertFrom-Base64URL `
-Item "VGhpcyBpcyBhIHRlc3Q"Description
Converts the [datetime] object passed into a java compliant numerical representation. (milliseconds since 1/1/1970).
Parameters
- DateTimeObject - A DateTime to be converted
Examples
ConvertTo-JavaTime `
-DateTimeObject ([DateTime]::Now)Description
Converts the java compliant numerical representation of time to a .net [datetime] object.
Parameters
- Item - A base64url string Bitbucket Account
Examples
ConvertFrom-Base64URL `
-Item "VGhpcyBpcyBhIHRlc3Q"Description
Converts the [datetime] object passed into a java compliant numerical representation. (milliseconds since 1/1/1970).
Parameters
- JavaTime - A JavaTime to be converted
Examples
ConvertFrom-JavaTime `
-JavaTime 1500000000000Description
Converts the java compliant numerical representation of time to a .net [datetime] object.
Parameters
- Item - A base64url string Bitbucket Account
Examples
ConvertFrom-Base64URL `
-Item "VGhpcyBpcyBhIHRlc3Q"Description
Creates an object to contain client information such as service account details.
Parameters
- APIKey - Your service account's APIkey/ClientID as returned by https://console.adobe.io/
- OrganizationID - Your OrganizationID as returned by https://console.adobe.io/
- ClientSecret - Your service account's ClientSecret as returned by https://console.adobe.io/
- TechnicalAccountID - Your service account's TechnicalAccountID as returned by https://console.adobe.io/
- TechnicalAccountEmail - Your service account's TechnicalAccountEmail as returned by https://console.adobe.io/
Outputs
ClientInformation object to be passed to further commands
Examples
New-ClientInformation `
-APIKey "1111111111111222222333" `
-OrganizationID "22222222222222@AdobeOrg" `
-ClientSecret "xxxx-xxxx-xxxx-xxxx" `
-TechnicalAccountID "[email protected]" `
-TechnicalAccountEmail "[email protected]"Description
Adds an adobe auth token to the ClientInformation object passed to it
Parameters
- ClientInformation - Your ClientInformation object
- SignatureCert - Your OrganizationID as returned by https://console.adobe.io/
- ClientSecret - The cert that is attached to the specified account. Must have private key. Check which cert at https://console.adobe.io/
- AuthTokenURI - URI of the Adobe Auth Service. Defaults to https://ims-na1.adobelogin.com/ims/exchange/jwt/
- ExpirationInHours - When the request token should expire in hours. Defaults to 1
Outputs
Attached auth token to ClientInformation.Token
Notes
Create JWT
- https://www.adobe.io/apis/cloudplatform/console/authentication/createjwt/jwt_nodeJS.html
- https://github.com/lambtron/nextbus/blob/master/node_modules/jwt-simple/lib/jwt.js
- https://jwt.io/
Examples
Get-AdobeAuthToken `
-ClientInformation $MyClient `
-SignatureCert $Cert `
-ExpirationInHours 12Description
Gets all users from the adobe API
Parameters
- ClientInformation - Your ClientInformation object
- UM_Server - The adobe user management uri. Defaults to "https://usermanagement.adobe.io/v2/usermanagement/"
Notes
Examples
Get-AdobeUsers `
-ClientInformation $MyClientDescription
Grab a list of all groups, or if provided an ID, returns the group related to the ID
Parameters
- ClientInformation - Your ClientInformation object
- UM_Server - The adobe user management uri. Defaults to "https://usermanagement.adobe.io/v2/usermanagement/"
- GroupID - If you wish to query for a single group instead, put the group ID here
Notes
Examples
Get-AdobeGroups `
-ClientInformation $MyClientDescription
Grab a list of all groups, or if provided an ID, returns the group related to the ID
Parameters
- ClientInformation - Your ClientInformation object
- UM_Server - The adobe user management uri. Defaults to "https://usermanagement.adobe.io/v2/usermanagement/"
- GroupID - If you wish to query for a single group instead, put the group ID here
Notes
Examples
Get-AdobeGroups `
-ClientInformation $MyClient
Get-AdobeGroups `
-ClientInformation $MyClient `
-GroupID "222242"Description
Grab all members of the specified group
Parameters
- ClientInformation - Your ClientInformation object
- UM_Server - The adobe user management uri. Defaults to "https://usermanagement.adobe.io/v2/usermanagement/"
- GroupID - The ID of the group to query
Notes
Examples
Get-AdobeGroupMembers `
-ClientInformation $MyClient
-GroupID "222424"Description
Grab all admins of the specified group
Parameters
- ClientInformation - Your ClientInformation object
- UM_Server - The adobe user management uri. Defaults to "https://usermanagement.adobe.io/v2/usermanagement/"
- GroupID - The ID of the group to query
Notes
Examples
Get-AdobeGroupAdmins `
-ClientInformation $MyClient
-GroupID "222424"Description
Creates a "CreateUserRequest" object. This object can then be converted to JSON and sent to create a new user
Parameters
- FirstName - User's First name
- LastName - User's Last Name
- Email - User's Email and ID
- Country - Defaults to AU. This cannot be changed later. (Per adobe documentation)
- AdditionalActions - An array of additional actions to add to the request. (Like add to group)
Notes
See:
https://www.adobe.io/apis/cloudplatform/usermanagement/docs/samples/samplemultiaction.html
This should be posted to:
https://usermanagement.adobe.io/v2/usermanagement/action/{myOrgID}
Examples
New-CreateUserRequest `
-FirstName "John"
-LastName "Doe"
-Email "[email protected]"
New-CreateUserRequest `
-FirstName "John"
-LastName "Doe"
-Email "[email protected]"
-Country "NZ"Description
Creates a "RemoveUserRequest" object. This object can then be converted to JSON and sent to remove a user from adobe
Parameters
- UserName - User's ID, usually e-mail
- AdditionalActions - An array of additional actions to add to the request. (Like add to group)
Notes
See:
https://www.adobe.io/apis/cloudplatform/usermanagement/docs/samples/samplemultiaction.html
This should be posted to:
https://usermanagement.adobe.io/v2/usermanagement/action/{myOrgID}
Examples
New-RemoveUserRequest `
-UserName "[email protected]"Description
Creates a "UpdateUserRequest" object. This object can then be converted to JSON and sent to update an existing user
Parameters
- UserName - User's ID, usually e-mail
- AdditionalActions - An array of additional actions to add to the request. (Like add to group)
Notes
See:
https://www.adobe.io/apis/cloudplatform/usermanagement/docs/samples/samplemultiaction.html
This should be posted to:
https://usermanagement.adobe.io/v2/usermanagement/action/{myOrgID}
Examples
New-UpdateUserRequest `
-UserName "[email protected]"Description
Creates a request to remove a user from an Adobe group. This will need to be posted after being converted to a JSON
Parameters
- UserName - User's ID, usually e-mail
- GroupName - User's ID, usually e-mail
Notes
See:
https://www.adobe.io/apis/cloudplatform/usermanagement/docs/samples/samplemultiaction.html
This should be posted to:
https://usermanagement.adobe.io/v2/usermanagement/action/{myOrgID}
Examples
New-RemoveUserFromGroupRequest `
-UserName "[email protected]" `
-GroupName "My User Group"Description
Creates a "Add to group" action. Actions fall under requests. This will have to be added to a request, then json'd and submitted to adobe's API
Parameters
- Groups - An array of groups that something should be added to
Notes
See:
https://www.adobe.io/apis/cloudplatform/usermanagement/docs/samples/samplemultiaction.html
This should be posted to:
https://usermanagement.adobe.io/v2/usermanagement/action/{myOrgID}
Examples
New-GroupUserAddAction `
-Groups "My User Group"Description
Creates a "Remove from group" action. Actions fall under requests. This will have to be added to a request, then json'd and submitted to adobe's API
Parameters
- Groups - An array of groups that something should be added to
Notes
See:
https://www.adobe.io/apis/cloudplatform/usermanagement/docs/samples/samplemultiaction.html
This should be posted to:
https://usermanagement.adobe.io/v2/usermanagement/action/{myOrgID}
Examples
New-GroupUserRemoveAction `
-Groups "My User Group"Description
Creates a "Add user to group" request. This will need to be json'd and sent to adobe
Parameters
- Groups - An array of groups that something should be added to
- User - A User to be added to the Group(s)
Notes
See:
https://www.adobe.io/apis/cloudplatform/usermanagement/docs/samples/samplemultiaction.html
This should be posted to:
https://usermanagement.adobe.io/v2/usermanagement/action/{myOrgID}
Examples
New-AddToGroupRequest `
-Groups "My User Group"
-User "[email protected]"Description
Creates a "Remove user from group" request. This will need to be json'd and sent to adobe
Parameters
- Groups - An array of groups that something should be removed from
- User - A User to be removed from the Group(s)
Notes
See:
https://www.adobe.io/apis/cloudplatform/usermanagement/docs/samples/samplemultiaction.html
This should be posted to:
https://usermanagement.adobe.io/v2/usermanagement/action/{myOrgID}
Examples
New-RemoveFromGroupRequest `
-Groups "My User Group"
-User "[email protected]"Description
Unpacks a JWT object into it's header, and body components. (Human readable format)
Parameters
- JWTObject - JWT To unpack. In format of {Base64Header}.{Base64Body}.{Base64Signature}
- SigningCert - A certificate with the necesary public key to verify signature block. Can be null, will not validate signature.
Notes
See:
https://www.adobe.io/apis/cloudplatform/usermanagement/docs/samples/samplemultiaction.html
This should be posted to:
https://usermanagement.adobe.io/v2/usermanagement/action/{myOrgID}
Examples
Expand-JWTInformation `
-JWTObject "xxxx.xxxx.xxx"Description
Sends a request, or array of requests, to adobe's user management endpoint
Parameters
- ClientInformation - ClientInformation object containing service account info and token
- Requests - An array of requests to send to Adobe.
Notes
See:
Create-*Request
Examples
Send-UserManagementRequest `
-ClientInformation $MyClientInfo `
-Requests ( `
New-CreateUserRequest `
-FirstName "John" `
-LastName "Doe" `
-Email "[email protected]" `
-Country="AU" `
)Description
Creates an array of requests that, when considered together, ensures an Adobe group will mirror an Azure AD group
Parameters
- ADGroupID - Azure AD Group Identifier. The source group to mirror to Adobe
- AdobeGroupID - Adobe group ID as retured from Get-AdobeGroups
- ClientInformation - Service account information including token
Examples
New-SyncADGroupRequest `
-ADGroupID "SG-My-Approved-Adobe-Users" `
-AdobeGroupID "111222422" `
-ClientInformation $MyClientInfoDescription
Creates an array of requests that, when considered together, removes all users that are not admins, and not part of any user groups
Parameters
- ClientInformation - Service account information including token
Examples
New-RemoveUnusedAbobeUsersRequest `
-ClientInformation $MyClientInfo- Azure Tenant
- Azure Automation Account
Github for version control.
- Paul Towler - Initial work - AdobeUM.AzureAD
See also the list of contributors who participated in this project.
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent