Get Role Admins
Use this API to return a list of role administrators.
Pagination is supported on this endpoint.
Resource URL
https://<subdomain>/api/2/roles/:id/admins
Header Parameters
Authorization required string | Set to Set The access token must have been generated using an API credential pair created using the scope required to call this API. This API can be called using any one of the following scopes: |
Request Parameters
name required string |
Filters on first name, last name, username, and email address. |
include_unassigned boolean |
Optional. Include admins that aren’t assigned to the role. |
Sample Responses
- 200 OK
- 401 Unauthorized
- 404 Not Found
{
"id": 345,
"name": "Joe Smith",
"username": “joe.smith@example.com",
"added_by": {
"id": 678
"name": "Josephina manager"
}
"added_at": "2019-12-27T00:00:00Z",
"assigned": true
}
}
Typically, this error means that your access token value is invalid.
{
"message": "Unauthorized",
"statusCode": 401,
"name": "UnauthorizedError"
}
The requested user does not exist.
{
"message": "The resource with the given id could not be found",
"statusCode": 404,
"name": "NotFoundError"
}
Postman Collection
Replace sample variables indicated by {{ }}
with your actual values.
Download for Roles API
Sample Code
cURL
Replace sample values indicated by < >
with your actual values.
Get Role Admin
curl 'https://<subdomain>/api/2/roles/:id/admins' \
-X GET \
-H "Authorization: bearer <access_token>"
Have a Question?
Found a problem or a bug? Submit a support ticket.
Looking for walkthroughs or how-to guides on OneLogin's user and admin features? Check out the documentation in our Knowledge Base.
Have a product idea or request? Share it with us in our Ideas Portal.