API Platform Base Path: https://api.enterprise.apigee.com/v1/o/{org_name}
| API Resource Path: /userroles |
| Roles for users in an organization on the API Platform |
|
User roles form the basis of role-based access in the Apigee API Platform. Users are associated with one or more userroles. Each userrole defines a set of permissions (GET, PUT, DELETE) on RBAC resources (defined by URI paths). A userrole is scoped to an organization. To get a list of roles in an organization: $ curl https://api.enterprise.apigee.com/v1/o/{org_name}/userroles -u myname:mypass
To view permissions for default $ curl https://api.enterprise.apigee.com/v1/o/{org_name}/userroles/orgadmin/permissions -u myname:mypass
To view permissions for default $ curl https://api.enterprise.apigee.com/v1/o/{org_name}/userroles/user/permissions -u myname:mypass
To view permissions for default $ curl https://api.enterprise.apigee.com/v1/o/{org_name}/userroles/businessuser/permissions -u myname:mypass
To view permissions for default $ curl https://api.enterprise.apigee.com/v1/o/{org_name}/userroles/opsadmin/permissions -u myname:mypass
|
| Add a user to a role | Detail | |
/userroles/{role_name}/users?id={user_email} | ||
| Verb: | POST | |
| Description: | Adds a user to a role | |
| Content Types: |
application/x-www-url-form-encoded
|
|
| Auth: | Basic Auth | |
| Add permissions for a resource to a user role | Detail | |
/userroles/{role_name}/permissions | ||
| Verb: | POST | |
| Description: | Associates permissions for a resource with a user role | |
| Auth: | Basic Auth | |
| Create a user role in an organization | Detail | |
/userroles | ||
| Verb: | POST | |
| Description: | Creates a role in an organization | |
| Auth: | Basic Auth | |
| Delete a user role | Detail | |
/userroles/{role_name} | ||
| Verb: | DELETE | |
| Description: | Deletes a role from an organization | |
| Auth: | Basic Auth | |
| Delete permission for a resource | Detail | |
/userroles/{role_name}/permissions/{permission_name}?path={resource_path} | ||
| Verb: | DELETE | |
| Description: | Removes a permission from a resource for the role specified | |
| Auth: | Basic Auth | |
| Get a role | Detail | |
/userroles/{role_name} | ||
| Verb: | GET | |
| Description: | Gets a role | |
| Auth: | Basic Auth | |
| Get permissions for a resource | Detail | |
/userroles/{role_name}/permissions | ||
| Verb: | GET | |
| Description: | Gets permissions for all resources associated with a user role | |
| Auth: | Basic Auth | |
| Get resource permissions for a specific role | Detail | |
/userroles/{role_name}/permissions?path={resource_path} | ||
| Verb: | GET | |
| Description: | Gets a list of permissions associated with the specified resource for a single resource | |
| Auth: | Basic Auth | |
| Get user roles | Detail | |
/userroles | ||
| Verb: | GET | |
| Description: | Gets a list of roles available to users in an organization | |
| Auth: | Basic Auth | |
| Get users for a role | Detail | |
/userroles/{role_name}/users | ||
| Verb: | GET | |
| Description: | Lists all users for a specified role | |
| Auth: | Basic Auth | |
| Remove user membership in role | Detail | |
/userroles/{role_name}/users/{user_email} | ||
| Verb: | DELETE | |
| Description: | Removes a user from membership in a role | |
| Auth: | Basic Auth | |
| Verify a user role's permission on a specific resource | Detail | |
/userroles/{role_name}/permissions/{permission_name}?path={resource_path} | ||
| Verb: | GET | |
| Description: | Verifies that a user role's permission on a specific resource exists | |
| Auth: | Basic Auth | |
| Verify user role membership | Detail | |
/userroles/{role_rame}/users/{user_email} | ||
| Verb: | GET | |
| Description: | Verifies that a user is a member of a specific role | |
| Content Types: |
application/json
text/xml
|
|
| Auth: | Basic Auth | |
