PaySuite roles
The role-based access control, which is in place within the PaySuite application allows users within to be assigned roles which dictate their CRUD (Create, Read, Update, Delete) access to various features and functionality.
There are two types of roles:
Functional components (Proxy, Goals, etc.),
Professional roles (Compensation Admin, HRBP, etc.).
List of roles in PaySuite
There are currently twenty one predefined roles in the PaySuite platform:
Analytics: Reporting and dashboard manager
Check-ins: Check-in feature administrator
CompensationAdmin: Compensation setup and round manager
CompensationManager: Day-to-day compensation cycle manager
CommunicationManager: Manages communication rounds and workflows
DataFoundationAdmin: Data ingestion and model administrator
DataModelerAdmin: Configures data models and populations
Feedback: Feedback and behavior libraries manager
GlobalCompensationAdmin: Full company-wide compensation administrator
HRBP: HR business partner
Machine Learning: ML and advanced analytics administrator
Proxy: Proxy configuration role
Read-only: View-only access
Reviews: Review template and workflow manager
Security: Platform security and authorization policies
Permissions per role
This section details the permissions for each of the roles detailed above.
Analytics role
The Analytics role has the following permissions:
CreateReport
CreateReportGroup
CreateReportType
DeleteReport
DeleteReportGroup
DeleteReportType
ExportReport
GetAvailableProfiles
GetEmbedInfo
GetEmbedInfoWithPageAndRoles
GetPowerBIConfiguration
GetReport
GetReportGroup
GetReportGroups
GetReportList
GetReportType
GetReportTypes
SavePowerBIConfiguration
SynchronizeReports
UpdateReport
UpdateReportGroup
UpdateReportPage
UpdateReportType
UpdateReportVisibility
ValidatePowerBIConfigurationAction
ViewAnalyticsForManagersSettings
ViewAnalyticsHubSettings
ViewAnalyticsHubSettingsAnalyticsUrl
ViewDashboardReports
ViewDataPrivacyConsentReport
Check-ins role
The Check-ins role has the following permissions:
CreateMassAssignedCheckins
DeleteBehaviourLibrary
UpdateBehaviourLibrary
UpdateCheckinTemplatesSettings
UpdateCheckinsConversationLabeling
UpdateCheckinsPresetQuestions
ViewBehaviourLibraries
ViewCheckinSettings
ViewCheckinTemplatesSettings
ViewCheckinsConversationLabeling
ViewCheckinsPresetQuestions
ViewMassAssignedCheckins
CompensationAdmin role
The CompensationAdmin role has the following permissions:
CreateBonusPlan
CreateCommunicationRound
CreateCompElement
CreateCompRound
CreateDocumentTemplate
CreatePayoutCurve
CreatePayroll
CreateStatementGenerationRule
DataModelSnapshotAccess
DataModelSnapshotAdmin
DataModelSubscriptionAccess
DataModelSubscriptionAdmin
DeleteDocumentTemplate
DeletePayroll
DeleteStatementGenerationRule
DocumentTemplateHistory
DownloadDocumentTemplate
DownloadSharedDocument
ExportRecipientDetails
ExportWorkerDocuments
GenerateStatementGenerationRule
GetCountriesList
GetCurrency
GetCurrencyList
GetDataFromDataType
GetDataModelDetail
GetDataModelList
GetDataModelSchema
GetDataTypeCsvTemplate
GetDataTypeSchema
GetEntityHierarchyData
GetEntityHierarchyDefinition
GetEnumData
GetExchangeRate
GetExchangeRateList
GetExchangeRateSnapshotData
GetExchangeRateType
GetExchangeRateTypeList
GetFullSchema
GetGlobalCurrency
GetOrganizationalEntityData
GetPopulationList
GetUserDefaultCurrency
ImportDocumentTemplate
ListCommunicationRound
ListWorkers
SearchFullSchema
UpdateBonusPlan
UpdateCommunicationRound
UpdateCompElement
UpdateCompRound
UpdateDocumentTemplate
UpdatePayoutCurve
UpdatePayoutCurveStatus
UpdatePayroll
UpdateStatementGenerationRule
ViewBonusPlan
ViewBonusPlansList
ViewCommunicationRound
ViewCompElementsList
ViewCompRound
ViewCompRoundsList
ViewCompensationDataModelList
ViewCompensationSettings
ViewDocumentGeneration
ViewDocumentTemplate
ViewPayoutCurve
ViewPayoutCurveList
ViewPayroll
ViewPayrollsList
ViewPopulationWorkers
ViewStatementGenerationRule
ViewStatementGenerationRuleList
CompensationManager role
The Compensation manager role has the following permissions:
CreateWorkerNote
DeleteWorkerNote
UpdateWorkerNote
ViewCompRound
ViewCompensationRoundData
ViewPlannerCompensationRoundsList
ViewWorkerNote
Compliance role
The Compliance role has the following permissions:
CanViewUpcomingHardDeletionUsersList
HardDeleteParticipant
SetAnonymizationSettings
SetDataPrivacySettings
SetDataPrivacyStatements
SetHardDeletionSettings
ViewAnonymizationSettings
ViewDataPrivacySettings
ViewDataPrivacyStatements
ViewDataPrivacyStatementsList
ViewHardDeletionSettings
ViewManageUsersDetails
CommunicationManager role
The Communication manager role has the following permissions:
AuditDocument
BulkReleaseDocument
DownloadDocumentCM
ReleaseDocument
ViewCommunicationRoundCM
ViewCommunicationRoundCMData
ViewDocumentCM
ViewWorkflowConfiguration
Configuration role
The Configuration role has the following permissions
AccessDataModelForCompRound
AddNewField
CanManageLocalizationKeys
ClonePopulation
CreateBehaviourLibraries
CreateBonusPlan
CreateCareerDevelopmentCompetencyScale
CreateCareerDevelopmentCompetencyScaleSkillsGroup
CreateCareerDevelopmentPlan
CreateCompElement
CreateCompRound
CreateDataModel
CreateGoalPlan
CreateGoalType
CreatePayoutCurve
CreatePayroll
CreatePopulation
CreateProfessionalRoleValues
CreateStatementGenerationRule
DataModelSnapshotAccess
DataModelSnapshotAdmin
DataModelSubscriptionAccess
DataModelSubscriptionAdmin
DeactivateCustomField
DeactivatePopulation
DeleteBehaviourLibrary
DeleteCareerDevelopmentCompetencyScale
DeleteCareerDevelopmentPlan
DeletePayroll
DeleteProfessionalRoleValues
DeleteStatementGenerationRule
ExportOrgItemsCSV
ExportUsersCSV
FieldsInUseCount
GenerateStatementGenerationRule
GetAdminDataModelDetail
GetAdminDataModelList
GetAllPopulationList
GetCountriesList
GetCurrency
GetCurrencyList
GetCustomFields
GetCustomizableDataTypes
GetDataFromDataType
GetDataModelDetail
GetDataModelList
GetDataModelSchema
GetDataTypeCsvTemplate
GetDataTypeSchema
GetEntityHierarchyData
GetEntityHierarchyDefinition
GetEnumData
GetExchangeRate
GetExchangeRateList
GetExchangeRateSnapshotData
GetExchangeRateType
GetExchangeRateTypeList
GetFullSchema
GetGlobalCurrency
GetIngestedCsvFile
GetIngestionLogList
GetIngestionResult
GetModelerConfigurations
GetOrganizationalEntityData
GetPopulationContentCount
GetPopulationDetail
GetPopulationList
GetProfessionalRoleValues
GetStatusesSummary
GetUserDefaultCurrency
GetWidgetConfiguration
ListCommunicationRound
PreviewDataModelResult
SearchFullSchema
SetBehaviourSettings
SetCheckinSettings
SetCompanyLogoSettings
SetDocumentGenerationSettings
SetEmailNotificationSettings
SetFeedbackSettings
SetIngestionBehaviour
SetManageOrganizationItems
SetManageReportsSettings
SetManageUsersDetails
SetNotificationSettings
SetOnboardingSettings
SetPasswordPolicySettings
SetPayInformationRequestsSettings
SetPrintCertificateFeedbackSettings
SetQuestionBankSettings
SetRegionalSettings
SetReviewSettings
SetSchedulerSettings
SetSessionTimeoutSettings
SetSurveySettings
SetUserProxySettings
UpdateAnalyticsForManagersSettings
UpdateAnalyticsHubSettings
UpdateBehaviourLibrary
UpdateBonusPlan
UpdateCareerDevelopmentCompetencyScale
UpdateCareerDevelopmentCompetencyScaleSkillsGroup
UpdateCareerDevelopmentPlan
UpdateCareerDevelopmentSettings
UpdateCareerDevelopmentSkills
UpdateCompElement
UpdateCompRound
UpdateCompareSettings
UpdateDataModel
UpdateDataModelSelectedFields
UpdateDataModelStatus
UpdateDigitalRewardWidgetSettings
UpdateDigitalRewardsStatementSettings
UpdateGoalPlan
UpdateGoalType
UpdateModelerConfigurations
UpdatePassportSettings
UpdatePayoutCurve
UpdatePayoutCurveStatus
UpdatePayroll
UpdatePopulationCriteria
UpdatePopulationDefinition
UpdatePopulationStatus
UpdateSensitiveContentSettings
UpdateSensitiveWords
UpdateStatementGenerationRule
UpdateWidgetConfigurationAction
ViewAnalyticsForManagersSettings
ViewAnalyticsHubSettings
ViewBehaviourLibraries
ViewBehaviourSettings
ViewBonusPlan
ViewBonusPlansList
ViewCareerDevelopmentCompetencyScale
ViewCareerDevelopmentCompetencyScaleSkillsGroupsList
ViewCareerDevelopmentCompetencyScalesList
ViewCareerDevelopmentPlan
ViewCareerDevelopmentPlansList
ViewCareerDevelopmentSettings
ViewCareerDevelopmentSkills
ViewCheckinSettings
ViewCommunicationHubSettings
ViewCompElementsList
ViewCompRound
ViewCompRoundsList
ViewCompanyLogoSettings
ViewCompareSettings
ViewCompensationDataModelList
ViewCompensationSettings
ViewDocumentGenerationSettings
ViewEmailNotificationSettings
ViewEquitySettings
ViewExtensionClientSettings
ViewFeedbackSettings
ViewGeniusSettings
ViewGoalPlan
ViewGoalPlansList
ViewGoalSettings
ViewGoalType
ViewGoalTypesList
ViewHomePageSettings
ViewMachineLearningSettings
ViewManageOrganizationItems
ViewManageReportsSettings
ViewManageUsersDetails
ViewMsTeamsSettings
ViewNotificationSettings
ViewOnboardingSettings
ViewPassportSettings
ViewPasswordPolicySettings
ViewPayoutCurve
ViewPayoutCurveList
ViewPayroll
ViewPayrollsList
ViewPopulationWorkers
ViewQuestionBankSettings
ViewRegionalSettings
ViewReviewSettings
ViewSchedulerSettings
ViewSensitiveContentSettings
ViewSensitiveWords
ViewSessionTimeoutSettings
ViewStatementGenerationRule
ViewStatementGenerationRuleList
ViewSurveySettings
ViewUserProxySettings
ViewUsersProxyAccess
DataFoundationAdmin role
The DataFoundationAdmin role has the following permissions
AddNewField
CreateExchangeRate
CreateExchangeRateSnapshot
CreateExchangeRateType
DataModelSnapshotAccess
DataModelSnapshotExportAccess
DeactivateCustomField
DeactivateExchangeRateType
DeleteExchangeRate
DeleteExchangeRateSnapshot
DeleteExchangeRateType
FieldsInUseCount
GetCountriesList
GetCurrency
GetCurrencyList
GetCustomFields
GetCustomizableDataTypes
GetDataFromDataType
GetDataModelDetail
GetDataModelList
GetDataModelSchema
GetDataTypeCsvTemplate
GetDataTypeDataPreview
GetDataTypeSchema
GetEntityHierarchyData
GetEntityHierarchyDefinition
GetEnumData
GetExchangeRate
GetExchangeRateList
GetExchangeRateSnapshotData
GetExchangeRateType
GetExchangeRateTypeList
GetFullSchema
GetGlobalCurrency
GetIngestedCsvFile
GetIngestionLogList
GetIngestionResult
GetOrganizationalEntityData
GetStatusesSummary
GetUserDefaultCurrency
IngestData
SearchFullSchema
SetGlobalCurrency
SetIngestionBehaviour
SetUserDefaultCurrency
StartUiCsvIngestion
UpdateCurrency
UpdateExchangeRate
UpdateExchangeRateType
DataModelerAdmin role
The DataModelerAdmin role has the following permissions:
ClonePopulation
CreateDataModel
CreatePopulation
DataModelSnapshotAccess
DataModelSnapshotAdmin
DataModelSubscriptionAccess
DataModelSubscriptionAdmin
DeactivatePopulation
GetAdminDataModelDetail
GetAdminDataModelList
GetAllPopulationList
GetDataFromDataType
GetDataModelDetail
GetDataModelList
GetDataModelSchema
GetEnumData
GetModelerConfigurations
GetPopulationContentCount
GetPopulationDetail
GetPopulationList
PreviewDataModelResult
UpdateDataModel
UpdateDataModelSelectedFields
UpdateDataModelStatus
UpdateModelerConfigurations
UpdatePopulationCriteria
UpdatePopulationDefinition
UpdatePopulationStatus
Feedback role
The Feedback role has the following permissions:
DeleteBehaviourLibrary
UpdateBehaviourLibrary
ViewBehaviourLibraries
ViewBehaviourSettings
ViewFeedbackSettings
Feedback Broadcast role
The Feedback Broadcast role has the following permissions:
AllowExceedsLimit
AllowSendToOrganisationItems
GlobalCompensationAdmin role
The GlobalCompensationAdmin role has the following permissions:
AccessDataModelForCompRound
CreateBonusPlan
CreateCommunicationRound
CreateCompElement
CreateCompRound
CreateDocumentTemplate
CreateExchangeRate
CreateExchangeRateSnapshot
CreateExchangeRateType
CreatePayoutCurve
CreatePayroll
CreateStatementGenerationRule
DataModelSnapshotAccess
DataModelSnapshotAdmin
DataModelSnapshotExportAccess
DataModelSubscriptionAccess
DataModelSubscriptionAdmin
DeactivateExchangeRateType
DeleteDocumentTemplate
DeleteExchangeRate
DeleteExchangeRateSnapshot
DeleteExchangeRateType
DeletePayroll
DeleteStatementGenerationRule
DocumentTemplateHistory
DownloadDocumentTemplate
DownloadSharedDocument
ExportDocumentGeneration
ExportRecipientDetails
ExportWorkerDocuments
GenerateStatementGenerationRule
GetCountriesList
GetCurrency
GetCurrencyList
GetDataFromDataType
GetDataModelDetail
GetDataModelList
GetDataModelSchema
GetDataTypeCsvTemplate
GetDataTypeSchema
GetEntityHierarchyData
GetEntityHierarchyDefinition
GetEnumData
GetExchangeRate
GetExchangeRateList
GetExchangeRateSnapshotData
GetExchangeRateType
GetExchangeRateTypeList
GetFullSchema
GetGlobalCurrency
GetOrganizationalEntityData
GetPopulationList
GetUserDefaultCurrency
ImportDocumentTemplate
IngestData
ListCommunicationRound
ListWorkers
ManageCompensationEntities
SearchFullSchema
SetGlobalCurrency
SetUserDefaultCurrency
UpdateBonusPlan
UpdateCommunicationRound
UpdateCompElement
UpdateCompRound
UpdateCurrency
UpdateDocumentTemplate
UpdateExchangeRate
UpdateExchangeRateType
UpdatePayoutCurve
UpdatePayoutCurveStatus
UpdatePayroll
UpdateStatementGenerationRule
ViewBonusPlan
ViewBonusPlansList
ViewCommunicationRound
ViewCompElementsList
ViewCompRound
ViewCompRoundsList
ViewCompensationDataModelList
ViewCompensationSettings
ViewDocumentGeneration
ViewDocumentTemplate
ViewPayoutCurve
ViewPayoutCurveList
ViewPayroll
ViewPayrollsList
ViewPopulationWorkers
ViewStatementGenerationRule
ViewStatementGenerationRuleList
Goals role
The Goals role has the following permissions:
CreateCareerDevelopmentCompetencyScale
CreateCareerDevelopmentCompetencyScaleSkillsGroup
CreateGoalPlan
CreateGoalTagLibrary
CreateGoalTemplate
CreateGoalType
DeleteBehaviourLibrary
DeleteCareerDevelopmentCompetencyScale
DeleteGoalTagLibrary
GetDataFromDataType
GetEntityHierarchyDefinition
GetEnumData
ListCommunicationRound
ProfessionalGoalAssignment
UpdateBehaviourLibrary
UpdateCareerDevelopmentCompetencyScale
UpdateCareerDevelopmentCompetencyScaleSkillsGroup
UpdateCareerDevelopmentSkills
UpdateGoalPlan
UpdateGoalTagLibrary
UpdateGoalTemplate
UpdateGoalType
ViewBehaviourLibraries
ViewCareerDevelopmentCompetencyScale
ViewCareerDevelopmentCompetencyScaleSkillsGroupsList
ViewCareerDevelopmentCompetencyScalesList
ViewCareerDevelopmentSkills
ViewGeniusSettings
ViewGoalPlan
ViewGoalPlansList
ViewGoalSettings
ViewGoalTagsLibraries
ViewGoalTemplateDetails
ViewGoalTemplates
ViewGoalType
ViewGoalTypesList
GoalAdmin role
The GoalAdmin role has the following permissions:
GoalManagementUpdateGoal
GoalsManagementViewGoal
ListCommunicationRound
ProfessionalGoalAssignment
ViewGoalManagementList
ViewGoalPlan
ViewGoalPlansList
ViewGoalProgressTrail
ViewGoalSettings
ViewGoalTagsLibraries
ViewGoalType
ViewGoalTypesList
HRBP role
The HRBP role has the following permissions:
AuditDocument
BulkChangeDocumentWorkflowStep
BulkReleaseDocument
ChangeDocumentWorkflowStep
CreateCareerDevelopmentCompetencyScale
CreateCareerDevelopmentCompetencyScaleSkillsGroup
CreateCareerDevelopmentPlan
CreateWorkerNote
DeleteCareerDevelopmentCompetencyScale
DeleteCareerDevelopmentPlan
DeleteDocument
DeleteWorkerNote
DownloadDocumentHRBP
HRBPDataRound
ImportDocument
ListCommunicationRound
ReleaseDocument
UpdateCareerDevelopmentCompetencyScale
UpdateCareerDevelopmentCompetencyScaleSkillsGroup
UpdateCareerDevelopmentPlan
UpdateCareerDevelopmentSkills
UpdateWorkerNote
ViewCareerDevelopmentCompetencyScale
ViewCareerDevelopmentCompetencyScaleSkillsGroupsList
ViewCareerDevelopmentCompetencyScalesList
ViewCareerDevelopmentPlan
ViewCareerDevelopmentPlansList
ViewCareerDevelopmentSettings
ViewCareerDevelopmentSkills
ViewCommunicationRoundHRBP
ViewCommunicationRoundHRBPData
ViewCompRound
ViewCompensationRoundData
ViewDocumentHRBP
ViewPayInformationRequests
ViewPlannerCompensationRoundsList
ViewWorkerNote
ViewWorkflowConfiguration
Machine Learning role
The Machine Learning role has the following permissions:
Nudges role
The Nudges role has the following permissions:
CreateNudgeNotificationTemplate
UpdateNudgeNotificationTemplate
ViewEmailNotificationSettings
ViewNotificationSettings
ViewNudgeNotificationTemplate
ViewNudgeNotificationTemplateList
ViewSchedulerSettings
Proxy role
The Proxy role has the following permissions:
SetUsersProxyAccess
ViewManageUsersDetails
ViewUserProxySettings
ViewUsersProxyAccess
Read-only role
The Read-only role has the following permissions:
DocumentTemplateHistory
DownloadDocumentTemplate
GetDataFromDataType
GetEntityHierarchyDefinition
GetEnumData
ListCommunicationRound
ViewAnalyticsForManagersSettings
ViewAnalyticsHubSettings
ViewBehaviourLibraries
ViewBehaviourSettings
ViewBonusPlansList
ViewCareerDevelopmentCompetencyScale
ViewCareerDevelopmentCompetencyScaleSkillsGroupsList
ViewCareerDevelopmentCompetencyScalesList
ViewCareerDevelopmentPlansList
ViewCareerDevelopmentSettings
ViewCareerDevelopmentSkills
ViewCheckinSettings
ViewCheckinTemplatesSettings
ViewCommunicationHubSettings
ViewCommunicationRound
ViewCompElementsList
ViewCompRoundsList
ViewCompareSettings
ViewCompensationSettings
ViewDocumentGeneration
ViewDocumentGenerationSettings
ViewDocumentTemplate
ViewEmailNotificationSettings
ViewEquitySettings
ViewExtensionClientSettings
ViewFeedbackSettings
ViewGeniusSettings
ViewGoalPlan
ViewGoalPlansList
ViewGoalSettings
ViewGoalTagsLibraries
ViewGoalTemplates
ViewGoalTypesList
ViewHardDeletionSettings
ViewHomePageSettings
ViewListQuestionBankLibraries
ViewListSurveyAssesments
ViewMachineLearningSettings
ViewManageOrganizationItems
ViewManageUsersDetails
ViewMassAssignedCheckins
ViewMsTeamsSettings
ViewNotificationSettings
ViewNudgeNotificationTemplateList
ViewPassportSettings
ViewPayInformationRequests
ViewPayoutCurveList
ViewPayrollsList
ViewPopulationWorkers
ViewQuestionBankLibraries
ViewQuestionBankSettings
ViewReviewSettings
ViewReviewTemplates
ViewSchedulerSettings
ViewSensitiveContentSettings
ViewSessionTimeoutSettings
ViewStatementGenerationRule
ViewStatementGenerationRuleList
ViewSurveyAssesments
ViewSurveySettings
ViewUserProxySettings
ViewUsersProxyAccess
Reviews role
The Reviews role has the following permissions:
CreateCareerDevelopmentCompetencyScale
CreateCareerDevelopmentCompetencyScaleSkillsGroup
CreateReviewTemplate
DeleteBehaviourLibrary
DeleteCareerDevelopmentCompetencyScale
DeleteReviewTemplate
DuplicateReviewTemplate
GetDataFromDataType
GetEntityHierarchyDefinition
GetEnumData
GetManagersSearchPaged
GetOrganisationItemsPaged
GlobalSearchOrgItems
ListCommunicationRound
SearchActiveUsersForCreateReviewTemplate
SearchOrgItemsForCreateReviewTemplate
SearchOrgItemsForManage
SearchOrgItemsForMassAssignCheckin
UpdateBehaviourLibrary
UpdateCareerDevelopmentCompetencyScale
UpdateCareerDevelopmentCompetencyScaleSkillsGroup
UpdateCareerDevelopmentSkills
UpdateReviewTemplate
ViewBehaviourLibraries
ViewCareerDevelopmentCompetencyScale
ViewCareerDevelopmentCompetencyScaleSkillsGroupsList
ViewCareerDevelopmentCompetencyScalesList
ViewCareerDevelopmentSkills
ViewReviewSettings
ViewReviewTemplateDetails
ViewReviewTemplates
ViewSensitiveContentSettings
ViewSensitiveWords
Security role
The Security role has the following permissions:
AddOrUpdateAuthorizationPolicies
DisableAuthorizationPolicies
EnableAuthorizationPolicies
ExportUsersWithProfessionalRoles
GetAuthorizationPolicies
GetAuthorizationPolicyIds
GetProfessionalRoleValues
GetUserAttributes
GetUsersSecurity
ImportProfessionalRoles
SetManageUsersDetails
SetPasswordPolicySettings
SetSessionTimeoutSettings
ViewManageOrganizationItems
ViewManageUsersDetails
ViewPasswordPolicySettings
ViewSessionTimeoutSettings
Going further
- Role management API
- Managing professional roles