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"
  } ]
}

 

Add new comment

Provide your email address if you wish to be contacted offline about your comment.
We will not display your email address as part of your comment.

We'd love your feedback and perspective! Please be as specific as possible.
Type the characters you see in this picture. (verify using audio)

Type the characters you see in the picture above; if you can't read them, submit the form and a new image will be generated. Not case sensitive.