Takes in an audience id/reference and returns its managers.
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",
"permissions": {
"audienceManager": {
"manageMembers": false,
"manageContent": true,
"assignments": true
},
"peopleManager": {
"canViewLearnPage": true,
"insights": true,
"manage": true
}
}
}
]Structure/ parent audience
[
{
"userId": "63f8c5361b9c80d3274be7ca",
"reference": "user123",
"email": "test@thrivelearning.com",
"permissions": {
"administrator": {
"canManageAudiences": false,
"canAddAudienceManagers": true
},
"audienceManager": {
"manageMembers": false,
"manageContent": true,
"assignments": true
},
"peopleManager": {
"canViewLearnPage": true,
"insights": true,
"manage": true
}
}
}
]The child audience manager object.
The user's id.
The user's reference.
The user's email.
The permissions a child audience manager has assigned.
The audience manager permissions set
Whether the user can add/remove members for the audience via the UI.
Whether the user can share/unshare content for the audience via the UI.
Whether the user can create/ edit/ remove assignments for the audience via the UI.
The people manager permissions set
Whether the user can view the learn page of audience members.
Whether the user can view insights into how the audience is using content and search, along with whether the user can run compliance reports on assignments associated to audience members.
Whether the user can add/edit goals for audience members.
The structure/ parent audience manager object.
The user's id.
The user's reference.
The user's email.
The permissions a structure/ parent audience manager has assigned.
The audience manager permissions set
Whether the user can add/remove members for the audience via the UI.
Whether the user can share/unshare content for the audience via the UI.
Whether the user can create/ edit/ remove assignments for the audience via the UI.
The people manager permissions set
Whether the user can view the learn page of audience members.
Whether the user can view insights into how the audience is using content and search, along with whether the user can run compliance reports on assignments associated to audience members.
Whether the user can add/edit goals for audience members.
The administrator permissions set - only available on structures/ parent audiences.
Whether the user can create/edit for child audiences - only available on structures/ parent audiences.
Whether the user can add or edit manages for child audiences - only available on structures/ parent audiences.
Unauthorized
Unauthorized
Forbidden
Forbidden
Not Found
Not found
Conflict
Conflict
Unprocessable Content
Unprocessable Content
Internal Server Error
Internal Server Error