User Resource
The User resource is deprecated and has been replaced by the identity
property of the Binding resource.
The User resource represents a user in your application.
Because the User resource is deprecated, use the identity
property of the Binding resource to identify a specific user.
Do not use Personally Identifiable Information for Identity.
The systems that process this parameter assume it does not contain PII.
You should use a GUID or other pseudonymized identifier for identity
instead of PII such as a person's name, home address, email or phone number. If you identify your users with PII, we recommend creating a pseudonymized identifier from their PII, for example by hashing or encrypting it, before you use it for identity
.
You can read more about how we process your data in our privacy policy.
User properties
The User resource is deprecated.
Resource Properties in REST API format | |
---|---|
sid
|
The unique string that we created to identify the User resource. |
account_sid
|
The SID of the Account that created the User resource. |
service_sid
|
The SID of the Service the resource is associated with. |
identity
|
The application-defined string that uniquely identifies the resource's User within the Service. See access tokens for more info. |
date_created
|
The date and time in GMT when the resource was created specified in RFC 2822 format. |
date_updated
|
The date and time in GMT when the resource was last updated specified in RFC 2822 format. |
segments
|
Deprecated. |
url
|
The absolute URL of the User resource. |
links
|
The absolute URLs of related resources. |
Create an User resource
https://notify.twilio.com/v1/Services/{ServiceSid}/Users
Parameters
Parameters in REST API format | |
---|---|
service_sid
Path
|
The SID of the Service to create the resource under. |
identity
Required
|
The application-defined string that uniquely identifies the resource's User within the Service. See access tokens for more info. |
segment
Optional
|
The list of segments this User belongs to. Segments can be used to select recipients of a notification. Maximum 20 Segments per User allowed. |
Example 1
Fetch an User resource
https://notify.twilio.com/v1/Services/{ServiceSid}/Users/{Identity}
Parameters
Parameters in REST API format | |
---|---|
service_sid
Path
|
The SID of the Service to fetch the resource from. |
identity
Path
|
The application-defined string that uniquely identifies the resource to fetch. See access tokens for more info. |
Example 1
Read multiple User resources
https://notify.twilio.com/v1/Services/{ServiceSid}/Users
Parameters
Parameters in REST API format | |
---|---|
service_sid
Path
|
The SID of the Service to read the resource from. |
identity
Optional
|
The application-defined string that uniquely identifies the resource to read. See access tokens for more info. |
segment
Optional
|
The list of segments this User belongs to. Segments can be used to select recipients of a notification. Maximum 20 Segments per User allowed. |
Example 1
Delete an User resource
https://notify.twilio.com/v1/Services/{ServiceSid}/Users/{Identity}
Parameters
Parameters in REST API format | |
---|---|
service_sid
Path
|
The SID of the Service to delete the resource from. |
identity
Path
|
The application-defined string that uniquely identifies the resource to delete. See access tokens for more info. |
Example 1
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.