Profile Management APIs
Get Profile Colors (GET)
Returns available colors for profile visualization.
Route
|
URI |
/api/v1/Profiles/Colors |
|
Method |
GET |
|
Result |
JSON - Array of ColorModel |
Parameters
None
Example
GET http://localhost/api/v1/Profiles/Colors
Get Profile Configuration (GET)
Returns profile configuration settings.
Route
|
URI |
/api/v1/Profiles/Configuration |
|
Method |
GET |
|
Result |
JSON – ProfileConfigurationModel |
Parameters
None
Example
GET http://localhost/api/v1/Profiles/Configuration
{
"Type": "Container",
"label": null,
"templates": [
{
"key": "are_unassigned_accounts_non_compliant",
"value": {
"Type": "Checkbox",
"summary": "True",
"value": true,
"defaultValue": true,
"isRequired": false,
"description": null,
"customError": null,
"allowApply": true,
"label": "Treat accounts without department profiles as non-compliant.",
"isEnabled": true,
"isEnabledRule": null,
"parsedIsEnabledRule": null,
"customAttributes": null,
"isHidden": false,
"isVisibleRule": null,
"parsedIsVisibleRule": null
}
}
],
"summary": null,
"customAttributes": null,
"isHidden": false,
"isVisibleRule": null,
"parsedIsVisibleRule": null
}
Get Profiles (GET)
Returns all available profiles.
Route
|
URI |
/api/v1/Profiles |
|
Method |
GET |
|
Result |
JSON – Array of ProfileModel |
Parameters
Query parameters for filtering profiles.
Example
GET http://localhost/api/v1/Profiles
Create or Update Profile (POST)
Creates a new profile or updates an existing one.
Route
|
URI |
/api/v1/Profiles/CreateUpdate |
|
Method |
POST |
|
Result |
JSON – ProfileCreationResult |
Parameters
Body: ProfileModel
Example
POST http://localhost/api/v1/Profiles/CreateUpdate
Content-Type: application/json
{profile definition}
Delete Profile (DELETE)
Deletes a profile.
Route
|
URI |
/api/v1/Profiles/Delete |
|
Method |
DELETE |
|
Result |
JSON – ProfileDeletionResult |
Parameters
Query parameters for profile identification.
Example
DELETE http://localhost/api/v1/Profiles/Delete?profileId=guid
Get Profile Additional Information (GET)
Returns additional information for profiles.
Route
|
URI |
/api/v1/Profiles |
|
Method |
GET |
|
Result |
JSON – ProfileAdditionalInfoModel |
Parameters
Query parameters for profile identification.
Example
GET http://localhost/api/v1/Profiles?AdditionalProfileInformation=2a139057-cfd0-4410-b0ea-d834f775a098
Example Response
[
{
"Type": "6E2B77D2-22A8-44D7-BAB0-852573F89227",
"id": "62f8bef4-d836-4dd7-85e2-c76bd558dec4",
"name": "Test",
"description": "",
"color": 15,
"initials": "T",
"creationDateTimeLocal": "2/26/2025",
"lastModifiedDateTimeLocal": "2/26/2025",
"groups": [],
"ldapAttributes": []
},
{
"Type": "6E2B77D2-22A8-44D7-BAB0-852573F89227",
"id": "2a139057-cfd0-4410-b0ea-d834f775a098",
"name": "Test1",
"description": "",
"color": 5,
"initials": "T",
"creationDateTimeLocal": "4/8/2025",
"lastModifiedDateTimeLocal": "4/8/2025",
"groups": [],
"ldapAttributes": []
},
{
"Type": "6E2B77D2-22A8-44D7-BAB0-852573F89227",
"id": "a0c054f6-1f2f-43c0-a072-27c6ebdae05c",
"name": "Test2",
"description": "",
"color": 4,
"initials": "T",
"creationDateTimeLocal": "4/8/2025",
"lastModifiedDateTimeLocal": "4/8/2025",
"groups": [],
"ldapAttributes": []
}
]
Get Profile Attributes (GET)
Returns attributes defined for profiles.
Route
|
URI |
/api/v1/Profiles/Attributes |
|
Method |
GET |
|
Result |
JSON – Array of AttributeModel |
Parameters
None
Example
GET http://localhost/api/v1/Profiles/Attributes
{
"Type": "LdapAttributePicker",
"availableAttributes": [
{
"key": "accountexpires",
"value": {
"Type": "DatePicker",
"scriptParameterFormat": null,
"summary": "1/1/0001",
"startDateMayBeInThePast": false,
"value": "0001-01-01T00:00:00",
"defaultValue": "0001-01-01T00:00:00",
"isRequired": false,
"description": null,
"customError": null,
"allowApply": true,
"label": "Account Expires",
"isEnabled": true,
"isEnabledRule": null,
"parsedIsEnabledRule": null,
"customAttributes": null,
"isHidden": false,
"isVisibleRule": null,
"parsedIsVisibleRule": null
}
},
{
"key": "comment",
"value": {
"Type": "TextField",
"postfixText": null,
"dynamicQuery": null,
"dynamicResultWasSet": false,
"isRequired": false,
"constraints": {
"$type": "pn.formTemplates.resourceTemplates.TextInputConstraints, pn.formTemplates",
"isDirty": false,
"creationRule": null,
"maxLength": 1024,
"forbiddenChars": null,
"isRequired": false,
"validationRule": null,
"validationInformation": null,
"allowOnlyDefinedValues": false,
"definedValues": null,
"uniquenessConstraint": null
},
"summary": null,
"value": null,
"defaultValue": null,
"description": null,
"customError": null,
"allowApply": true,
"label": "Comment",
"isEnabled": true,
"isEnabledRule": null,
"parsedIsEnabledRule": null,
"customAttributes": null,
"isHidden": false,
"isVisibleRule": null,
"parsedIsVisibleRule": null
}
},
…
]
}
Get Profile Attributes By Account (GET)
Returns profile attributes for a specific account.
Route
|
URI |
/api/v1/Profiles/AttributesByAccount |
|
Method |
GET |
|
Result |
JSON – Array of AttributeModel |
Parameters
Query parameters for account identification.
Example
GET http://localhost/api/v1/Profiles/AttributesByAccount?accountId=guid
Get Profile Groups By Account (GET)
Returns profile groups for a specific account.
Route
|
URI |
/api/v1/Profiles/GroupsByAccount |
|
Method |
GET |
|
Result |
JSON – Array of GroupModel |
Parameters
Query parameters for account identification.
Example
GET http://localhost/api/v1/Profiles/GroupsByAccount?accountId=guid
Get Assignments By Profile ID (GET)
Returns assignments for a specific profile.
Route
|
URI |
/api/v1/Profiles/AssignmentsByProfileId |
|
Method |
GET |
|
Result |
JSON – Array of AssignmentModel |
Parameters
Query parameters for profile identification.
Example
GET http://localhost/api/v1/Profiles/AssignmentsByProfileId?profileId=guid