ProfileBundle
The Profile API requests reference an object of type ProfileBundle. The configuration of the bundle will vary depending on the provided inputs. The following properties define this object.
- activated : Boolean, Whether the profile has been activated.
- licenseExpired : Boolean, Whether the license associated with the profile is expired.
- licenseType : String, The license on which the profile is based.
- permissions : Map<String, Boolean>, Administrative and page permissions assigned to the profile[1]. For this permission category, if the profile does not have the permission it will not be returned. In other words the map will have no false values.
- permissions_content_type : Map<String, Map<String, Boolean>>, Map of content type Id to associated permissions[2].
- permissions_library : Map<String, Map<String, Boolean>>, Map of library Id to associated permissions[2].
- profileId : Boolean, Id of the profile.
- profileName : String, Name of the profile.
- siteLabel : Map<String, Boolean>, Label of the site.
- users : List<UserBundle>, Users assigned to the profile. Retrieval is dependent on request flags.
- when_cached : DateTime, When the profile was last cached (only applicable if Platform Caching is enabled).
[1] For this permission category, if the profile does not have the permission it will not be returned. In other words, the map will have no false values.
[2] For each of these two permission categories, if the profile does not have the permission it will not be included in the inner map. For example, if the profile has no access to a library, the permissions_library property would contain a key of the libarary Id and an empty map as the value.