Was this helpful?

 

API Platform Base Path: https://api.enterprise.apigee.com/v1/o/{org_name}

API Resource Path:

/userroles/{role_name}/users

Description: Returns a list of all system users associated with a role

Verb: GET
Auth: Basic Auth
Media types:
application/json
text/xml
Sample Request:
$ curl -X GET -H "Accept:application/json" \ 
https://api.enterprise.apigee.com/v1/o/{org_name}/userroles/{role_name}/users \
-u myname:mypass

for an expanded list

$ curl -X GET -H "Accept:application/json" \ 
https://api.enterprise.apigee.com/v1/o/{org_name}/userroles/{role_name}/users?"expand=true" \
-u myname:mypass
Query Parameters:
Name Description Default Required?
expand When set to 'true', this parameter returns the complete profile for each user listed. false No
Sample Response:
[ "larry@example.com", "moe@example.com", "curly@example.com" ]

with "expand=true"

{
  "user" : [ {
    "emailId" : "larry@example.com",
    "firstName" : "Larry",
    "lastName" : "Brown"
  }, {
    "emailId" : "moe@example.com",
    "firstName" : " Moe ",
    "lastName" : " Jones "
  },, {
    "emailId" : "curly@example.com",
    "firstName" : "Curly",
    "lastName" : "Smith"
  } ]
}

 

Help or comments?

  • Something's not working: See Apigee Support
  • Something's wrong with the docs: Click Send Feedback in the lower right.
    (Incorrect? Unclear? Broken link? Typo?)