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 CredentialListMapping Resource

The CredentialListMapping resource represents the CredentialList resources associated with a SIP Domain. A CredentialList resource contains the Credential resources of the users who can access the SIP Domain.

If an INVITE is received for a domain with a credential list mapped to it, we challenge the request and your system must authenticate it with a username and password. To be accepted, the username and password must be in one of the credential lists mapped to the SIP Domain.

SIP CredentialListMapping properties

Names in REST API format
account_sid
sid<AC> Not PII

The SID of the Account that created the CredentialListMapping resource.

date_created
date_time<rfc2822> Not PII

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

date_updated
date_time<rfc2822> Not PII

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

friendly_name

The string that you assigned to describe the resource.

sid
sid<CL> Not PII

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

Create a SIP CredentialListMapping resource

post
https://api.twilio.com/2010-04-01/Accounts/{AccountSid}/SIP/Domains/{DomainSid}/Auth/Calls/CredentialListMappings.json
Parameters
Names in REST API format
account_sid
Path
post sid<AC> Not PII

The SID of the Account that will create the resource.

domain_sid
Path
post sid<SD> Not PII

The SID of the SIP domain that will contain the new resource.

credential_list_sid
Required
post sid<CL> Not PII

The SID of the CredentialList resource to map to the SIP domain.

Example 1
        
        
        
        

        Fetch a SIP CredentialListMapping resource

        get
        https://api.twilio.com/2010-04-01/Accounts/{AccountSid}/SIP/Domains/{DomainSid}/Auth/Calls/CredentialListMappings/{Sid}.json
        Parameters
        Names in REST API format
        account_sid
        Path
        get sid<AC> Not PII

        The SID of the Account that created the CredentialListMapping resource to fetch.

        domain_sid
        Path
        get sid<SD> Not PII

        The SID of the SIP domain that contains the resource to fetch.

        sid
        Path
        get sid<CL> Not PII

        The Twilio-provided string that uniquely identifies the CredentialListMapping resource to fetch.

        Example 1
              
              
              
              

              Read multiple SIP CredentialListMapping resources

              get
              https://api.twilio.com/2010-04-01/Accounts/{AccountSid}/SIP/Domains/{DomainSid}/Auth/Calls/CredentialListMappings.json
              Parameters
              Names in REST API format
              account_sid
              Path
              get sid<AC> Not PII

              The SID of the Account that created the CredentialListMapping resources to read.

              domain_sid
              Path
              get sid<SD> Not PII

              The SID of the SIP domain that contains the resources to read.

              Example 1
                    
                    
                    
                    

                    Delete a SIP CredentialListMapping resource

                    delete
                    https://api.twilio.com/2010-04-01/Accounts/{AccountSid}/SIP/Domains/{DomainSid}/Auth/Calls/CredentialListMappings/{Sid}.json
                    Parameters
                    Names in REST API format
                    account_sid
                    Path
                    delete sid<AC> Not PII

                    The SID of the Account that created the CredentialListMapping resources to delete.

                    domain_sid
                    Path
                    delete sid<SD> Not PII

                    The SID of the SIP domain that contains the resource to delete.

                    sid
                    Path
                    delete sid<CL> Not PII

                    The Twilio-provided string that uniquely identifies the CredentialListMapping 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.