You are viewing the Apigee Management API reference documentation. For the main product docs, and to search all docs, go to

Add Permissions for Resource to a Role

Resource Summary


Content Type



Permissions for Resource at Organization Level,



Add Permissions for Resource to a Role

In Apigee Edge, different user roles are assigned different permissions to view (GET), create or update (both PUT), or delete (DELETE) resources in an organization; for example, modifying API proxies or creating custom reports. Management users in those roles are limited to those specific permissions.


A permission consists of a set of verbs ("get", "put", and/or "delete") and a resource path. For example, to allow a user role to list the API proxies in an organization, the role must have the following permission: 

    "path" : "/applications",
    "permissions" : ["get"]


To be able to list and create an API proxy:


    "path" : "/applications",
    "permissions" : ["get", "put"]


For a complete list of the available resource paths and verbs, see Permissions reference.


Use this API to add permissions to a user role. You can use the * wild card in the URI pattern to indicate any value; for example, to include either the 'test' or 'prod' environment in the resource path: /environments/*/cache. For more information and examples on using the API to add permissions, see Creating roles with the API.


Using this API to add a permission does not remove any existing permissions in the role. To remove a permsission, use the Delete Permission for Resource API.



Resource URL /organizations/{org_name}/userroles/{role_name}/permissions

Header Parameters

Name Values Description

Specify the content type

Request Body

org_name Mention the organization name true

role_name Mention the role name true

HTTP Basic

OAuth 2.0



Make a request and see the response.

Make a request and see the response.

Make a request and see the response.


Help or comments?

  • If something's not working: Ask the Apigee Community or see Apigee Support.
  • If something's wrong with the docs: Click the "Send Feedback" button.
    (Incorrect? Unclear? Broken link? Typo?)