Menu

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

account_sid
sid<AC> Not PII

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

credential_list_sid
sid<CL> Not PII

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

date_created
date_time<rfc2822> Not PII

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

date_updated
date_time<rfc2822> Not PII

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

sid
sid<CR> Not PII

A 34 character string that uniquely identifies this resource.

uri
uri Not PII

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

username

The username for this credential.

Create a SipCredential resource

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

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

CredentialListSid
Required
post sid<CL> Not PII

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

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”)

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.

Example 1
Loading Code Sample...
      
      
      
      

      Fetch a SipCredential resource

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

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

      CredentialListSid
      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
      Loading Code Sample...
          
          
          
          

          Read multiple SipCredential resources

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

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

          CredentialListSid
          Required
          get sid<CL> Not PII

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

          Example 1
          Loading Code Sample...
              
              
              
              

              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
              AccountSid
              Required
              post sid<AC> Not PII

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

              CredentialListSid
              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
              Loading Code Sample...
                  
                  
                  
                  

                  Delete a SipCredential resource

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

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

                  CredentialListSid
                  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
                  Loading Code Sample...
                      
                      
                      
                      

                      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.

                      Loading Code Sample...