User Resource
The User resource represents a Twilio Frontline user who can log in to the Frontline application. Any user assigned to the Twilio Frontline application within your Identity Provider will be able to access Frontline.
API Base URL
All URLs in the reference documentation use the following base URL:
https://frontline-api.twilio.com/v1
User properties
| Resource Properties in REST API format | |
|---|---|
sid
|
The unique string that we created to identify the User resource. |
identity
|
The application-defined string that uniquely identifies the resource's User. This value is often a username or an email address, and is case-sensitive. |
friendly_name
|
The string that you assigned to describe the User. |
avatar
|
The avatar URL which will be shown in Frontline application. |
state
|
Current state of this user. Can be either |
is_available
|
Whether the User is available for new conversations. Defaults to |
url
|
An absolute API resource URL for this user. |
Fetch an User resource
https://frontline-api.twilio.com/v1/Users/{Sid}
Parameters
| Parameters in REST API format | |
|---|---|
sid
Path
|
The SID of the User resource to fetch. This value can be either the |
Example 1
Update an User resource
https://frontline-api.twilio.com/v1/Users/{Sid}
Parameters
| Parameters in REST API format | |
|---|---|
sid
Path
|
The SID of the User resource to update. This value can be either the |
friendly_name
Optional
|
The string that you assigned to describe the User. |
avatar
Optional
|
The avatar URL which will be shown in Frontline application. |
state
Optional
|
Current state of this user. Can be either |
is_available
Optional
|
Whether the User is available for new conversations. Set to |
Example 1
User Deactivation
A user can be deactivated by updating their state to deactivated. When a user is deactivated:
- All active sessions for that the user will be invalidated, and the user will be logged out
- The user will be removed from any pools they are a member of
Deactivating a user by itself does not block a user from logging in to Frontline in the future. Before deactivating a Frontline user, their access to Frontline should be removed from your SSO provider. Once a user no longer has access to Frontline through your SSO provider, deactivating that user will invalidate any existing Frontline sessions from that user.
If a user's state has been deactivated but that user still has access to Frontline through your SSO provider, on their next login, that user's state will be updated to active
Example 2
Need some help?
We all do sometimes; code is hard. Get help now from our support team, or lean on the wisdom of the crowd by visiting Twilio's Stack Overflow Collective or browsing the Twilio tag on Stack Overflow.