Create items with API: permission_ids list for roles

[skip]

Infos:

• Used Zammad version: 6.2.0-1710170837.6e9cfa61.jammy amd64
• Used Zammad installation type: package
• Operating system: Debian 12
• Browser + version: 123.0 (64-bit

I’m currently exploring how to efficiently create multiple items such as groups and roles using the API.

In the API documentation for creating roles, I noticed the array of permission_ids that can be specified when creating a role:

{
   "active": true,
   "default_at_signup": false,
   "group_ids": {
      "1": "full",
      "2": "full",
      "3": "full"
   },
   "id": "c-12",
   "name": "VIP service",
   "note": "Handling of VIP customers!",
   "permission_ids": [
      "57",
      "58"
   ]
}

My question is: Where can I find the correlation between permission_id and the corresponding permission?

Alternatively, is there a resource that provides a list mapping each permission to its permission_id, allowing me to accurately define them for the API call?

Thanks,
Skip

[fliebe92]

Hi @skip.

Permission.find_by(name: 'ticket.agent').id => ID of the permission you could use in the permission_ids array for creating a role.

[skip]

Thank you for the hint!

Using

Permission.all.each do |permission|
  puts "ID: #{permission.id}, Name: #{permission.name}"
end

I was able to list all permission_ids:

ID: 1, Name: admin                     
ID: 2, Name: admin.user                                                       
ID: 3, Name: admin.group                                                      
ID: 4, Name: admin.role
ID: 5, Name: admin.organization                                               
ID: 6, Name: admin.overview
ID: 7, Name: admin.text_module       
ID: 8, Name: admin.time_accounting   
ID: 9, Name: admin.macro                                                      
ID: 10, Name: admin.tag
ID: 11, Name: admin.calendar
ID: 12, Name: admin.sla
ID: 13, Name: admin.trigger
ID: 14, Name: admin.scheduler
ID: 15, Name: admin.report_profile
ID: 16, Name: admin.channel_web
ID: 17, Name: admin.channel_formular
ID: 18, Name: admin.channel_email
ID: 19, Name: admin.channel_twitter
ID: 20, Name: admin.channel_facebook
ID: 21, Name: admin.channel_telegram
ID: 22, Name: admin.channel_google
ID: 23, Name: admin.channel_microsoft365
ID: 24, Name: admin.channel_sms
ID: 25, Name: admin.channel_chat
ID: 26, Name: admin.branding
ID: 27, Name: admin.setting_system
ID: 28, Name: admin.security
ID: 29, Name: admin.ticket
ID: 30, Name: admin.package
ID: 31, Name: admin.integration
ID: 32, Name: admin.api
ID: 33, Name: admin.object
ID: 34, Name: admin.template
ID: 35, Name: admin.translation
ID: 36, Name: admin.monitoring
ID: 37, Name: admin.data_privacy
ID: 38, Name: admin.maintenance
ID: 39, Name: admin.session
ID: 40, Name: admin.webhook
ID: 41, Name: admin.core_workflow
ID: 42, Name: admin.public_links                                              
ID: 43, Name: user_preferences                                                
ID: 44, Name: user_preferences.password 
ID: 45, Name: user_preferences.notifications
ID: 46, Name: user_preferences.access_token
ID: 47, Name: user_preferences.language 
ID: 48, Name: user_preferences.linked_accounts
ID: 49, Name: user_preferences.device
ID: 50, Name: user_preferences.avatar
ID: 51, Name: user_preferences.calendar 
ID: 52, Name: user_preferences.out_of_office
ID: 53, Name: user_preferences.overview_sorting
ID: 54, Name: user_preferences.appearance
ID: 55, Name: report
ID: 56, Name: ticket
ID: 57, Name: ticket.agent
ID: 58, Name: ticket.customer
ID: 59, Name: chat
ID: 60, Name: chat.agent
ID: 61, Name: cti
ID: 62, Name: cti.agent
ID: 63, Name: admin.knowledge_base
ID: 64, Name: knowledge_base
ID: 65, Name: knowledge_base.editor
ID: 66, Name: knowledge_base.reader