Description
Similar to an organization admin's "People View" export, this returns a paged list of specific details about the organization's users, including their usernames, display names, email addresses, SAML IDs, last logins, workspace memberships, licenses and roles. Results are sorted by displayName.
To obtain an organization's users, you need its organizationId. To view the organizationId in Wdesk, click your name in the lower left, and select Organization Admin. In the URL in your browser, the organizationId appears as a GUID after the /o/ such as 371b5fc8-fcc4-404a-9d22-d07d8f46a7e0. To view the ID of another organization you manage, select Switch Organizations from the left-hand menu, and search for and select the organization.
Requires the calling user to be an organization admin.
GET /organizations/{organizationId}/orgReportUsers
Required OAuth Scopes:
scim|r
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| Content-Type | header | string | true | Requested Content-Type |
| page[after] | query | string | false | Paging cursor |
| page[size] | query | integer(int64) | false | Number of items to return. Maximum of 1000. |
| organizationId | path | string | true | Organization Id |
Enumerated Values
| Parameter | Value |
|---|---|
| Content-Type | application/vnd.api+json |
| Content-Type | application/json |
Code Samples
curl -X GET https://api.app.wdesk.com/admin/v1/organizations/{organizationId}/orgReportUsers \
-H 'Accept: application/vnd.api+json' \
-H 'Content-Type: application/vnd.api+json' \
-H 'Authorization: Bearer {access-token}'
http GET https://api.app.wdesk.com/admin/v1/organizations/{organizationId}/orgReportUsers \
Accept:application/vnd.api+json \
Content-Type:application/vnd.api+json \
Authorization:"Bearer {access-token}"
wget --method=GET "https://api.app.wdesk.com/admin/v1/organizations/{organizationId}/orgReportUsers" \
--output-document - \
--header 'Accept: application/vnd.api+json' \
--header 'Content-Type: application/vnd.api+json' \
--header 'Authorization: Bearer {access-token}'
import requests
headers = {
'Accept': 'application/vnd.api+json',
'Content-Type': 'application/vnd.api+json',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('https://api.app.wdesk.com/admin/v1/organizations/{organizationId}/orgReportUsers', headers = headers)
print(r.json())
Returns
200 - OK
A report of Organization Users
400 - BAD_REQUEST
An error response. All fields other than "errors" are optional
401 - UNAUTHORIZED
An error response. All fields other than "errors" are optional
403 - FORBIDDEN
An error response. All fields other than "errors" are optional
404 - NOT_FOUND
An error response. All fields other than "errors" are optional
405 - METHOD_NOT_ALLOWED
An error response. All fields other than "errors" are optional
415 - UNSUPPORTED_MEDIA_TYPE
An error response. All fields other than "errors" are optional
500 - INTERNAL_SERVER_ERROR
An error response. All fields other than "errors" are optional
501 - NOT_IMPLEMENTED
An error response. All fields other than "errors" are optional
503 - SERVICE_UNAVAILABLE
An error response. All fields other than "errors" are optional
Example Responses
{
"data": [
{
"attributes": {
"active": true,
"displayName": "Jane Smith",
"email": "[email protected]",
"firstName": "Jane",
"lastLogin": null,
"lastName": "Smith",
"licenses": [
"Support"
],
"organizationRoles": [
"Organization User Admin",
"Organization Security Admin"
],
"samlId": null,
"userName": "[email protected]",
"workspaceMemberships": [
{
"id": "QWNjb3VudB82NzUwMjAwMDc",
"workspaceName": "Test Workspace",
"workspaceRoles": []
}
]
},
"id": "abc123",
"type": "orgReportUser"
}
],
"links": {
"next": "https://api.wdesk.com/admin/v1/organizations/orgId123-456-789/orgReportUsers?page[size]=1&page[after]=..."
}
}
{
"errors": [
{
"status": "400",
"source": {
"parameter": "page[size]"
},
"title": "Invalid Page Size",
"detail": "page[size] must be a positive integer"
}
]
}
{
"errors": [
{
"code": "string",
"detail": "string",
"id": "string",
"links": {
"about": "string"
},
"meta": {},
"source": {
"parameter": "string",
"pointer": "string"
},
"status": "string",
"title": "string"
}
],
"jsonapi": {
"version": "string"
},
"links": {},
"meta": {}
}
{
"errors": [
{
"code": "string",
"detail": "string",
"id": "string",
"links": {
"about": "string"
},
"meta": {},
"source": {
"parameter": "string",
"pointer": "string"
},
"status": "string",
"title": "string"
}
],
"jsonapi": {
"version": "string"
},
"links": {},
"meta": {}
}
{
"errors": [
{
"code": "string",
"detail": "string",
"id": "string",
"links": {
"about": "string"
},
"meta": {},
"source": {
"parameter": "string",
"pointer": "string"
},
"status": "string",
"title": "string"
}
],
"jsonapi": {
"version": "string"
},
"links": {},
"meta": {}
}
{
"errors": [
{
"code": "string",
"detail": "string",
"id": "string",
"links": {
"about": "string"
},
"meta": {},
"source": {
"parameter": "string",
"pointer": "string"
},
"status": "string",
"title": "string"
}
],
"jsonapi": {
"version": "string"
},
"links": {},
"meta": {}
}
{
"errors": [
{
"code": "string",
"detail": "string",
"id": "string",
"links": {
"about": "string"
},
"meta": {},
"source": {
"parameter": "string",
"pointer": "string"
},
"status": "string",
"title": "string"
}
],
"jsonapi": {
"version": "string"
},
"links": {},
"meta": {}
}
{
"errors": [
{
"code": "string",
"detail": "string",
"id": "string",
"links": {
"about": "string"
},
"meta": {},
"source": {
"parameter": "string",
"pointer": "string"
},
"status": "string",
"title": "string"
}
],
"jsonapi": {
"version": "string"
},
"links": {},
"meta": {}
}
{
"errors": [
{
"code": "string",
"detail": "string",
"id": "string",
"links": {
"about": "string"
},
"meta": {},
"source": {
"parameter": "string",
"pointer": "string"
},
"status": "string",
"title": "string"
}
],
"jsonapi": {
"version": "string"
},
"links": {},
"meta": {}
}
{
"errors": [
{
"code": "string",
"detail": "string",
"id": "string",
"links": {
"about": "string"
},
"meta": {},
"source": {
"parameter": "string",
"pointer": "string"
},
"status": "string",
"title": "string"
}
],
"jsonapi": {
"version": "string"
},
"links": {},
"meta": {}
}