Users
Manage platform users and access permissions
A user is a person with access to the platform. A user acts on behalf of a customer. The entity carries the authentication, the authorization, and the access control of that person.
User entity
A user in the API represents:
- Platform access: Individual with authentication credentials and permissions
- Customer association: Users can be associated with one or more customer entities
- Permission scope: Access rights and operational capabilities within the platform
- Identity management: Unique identification and profile information
Key capabilities
User authentication
Manage user credentials, authentication tokens, and secure platform access.
Customer access
Associate users with customer entities to enable service management and administration.
Permission management
Control user access levels and operational permissions within the platform.
Profile management
Maintain user profile information, contact details, and preferences.
Common use cases
User onboarding
Create new user accounts with appropriate permissions and customer associations.
Access management
Manage user permissions, customer associations, and operational access rights.
Multi-tenant access
Enable users to access multiple customer accounts with appropriate permission scoping.
API integration
Create API users for system integrations and automated service management.
Related resources
User entities interact with other API resources:
- Customers: Users are associated with customers to enable account management
- Authentication: Bearer tokens and API keys provide secure platform access
- Orders: Users can create and manage orders on behalf of customers
- Subscriptions: Users can manage subscriptions for their associated customers