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?

SIP Credential Resource

The Credential resource stores usernames and password information.

Username and Password

Each Username requires a corresponding password that meets the requirements in the Password parameter's description.

We don't store the passwords you provide in the credential records as cleartext. Instead, they are MD5 hashed in accordance with the digest authentication specification.

SipCredential properties

Names in PHP format
sid
sid<CR> Not PII

A 34 character string that uniquely identifies this resource.

accountSid
sid<AC> Not PII

The unique id of the Account that is responsible for this resource.

credentialListSid
sid<CL> Not PII

The unique id that identifies the credential list that includes this credential.

username

The username for this credential.

dateCreated
date_time<rfc2822> Not PII

The date that this resource was created, given as GMT in RFC 2822 format.

dateUpdated
date_time<rfc2822> Not PII

The date that this resource was last updated, given as GMT in RFC 2822 format.

uri
uri Not PII

The URI for this resource, relative to https://api.twilio.com

Create a SipCredential resource

post
https://api.twilio.com/2010-04-01/Accounts/{AccountSid}/SIP/CredentialLists/{CredentialListSid}/Credentials.json
Parameters
Names in None format
account_sid
Required
post sid<AC> Not PII

The unique id of the Account that is responsible for this resource.

credential_list_sid
Required
post sid<CL> Not PII

The unique id that identifies the credential list to include the created credential.

username
Required
post string PII MTL: 30 DAYS

The username that will be passed when authenticating SIP requests. The username should be sent in response to Twilio's challenge of the initial INVITE. It can be up to 32 characters long.

password
Required
post string PII MTL: 30 DAYS

The password that the username will use when authenticating SIP requests. The password must be a minimum of 12 characters, contain at least 1 digit, and have mixed case. (eg IWasAtSignal2018)

Example 1
        
        
        
        

        Fetch a SipCredential resource

        get
        https://api.twilio.com/2010-04-01/Accounts/{AccountSid}/SIP/CredentialLists/{CredentialListSid}/Credentials/{Sid}.json
        Parameters
        Names in None format
        account_sid
        Required
        get sid<AC> Not PII

        The unique id of the Account that is responsible for this resource.

        credential_list_sid
        Required
        get sid<CL> Not PII

        The unique id that identifies the credential list that contains the desired credential.

        sid
        Required
        get sid<CR> Not PII

        The unique id that identifies the resource to fetch.

        Example 1
              
              
              
              

              Read multiple SipCredential resources

              get
              https://api.twilio.com/2010-04-01/Accounts/{AccountSid}/SIP/CredentialLists/{CredentialListSid}/Credentials.json
              Parameters
              Names in None format
              account_sid
              Required
              get sid<AC> Not PII

              The unique id of the Account that is responsible for this resource.

              credential_list_sid
              Required
              get sid<CL> Not PII

              The unique id that identifies the credential list that contains the desired credentials.

              Example 1
                    
                    
                    
                    

                    Update a SipCredential resource

                    post
                    https://api.twilio.com/2010-04-01/Accounts/{AccountSid}/SIP/CredentialLists/{CredentialListSid}/Credentials/{Sid}.json

                    The update action is used to update a user's password.

                    Parameters
                    Names in None format
                    account_sid
                    Required
                    post sid<AC> Not PII

                    The unique id of the Account that is responsible for this resource.

                    credential_list_sid
                    Required
                    post sid<CL> Not PII

                    The unique id that identifies the credential list that includes this credential.

                    sid
                    Required
                    post sid<CR> Not PII

                    The unique id that identifies the resource to update.

                    password
                    Optional
                    post string PII MTL: 30 DAYS

                    The password that the username will use when authenticating SIP requests. The password must be a minimum of 12 characters, contain at least 1 digit, and have mixed case. (eg IWasAtSignal2018)

                    Example 1
                          
                          
                          
                          

                          Delete a SipCredential resource

                          delete
                          https://api.twilio.com/2010-04-01/Accounts/{AccountSid}/SIP/CredentialLists/{CredentialListSid}/Credentials/{Sid}.json
                          Parameters
                          Names in None format
                          account_sid
                          Required
                          delete sid<AC> Not PII

                          The unique id of the Account that is responsible for this resource.

                          credential_list_sid
                          Required
                          delete sid<CL> Not PII

                          The unique id that identifies the credential list that contains the desired credentials.

                          sid
                          Required
                          delete sid<CR> Not PII

                          The unique id that identifies the resource to delete.

                          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.