error message not clear enough when Special roles assignment is not possible via ManagePersonsAPI

[ThomasL]

There are seven special roles which cannot be assigned to users via Manage Persons API: Favorite Views Owner, Financial Manager, CMP Agent, MT Administrator, MT Agent, Tenant Admin Role, Strong Identity Validation Bypass.
The output of the Job Status is 'Finished with error' with the reason that these roles don't exist, which is misleading.

I have two suggestions:
1. add the information that seven special roles cannot be assigned to users via Manage Persons API to the Manage Person API document (https://docs.microfocus.com/itom/SMAX:2020.11/ManagePersonsAPI).
2. change the reason for the Job Status 'Finished with error' due to special roles from 'roles don't exist' to 'special roles cannot be assigned via Manage Persons API'.

[Brindusa Kevorkian]

Hello,

The roles are supported to be assigned using the API, but the "internal" role names are slightly different than the names visible in the UI.

Please try using the following names:

FavoritesAdminRole
tenantAdmin
CMPAgent
MTAgent
MTAdministrator
Reauthentication Bypass
Financial manager

This payload works for me:

{
	"operation": "CREATE_OR_UPDATE",
	"users": [{
		"properties": {
			"Upn": "brindusa"
		},
		"roles": {
			"ADD": [
				"tenantAdmin",
				"FavoritesAdminRole",
				"CMPAgent",
				"MTAgent",
				"MTAdministrator",
				"Reauthentication Bypass",
				"Financial manager"
			]
		}

	}]
}

Best regards,

Brindusa

[Steve Anderson SMA-X]

Thank you for sharing your idea! It’s open for comments and kudos, and we’re looking forward to input from the community. Once there is enough community traction, it will be further reviewed by the product team.

[Steve Anderson SMA-X]

Please see Brindusa's comment for the correct names to use with the API.

Thanks, Steve