API reference
Access management
Users, teams, role groups, auth tokens (API keys) and authentication settings.
Server https://api.kustomerapp.com/v1 · 33 operations
This category describes endpoints related to managing user access, roles, teams, permissions, and authentication in Kustomer.
To learn more, see Manage User Access and Authenticating Users in the Kustomer Help Center.
Auth Settings
Auth settings control how people sign in to your Kustomer org (with a Kustomer password, Google or SAML single sign-on) and how long their sessions last. A related endpoint returns the secret your server uses to verify chat customers' identity.
Auth Tokens
An auth token is the bearer credential sent with every API request. API keys are long-lived tokens that belong to a machine user with a fixed set of roles; session tokens are created when a person signs in. These endpoints list, inspect and revoke tokens.
Role Groups
A role group, called a permission set in the Kustomer app, is a named bundle of roles that decides what its members can see and do. Kustomer provides built-in role groups such as Administrator, and admins can create custom ones and assign them to users and teams.
Teams
A team is a named group of users, such as "Billing" or "Tier 2". Conversations can be assigned to a team, routing uses teams to decide which queues and capacity rules apply to an agent, and teams can carry role groups that grant their members permissions.
Teams (By ID)
A team is a named group of users, such as "Billing" or "Tier 2". Conversations can be assigned to a team, routing uses teams to decide which queues and capacity rules apply to an agent, and teams can carry role groups that grant their members permissions.
Users
A user is an account that works in your Kustomer org, such as an agent, an admin or a collaborator, or the machine user behind an API key. Users are the people and integrations doing the support work, as opposed to customers, who receive it.
Users (By ID)
A user is an account that works in your Kustomer org, such as an agent, an admin or a collaborator, or the machine user behind an API key. Users are the people and integrations doing the support work, as opposed to customers, who receive it.