Overview
A user object describes a team member account within an Inspire Tenant. Team members can have access to their tenant's Inspire portal. The scope of a user's access to the portal is governed by the user's permissions.
User permissions
A permission allows a team member to perform an action towards a subject. To manage actions and subjects, use the endpoints in the Actions and Subjects sections.
To learn about the permission data object, read Permission object.
Roles
Permissions are grouped into roles. To grant a team member a set of permissions you must add them to one or more roles using the Add team member to a role endpoint.
Admin users
A user becomes an admin when they get assigned the admin Role.
User objects
The endpoints in this section return a detailed or a simple user object with the following properties:
Simple user object
id(String): User ID.firstName(String): User's first name.lastName(String): User's last name.title(String): Title.email(String): User's email address.phoneNumber(String): User's phone number.adminBlockedDate(String): If the user has been blocked from the platform, date when blocked.googleTenantId(String): The unique identifier of the Inspire instance.
Detailed user object
id(String): User ID.name(String): User's name.firstName(String): User's first name.lastName(String): User's last name.title(String): Title.email(String): User's email address.isActive(Boolean): If True, the user is active on the platform.adminBlockedDate(String): If the user has been blocked from the platform, date when blocked.isSsoUser(Boolean): If True, the user logs in via SSO.createdAt(String): Date and time when the user was created.phoneNumber(String): User's phone number.