Platform Management
The Platform Management API is useful for Account (Tenant) administration and management for Poly Lens Accounts (Tenants).
Example:
Show Tenants - Provides a view of the available Accounts (Tenants) and pulls relevant data like device count, rooms, and sites. Can also return the number of associated admin users.
Supported APIs
Account (Tenant) Management
| API | Description | Type | Required Arguments |
|---|---|---|---|
createTenant | Creates a new Account (Tenant) in Poly Lens. | Mutation | name |
deleteTenant | Deletes an Account (Tenant) in Poly Lens. | Mutation | tenantId |
tenant | Returns Account (Tenant) details for a given ID. | Query | tenantId |
tenantCount | Returns the total number of tenants for given user from Poly Lens. | Query | n/a |
tenants | Returns a list of Account (Tenant) details. | Query | n/a |
updateTenant | Updates an Account (Tenant) in Poly Lens. | Mutation | tenantId |
User Management
| API | Description | Type | Required Arguments |
|---|---|---|---|
acceptUserInvite | Accept a user invite. | Mutation | code (user invite ID) |
cancelUserInvite | Cancel a user invite. | Mutation | code (user invite ID) |
getAuditLogs | Collects information about user activities in a Poly Lens account. This information is available to Poly Lens admins and enables them to see data such as the time when user logged in, the time when a user is added or removed, etc. | Query | tenantId |
inviteUser | Invite one or more users to join an Account (Tenant). | Mutation | role, tenantId, emails |
rejectUserInvite | Reject a user invite. | Mutation | code (user invite ID) |
resendUserInvite | Resend a user invite. | Mutation | code (user invite ID) |
user | Returns a user for the specified user id. | Query | userID |
userInvitesByTenant | Returns all user invites associated with the specified tenantId. | Query | tenantId |
users | Returns a list of users according to the input parameters. | Query | UserSearchGrant>resourceID (tenantId) |