Associate a user with a user role

Associates a user with one more user roles, providing access to the permissions defined for that role.

Predefined roles API Platform users are:

• orgadmin
• opsadmin
• businessuser
• user

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 orgadmin role:

$ curl https://api.enterprise.apigee.com/v1/o/{org_name}/userroles/orgadmin/permissions -u myname:mypass

To view permissions for default user role:

$ curl https://api.enterprise.apigee.com/v1/o/{org_name}/userroles/user/permissions -u myname:mypass

To view permissions for default businessuser role:

$ curl https://api.enterprise.apigee.com/v1/o/{org_name}/userroles/businessuser/permissions -u myname:mypass

To view permissions for default opsadmin role:

$ curl https://api.enterprise.apigee.com/v1/o/{org_name}/userroles/opsadmin/permissions -u myname:mypass

Custom roles with custom permission sets can be defined using the /userroles API.

Note : The API call will return an error if one of the roles is invalid or does not exist. The role must belong to the organization scope.

$ curl -H "Content-type:application/json" -X POST -d \
'{ "role" : [ {
    "name" : "user"
  }, {
    "name" : "businessuser"
  } ]}'
https://api.enterprise.apigee.com/v1/o/{org_name}/users/{user_email}/userroles \
-u myname:mypass

Success 2xx with proper response
{
  "role" : [ {
    "name" : "user"
  }, {
    "name" : "businessuser"
  } ]
}