Menu

Expand
Rate this page:

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.

SIP Credential properties

Resource Properties in REST API format
sid
sid<CR> Not PII

A 34 character string that uniquely identifies this resource.

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.

username

The username for 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.

uri
uri Not PII

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

Create a SIP Credential resource

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

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

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

        Create a SIP Credential resource

        Fetch a SIP Credential resource

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

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

        credential_list_sid
        Path
        get sid<CL> Not PII

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

        sid
        Path
        get sid<CR> Not PII

        The unique id that identifies the resource to fetch.

        Example 1
        Loading Code Sample...
              
              

              Fetch a SIP Credential resource

              Read multiple SIP Credential resources

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

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

              credential_list_sid
              Path
              get sid<CL> Not PII

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

              Example 1
              Loading Code Sample...
                    
                    

                    Read multiple SIP Credential resources

                    Update a SIP Credential 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
                    Parameters in REST API format
                    account_sid
                    Path
                    post sid<AC> Not PII

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

                    credential_list_sid
                    Path
                    post sid<CL> Not PII

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

                    sid
                    Path
                    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...
                          
                          

                          Update a SIP Credential resource

                          Delete a SIP Credential resource

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

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

                          credential_list_sid
                          Path
                          delete sid<CL> Not PII

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

                          sid
                          Path
                          delete sid<CR> Not PII

                          The unique id that identifies the resource to delete.

                          Example 1
                          Loading Code Sample...
                                
                                

                                Delete a SIP Credential resource

                                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 by visiting Twilio's Stack Overflow Collective or browsing the Twilio tag on Stack Overflow.

                                Loading Code Sample...
                                      
                                      
                                      

                                      Thank you for your feedback!

                                      Please select the reason(s) for your feedback. The additional information you provide helps us improve our documentation:

                                      Sending your feedback...
                                      🎉 Thank you for your feedback!
                                      Something went wrong. Please try again.

                                      Thanks for your feedback!

                                      thanks-feedback-gif