Menu

Expand
Rate this page:

Thanks for rating this page!

We are always striving to improve our documentation quality, and your feedback is valuable to us. How could this documentation serve you better?

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
sid<NU> Not PII

The unique string that we created to identify the User resource.

account_sid
sid<AC> Not PII

The SID of the Account that created the User resource.

service_sid
sid<IS> Not PII

The SID of the Service the resource is associated with.

identity
string Not PII

The application-defined string that uniquely identifies the resource's User within the Service. See access tokens for more info.

date_created
date_time<iso8601> Not PII

The date and time in GMT when the resource was created specified in RFC 2822 format.

date_updated
date_time<iso8601> Not PII

The date and time in GMT when the resource was last updated specified in RFC 2822 format.

segments
string[] Not PII

Deprecated.

url
url Not PII

The absolute URL of the User resource.

links
uri_map Not PII

The absolute URLs of related resources.

Create an User resource

post
https://notify.twilio.com/v1/Services/{ServiceSid}/Users
Parameters
Parameters in REST API format
service_sid
Path
post sid<IS> Not PII

The SID of the Service to create the resource under.

identity
Required
post string Not PII

The application-defined string that uniquely identifies the resource's User within the Service. See access tokens for more info.

segment
Optional
post string[] Not PII

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

        get
        https://notify.twilio.com/v1/Services/{ServiceSid}/Users/{Identity}
        Parameters
        Parameters in REST API format
        service_sid
        Path
        get sid<IS> Not PII

        The SID of the Service to fetch the resource from.

        identity
        Path
        get sid_like<NU> Not PII

        The application-defined string that uniquely identifies the resource to fetch. See access tokens for more info.

        Example 1
              
              
              
              

              Read multiple User resources

              get
              https://notify.twilio.com/v1/Services/{ServiceSid}/Users
              Parameters
              Parameters in REST API format
              service_sid
              Path
              get sid<IS> Not PII

              The SID of the Service to read the resource from.

              identity
              Optional
              get string[] Not PII

              The application-defined string that uniquely identifies the resource to read. See access tokens for more info.

              segment
              Optional
              get string Not PII

              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

                    delete
                    https://notify.twilio.com/v1/Services/{ServiceSid}/Users/{Identity}
                    Parameters
                    Parameters in REST API format
                    service_sid
                    Path
                    delete sid<IS> Not PII

                    The SID of the Service to delete the resource from.

                    identity
                    Path
                    delete sid_like<NU> Not PII

                    The application-defined string that uniquely identifies the resource to delete. See access tokens for more info.

                    Example 1
                          
                          
                          
                          
                          Rate this page:

                          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 browsing the Twilio tag on Stack Overflow.