Exporting Global and Property Settings

Settings (detailed in the article API Client Settings) play a key role in determining how your Identity Cloud implementation actually works. Which flow should your logon_client properties use? There’s a setting for that. Where should users be redirected if they forget their password? There’s a setting for that. How many failed logins should a user be allowed before he or she is temporarily locked out of the system? There’s a setting for that, too

Monitoring and managing these settings (and ensuring that they adhere to organization standards) is important; at the same time, this has also been somewhat difficult to carry out, especially in organizations with scores of properties. Yes, the settings are readily available, but those settings are also scattered throughout the Console: global settings are only available on the Manage Applications page, and property settings are only found on the individual property pages. If you have 100 properties, you need to visit 101 different pages (1 application page and 100 property pages) to retrieve all your settings.

Note: Or at least to view all your settings. Retrieving those settings (for example, copying those settings and values to a spreadsheet) has always been even more complicated than viewing all the settings.

However, and as you might have guessed, that’s all in the past. Now, you can retrieve copies of all your global and property settings. In fact, you can:

  • Export your global settings and the settings for all your properties (see below).
  • Export your global settings and the settings for a selected subset of your properties. For example, you can get the application settings along with the settings for, say, just your logon_client properties.

In this documentation, we’ll explain how you can do all of that.

Note: No, there’s no way to export just property settings. The global settings always “come along for the ride,” and with good reason: by default, properties inherit any settings configured at the global scope. Without the global settings you don’t really know exactly how a property has been configured. But your settings are all exported as a comma-separated values file. If you don’t want the global settings for some reason, then just open that file in a spreadsheet program and delete the row containing the global settings.

Exporting All Your Settings

Assuming that you have the required permissions, you should see an Export Settings button when you access the Manage Application page:

Note: Who does have the required permissions? You do, provided that you hold one of the following agent roles:
  • Application Admin
  • Application Configuration Admin
  • Application Configuration Manager
  • Application Configuration Viewer
  • Property Configuration Manager

If you click the Export Settings button your global settings (and all your property settings) are downloaded in comma-separated values format to the Downloads folder on your local computer. The file you download will have a filename similar to this, with knz9cs653cue3ts3hw8vwuh5fz representing your application ID (as seen on the Manage Application page):

knz9cs653cue3ts3hw8vwuh5fz_settings.csv

And what do you get when you download settings from the Manage Application page? Your downloaded file, when opened as a spreadsheet, will look similar to this:

For the most part, the file (and its contents) are self-explanatory:

  • In the first row, you have the setting names (for example, email_method).
  • In the second row, you have the global setting values. In this example, the global value for the email_method setting is ses_sync and the value of the login_attempts setting is 5.

    Note , too that the client name is set to Global and the client ID is set to N/A. That’s how you know that these are the global settings and not property settings.

  • In the third row (and in subsequent rows), you have setting values for the individual properties (ProfileSync.Service, Developer Test Property, etc.). Each property has its own collection (row) of settings.

When you export your settings, you only get back values for settings that have been explicitly configured (at either the global or the property scope); you will not get back values for any settings that haven’t been configured. What does that mean? Well, in the preceding example you might have noticed that, of the nine properties, only two (Direct Access Test and LATAM Login) show a setting value:

That means that the login_attempts setting was explicitly configured for those two properties, but was not configured for the other properties. In turn, that means that those properties use the default value configured at the global scope.

Note: For more information on how properties inherit settings, and what happens when global and property settings collide, see the article Managing Global Settings.