Difference between revisions of "Adobe Provisioning: Adding Config and Private Key"

From Studentnet Wiki
Jump to navigation Jump to search
(Created page with "==Adobe Configuration== You can either create a project on your own and provide us with the information listed in the following config file example or assign us a role to do s...")
 
 
(10 intermediate revisions by the same user not shown)
Line 15: Line 15:
 
After successfully logging in to [https://www.adobe.com/go/devs_console_ui Adobe Developer Console], you arrive at the '''Home''' screen. This is where you can find quick start links to create a project or download resources, view and edit your public profile, and access the '''Projects''' and '''Downloads''' screens using the top navigation.
 
After successfully logging in to [https://www.adobe.com/go/devs_console_ui Adobe Developer Console], you arrive at the '''Home''' screen. This is where you can find quick start links to create a project or download resources, view and edit your public profile, and access the '''Projects''' and '''Downloads''' screens using the top navigation.
  
−
[[File:Adobe_Image_1.png|540px|Adobe Setup 1]]
+
Click “create new project” to start
 +
 
 +
[[File:adobe_integration_1.png|1100px|Adobe Setup 1]]
  
 
===Step 2: Add an API to the project using Service Account (JWT)===
 
===Step 2: Add an API to the project using Service Account (JWT)===
−
The home screen provides "quick start" links to help you get started with some of the most common Console actions. Quick start links are available for: creating a new project, creating a project using a template, and downloading resources. Click “Create new project” to start
+
Click “Add API”
  
−
[[File:Adobe_Image_2.png|540px|Adobe Setup 2]]
+
[[File:adobe_integration_2.png|1100px|Adobe Setup 2]]
  
  
Line 26: Line 28:
 
Scroll down to select User Management API and click Next
 
Scroll down to select User Management API and click Next
  
−
[[File:Adobe_Image_3.png|540px|Adobe Setup 3]]
+
[[File:adobe_integration_3.png|1100px|Adobe Setup 3]]
  
 
===Step 4: Generate a key pair===
 
===Step 4: Generate a key pair===
 
Select OPTION 1 generate a key pair, click Next, and then save the '''downloaded config.zip '''(containing the public key and '''private key''') for future use
 
Select OPTION 1 generate a key pair, click Next, and then save the '''downloaded config.zip '''(containing the public key and '''private key''') for future use
  
−
[[File:Adobe_Image_4.png|540px|Adobe Setup 4]]
+
[[File:adobe_integration_4.png|1100px|Adobe Setup 4]]
  
 
===Step 5: Save API===
 
===Step 5: Save API===
 
Click Save configured API
 
Click Save configured API
  
−
[[File:Adobe_Image_5.png|540px|Adobe Setup 5]]
+
[[File:adobe_integration_5.png|1100px|Adobe Setup 5]]
  
 
Select User Management API from APIs on the sidebar
 
Select User Management API from APIs on the sidebar
  
−
[[File:Adobe_Image_6.png|540px|Adobe Setup 6]]
+
[[File:adobe_integration_6.png|1100px|Adobe Setup 6]]
  
 
Click Retrieve client secret to get '''client secret'''
 
Click Retrieve client secret to get '''client secret'''
  
−
[[File:Adobe_Image_7.png|540px|Adobe Setup 7]]
+
[[File:adobe_integration_7.png|1100px|Adobe Setup 7]]
  
 
Save '''client id''', '''client secret''', '''technical account id''', '''organization id''' for configuration
 
Save '''client id''', '''client secret''', '''technical account id''', '''organization id''' for configuration
  
−
[[File:Adobe_Image_8.png|540px|Adobe Setup 8]]
+
[[File:adobe_integration_8.png|1100px|Adobe Setup 8]]
  
 
Open Cloudwork, click Adobe Coherent Cloud
 
Open Cloudwork, click Adobe Coherent Cloud
  
−
[[File:Adobe_Image_9.png|540px|Adobe Setup 9]]
+
[[File:adobe_integration_9.png|1100px|Adobe Setup 9]]
  
 
Go to Adobe page
 
Go to Adobe page
  
−
[[File:Adobe_Image_10.png|540px|Adobe Setup 10]]
+
[[File:new_adobe_1.png|1100px|Adobe Setup 10]]  
  
−
Click add new config details
+
Click '''Add new Adobe config'''
 +
Fill Org Id, Client Id, Client Secret, Tech Acct, and input the school’s domain
  
−
[[File:Adobe_Image_11.png|540px|Adobe Setup 11]]
+
[[File:new_adobe_2.png|1100px|Adobe Setup 11]]  
  
−
Fill Org Id, Client Id, Client Secret, Tech Acct, and leave it for a while
+
And select username field in Adobe console
  
−
===Step 6: Get the domain information for config===
+
[[File:new_adobe_3.png|1100px|Adobe Setup 12]]  
−
Log in to [https://adminconsole.adobe.com/ Adobe administrator console]
 
  
−
[[File:Adobe_Image_12.png|540px|Adobe Setup 12]]
+
[[File:Adobe_3.5.png|1100px|Adobe Setup 12.5]]
  
−
[[File:Adobe_Image_13.png|540px|Adobe Setup 13]]
+
[[File:Adobe_Integration_3.6.png|1100px|Adobe Setup 12.6]]
  
−
Click Settings
+
You can see '''New Config created''', then the next step is to upload the private key.
 +
Click '''Please Upload Private Key Here''' to upload.
  
−
[[File:Adobe_Image_14.png|540px|Adobe Setup 14]]
+
[[File:new_adobe_4.png|1100px|Adobe Setup 13]]
  
−
Click Domains
+
Upload the private key.
  
−
[[File:Adobe_Image_14.png|540px|Adobe Setup 14]]
+
[[File:new_adobe_5.png|1100px|Adobe Setup 14]]
  
−
The domain is needed for the configuration to retrieve users from a domain linked to an organization through the Trusted Domain relationship, the domain will match the email domain. Copy a '''domain''' matching the school’s email domain.
+
If successful, you will be redirected to the Adobe page and see the green flashing
  
−
Go back to the form, and paste the domain. Submit.
+
[[File:new_adobe_6.png|1100px|Adobe Setup 15]]
  
−
[[File:Adobe_Image_11.png|540px|Adobe Setup 15]]
+
Click on the domain, you will see the private key uploaded has been changed to '''yes'''
  
−
You can see the flash “New Config Created”, and Private Key Uploaded is still no.
+
[[File:new_adobe_7.png|1100px|Adobe Setup 16]]
  
−
[[File:Adobe_Image_16.png|540px|Adobe Setup 16]]
+
If you want to select groups to be synced to Adobe Console, click '''Edit''' on '''Group Sync Selections''' table
  
−
Head back to the '''Adobe''' page, you can see the updated config list.
+
[[File:new_adobe_8.png|1100px|Adobe Setup 17]]
  
−
[[File:Adobe_Image_17.png|540px|Adobe Setup 17]]
+
Select groups and submit
  
−
The next step is to upload the private key
+
If you want to select OU to be synced to Adobe Console, click '''Edit''' on '''OU Sync Selections''' table
  
−
Check the format of the private key, and click Choose file to upload the selected private key
+
[[File:new_adobe_9.png|1100px|Adobe Setup 18]]
  
−
[[File:Adobe_Image_18.png|540px|Adobe Setup 18]]
+
Select OU and submit
  
−
The uploaded file should end with '''.key'''
+
A green flash will indicate the selection succeeds and group names will show in the '''OU Sync Selections''' table.
  
−
[[File:Adobe_Image_19.png|540px|Adobe Setup 19]]
+
[[File:new_adobe_10.png|1100px|Adobe Setup 20]]
−
 
 
−
And the file should exactly follow the format in the example
 
−
 
 
−
[[File:Adobe_Image_20.png|540px|Adobe Setup 20]]
 
−
 
 
−
If the uploaded file is not compatible with input config details, you will be redirected to the Adobe page and seeing the red flashing message
 
−
 
 
−
[[File:Adobe_Image_21.png|540px|Adobe Setup 21]]
 
−
 
 
−
 
 
−
If successful, you will be redirected to the Adobe page and see the green flashing
 
  
−
[[File:Adobe_Image_22.png|540px|Adobe Setup 22]]
 
  
−
Click on the domain, you will see the private key uploaded has been changed to “yes”
+
==How does Syncing work==
 +
If you have allowed the 'Sync User to Adobe' and 'Sync Groups to Adobe':
 +
Then by selecting OU or Groups under OU Sync Selection and Group Sync Selection respectively, you can select which OUs and Groups get synced.
 +
*OU syncing: By selecting the OU from Cloudwork's in the Adobe Sync from Cloudwork, users from those OUs will be synced to Adobe.
 +
*Group Syncing: By selecting groups from Cloudwork's in Adobe sync from Cloudwork, users who are already synced to Adobe will be put into User directories in Adobe. Users who are in the groups but not synced to Adobe will not be synced to Adobe.
  
  
−
[[File:Adobe_Image_23.png|540px|Adobe Setup 23]]
+
[[Category:Cloudwork Dashboard]]

Latest revision as of 06:31, 15 February 2023

Adobe Configuration

You can either create a project on your own and provide us with the information listed in the following config file example or assign us a role to do so. If you want to create your own project, you can follow the procedure shown below:

Information needed for configuration:

  • Federated domain
  • Organization id
  • Client id
  • Client secret
  • Technical account id
  • Private key

The information can be obtained from the following steps

Step 1: Create a project in Adobe developer console

After successfully logging in to Adobe Developer Console, you arrive at the Home screen. This is where you can find quick start links to create a project or download resources, view and edit your public profile, and access the Projects and Downloads screens using the top navigation.

Click “create new project” to start

Adobe Setup 1

Step 2: Add an API to the project using Service Account (JWT)

Click “Add API”

Adobe Setup 2


Step 3: Create a User Management API

Scroll down to select User Management API and click Next

Adobe Setup 3

Step 4: Generate a key pair

Select OPTION 1 generate a key pair, click Next, and then save the downloaded config.zip (containing the public key and private key) for future use

Adobe Setup 4

Step 5: Save API

Click Save configured API

Adobe Setup 5

Select User Management API from APIs on the sidebar

Adobe Setup 6

Click Retrieve client secret to get client secret

Adobe Setup 7

Save client id, client secret, technical account id, organization id for configuration

Adobe Setup 8

Open Cloudwork, click Adobe Coherent Cloud

Adobe Setup 9

Go to Adobe page

Adobe Setup 10

Click Add new Adobe config Fill Org Id, Client Id, Client Secret, Tech Acct, and input the school’s domain

Adobe Setup 11

And select username field in Adobe console

Adobe Setup 12

Adobe Setup 12.5

Adobe Setup 12.6

You can see New Config created, then the next step is to upload the private key. Click Please Upload Private Key Here to upload.

Adobe Setup 13

Upload the private key.

Adobe Setup 14

If successful, you will be redirected to the Adobe page and see the green flashing

Adobe Setup 15

Click on the domain, you will see the private key uploaded has been changed to yes

Adobe Setup 16

If you want to select groups to be synced to Adobe Console, click Edit on Group Sync Selections table

Adobe Setup 17

Select groups and submit

If you want to select OU to be synced to Adobe Console, click Edit on OU Sync Selections table

Adobe Setup 18

Select OU and submit

A green flash will indicate the selection succeeds and group names will show in the OU Sync Selections table.

Adobe Setup 20


How does Syncing work

If you have allowed the 'Sync User to Adobe' and 'Sync Groups to Adobe': Then by selecting OU or Groups under OU Sync Selection and Group Sync Selection respectively, you can select which OUs and Groups get synced.

  • OU syncing: By selecting the OU from Cloudwork's in the Adobe Sync from Cloudwork, users from those OUs will be synced to Adobe.
  • Group Syncing: By selecting groups from Cloudwork's in Adobe sync from Cloudwork, users who are already synced to Adobe will be put into User directories in Adobe. Users who are in the groups but not synced to Adobe will not be synced to Adobe.
Retrieved from "https://wiki.studentnet.net/index.php?title=Adobe_Provisioning:_Adding_Config_and_Private_Key&oldid=2043"