Edit in GitHubLog an issue
B2B feature. Learn more
Thanks to Atwix for contributing this topic!

updateCompanyRole mutation

Use the updateCompanyRole mutation to update the company role and permissions.

You can get the role ID and the list of all resources defined within the company using the company query.

The following table lists all the resources that are available to the customers defined with a company. To visualize the resource hierarchy, log in to a store as the Company Admin and select Roles and Permissions, then click the Edit action next to the Default User role.

Display nameResource name
  All
Magento_Company::index
    Sales
Magento_Sales::all
      Allow Checkout
Magento_Sales::place_order
        Use Pay On Account method
Magento_Sales::payment_account
      View orders
Magento_Sales::view_orders
      View orders of subordinate users
Magento_Sales::view_orders_sub
    Quotes
Magento_NegotiableQuote::all
      View
Magento_NegotiableQuote::view_quotes
        Request, Edit, Delete
Magento_NegotiableQuote::manage
        Checkout with Quote
Magento_NegotiableQuote::checkout
      View quotes of subordinate users
Magento_NegotiableQuote::view_quotes_sub
  Order Approvals
Magento_PurchaseOrder::all
    View My Purchase Orders
Magento_PurchaseOrder::view_purchase_orders
      View for subordinates
Magento_PurchaseOrder::view_purchase_orders_for_subordinates
      View for all company
Magento_PurchaseOrder::view_purchase_orders_for_company
    Auto-approve POs created within this role
Magento_PurchaseOrder::autoapprove_purchase_order
    Approve Purchase Orders without other approvals
Magento_PurchaseOrderRule::super_approve_purchase_order
    View Approval Rules
Magento_PurchaseOrderRule::view_approval_rules
      Create, Edit and Delete
Magento_PurchaseOrderRule::manage_approval_rules
    Company Profile
Magento_Company::view
      Account Information (View)
Magento_Company::view_account
        Edit
Magento_Company::edit_account
      Legal Address (View)
Magento_Company::view_address
        Edit
Magento_Company::edit_address
      Contacts (View)
Magento_Company::contacts
      Payment Information (View)
Magento_Company::payment_information
      Shipping Information (View)
Magento_Company::shipping_information
    Company User Management
Magento_Company::user_management
      View roles and permissions
Magento_Company::roles_view
        Manage roles and permissions
Magento_Company::roles_edit
      View users and teams
Magento_Company::users_view
        Manage users and teams
Magento_Company::users_edit
    Company credit
Magento_Company::credit
      view
Magento_Company::credit_history

You can change or add permissions to the company role using the permissions attribute.

This mutation requires a valid customer authentication token.

Syntax

Copied to your clipboard
mutation {
updateCompanyRole(
input: CompanyRoleUpdateInput!
) {
UpdateCompanyRoleOutput
}
}

Reference

The updateCompanyRole reference provides detailed information about the types and fields defined in this mutation.

Example usage

The following example updates the name of a company role.

Request:

Copied to your clipboard
mutation {
updateCompanyRole(
input: {
id: "Mg=="
name: "Company Admin (updated)"
}
) {
role {
id
name
permissions {
id
text
sort_order
children {
id
text
sort_order
children {
id
text
sort_order
}
}
}
}
}
}

Response:

Copied to your clipboard
{
"data": {
"updateCompanyRole": {
"role": {
"id": "Mg==",
"name": "Company Admin (updated)",
"permissions": [
{
"id": "Magento_Company::index",
"text": "All",
"sort_order": 100,
"children": [
{
"id": "Magento_Company::view",
"text": "Company Profile",
"sort_order": 100,
"children": [
{
"id": "Magento_Company::view_account",
"text": "Account Information (View)",
"sort_order": 100
},
{
"id": "Magento_Company::view_address",
"text": "Legal Address (View)",
"sort_order": 200
},
{
"id": "Magento_Company::contacts",
"text": "Contacts (View)",
"sort_order": 300
},
{
"id": "Magento_Company::payment_information",
"text": "Payment Information (View)",
"sort_order": 400
},
{
"id": "Magento_Company::shipping_information",
"text": "Shipping Information (View)",
"sort_order": 450
}
]
},
{
"id": "Magento_Company::user_management",
"text": "Company User Management",
"sort_order": 200,
"children": [
{
"id": "Magento_Company::roles_view",
"text": "View roles and permissions",
"sort_order": 100
},
{
"id": "Magento_Company::users_view",
"text": "View users and teams",
"sort_order": 300
}
]
},
{
"id": "Magento_Company::credit",
"text": "Company Credit",
"sort_order": 500,
"children": [
{
"id": "Magento_Company::credit_history",
"text": "View",
"sort_order": 500
}
]
}
]
}
]
}
}
}
}

Errors

ErrorDescription
User role with this name already exists. Enter a different name to save this role.
The company cannot have multiple company roles with the same name.
Unable to set "allow" for the resource because its parent resource(s) is set to "deny".
To allow permission for the company role, you must allow all the permissions of the parent tree.
No such entity with roleId = xxx
The company role with ID xxx doesn't exist.
  • Privacy
  • Terms of Use
  • Do not sell or share my personal information
  • AdChoices
Copyright © 2024 Adobe. All rights reserved.