Takes in an audience id/reference and returns its managers: one entry per user, with the full permission set for each role they hold. Deleted users who still hold a role are included with deleted: true.
HTTP Basic authentication using your Tenant ID and API secret.
- Username is the Tenant ID (i.e.
eu-west-2_AbcdEfghI) - Password is the API secret you would have received.
You can also authenticate using OAuth 2.0 client credentials (oauth2 security scheme) instead of Basic auth.
OAuth 2.0 client credentials authentication.
Use the following token endpoints (replace :tenantId with your Tenant ID):
Public API access tokens
- Staging:
https://public.api.learnstaging.link/oauth2/token/:tenantId - Production:
https://public.api.learn.link/oauth2/token/:tenantId - Staging MEA:
https://public.api.meastaging.learn.tech/oauth2/token/:tenantId - Production MEA:
https://public.api.mea.learn.tech/oauth2/token/:tenantId
- Staging:
Webhooks access tokens
- Staging:
https://user.api.learnstaging.link/oauth2/token/:tenantId - Production:
https://user.api.learn.link/oauth2/token/:tenantId - Staging MEA:
https://user.api.meastaging.learn.tech/oauth2/token/:tenantId - Production MEA:
https://user.api.mea.learn.tech/oauth2/token/:tenantId
- Staging:
All access tokens must be sent using the Authorization: Bearer <access_token> header.
Scopes
For API access (non-webhooks), the following scopes are available:
api/all– Full read and write access to the API.api/read– Read-only access to the API.api/write– Write access to the API.
For webhooks, the following scopes are available:
api/webhooks– Access to webhook functionality.api/all– Full read and write access to the API, including webhooks.
Tokens must include appropriate scopes for the endpoints you wish to call.
Filter by audienceId or audience reference.
An array of audience managers.
Child audience
[
{
"userId": "63f8c5361b9c80d3274be7ca",
"reference": "user123",
"email": "test@thrivelearning.com",
"deleted": false,
"permissions": {
"audienceManager": {
"manageMembers": false,
"manageUsers": false,
"manageContent": true,
"assignments": true,
"canViewUserAnalytics": false
},
"peopleManager": {
"analyticsAndReports": false,
"insights": true,
"canManageGoals": false,
"manage": true,
"canViewLearnPage": true,
"canViewComplianceReports": false
}
}
}
]Structure/ parent audience
[
{
"userId": "63f8c5361b9c80d3274be7ca",
"reference": "user123",
"email": "test@thrivelearning.com",
"deleted": false,
"permissions": {
"administrator": {
"canManageAudiences": false,
"canAddAudienceManagers": true
},
"audienceManager": {
"manageMembers": false,
"manageUsers": false,
"manageContent": true,
"assignments": true,
"canViewUserAnalytics": false
},
"peopleManager": {
"analyticsAndReports": false,
"insights": true,
"canManageGoals": false,
"manage": true,
"canViewLearnPage": true,
"canViewComplianceReports": false
}
}
}
]A user holding one or more management roles on an audience, with the full permission set for each role they hold.
The user's id.
The user's reference. Null if the user record cannot be found; the role is still reported.
The user's email. Null if the user record cannot be found; the role is still reported.
Whether the user has been deleted. Deleted users who still hold a role are reported rather than hidden, so stale grants stay visible.
The permissions a user holds on a single audience, grouped by the role that grants them. A role key is present only if the user holds that role on the audience, so the keys present are themselves the role attribution.
The administrator permissions set - only available on structures/ parent audiences.
Whether the user can create/edit child audiences.
Whether the user can add or edit managers for child audiences.
The audience manager permissions set
Whether the user can add/remove members for the audience.
Whether the user can manage users within the audience.
Whether the user can share/unshare content for the audience.
Whether the user can create/edit/remove assignments for the audience.
Whether the user can view analytics for audience members.
The people manager permissions set
Whether the user can view analytics and reports.
Whether the user can view insights into how the audience is using content and search.
Whether the user can add/edit goals for audience members.
Whether the user can manage audience members.
Whether the user can view the learn page of audience members.
Whether the user can run compliance reports on assignments associated to audience members.
Unauthorized
Unauthorized
Forbidden
Forbidden
Not Found
Not found
Conflict
Conflict
Unprocessable Content
Unprocessable Content
Internal Server Error
Internal Server Error