Skip to contentSkip to navigationSkip to topbar
Rate this Page:

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

sip-credentiallistmapping-properties page anchor
Resource properties
account_sidtype: SID<AC>Not PII

date_createdtype: string<DATE TIME RFC 2822>Not PII

The date and time in GMT that the resource was created specified in RFC 2822(link takes you to an external page) format.


date_updatedtype: string<DATE TIME RFC 2822>Not PII

The date and time in GMT that the resource was last updated specified in RFC 2822(link takes you to an external page) format.


friendly_nametype: stringPII MTL: 0 days

The string that you assigned to describe the resource.


sidtype: SID<CL>Not PII

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


Create a SIP CredentialListMapping resource

create-a-sip-credentiallistmapping-resource page anchor
POST https://api.twilio.com/2010-04-01/Accounts/{AccountSid}/SIP/Domains/{DomainSid}/Auth/Calls/CredentialListMappings.json

Parameters

create-parameters page anchor
URI parameters
AccountSidtype: SID<AC>Not PII
Path Parameter

The SID of the Account(link takes you to an external page) that will create the resource.


DomainSidtype: SID<SD>Not PII
Path Parameter

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


Request body parameters
CredentialListSidtype: SID<CL>Not PII
Required

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

Create a SIP CredentialListMapping resource

create-a-sip-credentiallistmapping-resource-1 page anchor
Node.js
Python
C#
Java
Go
PHP
Ruby
twilio-cli
curl

_13
// Download the helper library from https://www.twilio.com/docs/node/install
_13
// Find your Account SID and Auth Token at twilio.com/console
_13
// and set the environment variables. See http://twil.io/secure
_13
const accountSid = process.env.TWILIO_ACCOUNT_SID;
_13
const authToken = process.env.TWILIO_AUTH_TOKEN;
_13
const client = require('twilio')(accountSid, authToken);
_13
_13
client.sip.domains('SDXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX')
_13
.auth
_13
.calls
_13
.credentialListMappings
_13
.create({credentialListSid: 'CLXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX'})
_13
.then(auth_calls_credential_list_mapping => console.log(auth_calls_credential_list_mapping.sid));

Output

_10
{
_10
"account_sid": "ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_10
"date_created": "Thu, 30 Jul 2015 20:00:00 +0000",
_10
"date_updated": "Thu, 30 Jul 2015 20:00:00 +0000",
_10
"friendly_name": "friendly_name",
_10
"sid": "CLXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
_10
}


Fetch a SIP CredentialListMapping resource

fetch-a-sip-credentiallistmapping-resource page anchor
GET https://api.twilio.com/2010-04-01/Accounts/{AccountSid}/SIP/Domains/{DomainSid}/Auth/Calls/CredentialListMappings/{Sid}.json

URI parameters
AccountSidtype: SID<AC>Not PII
Path Parameter

The SID of the Account(link takes you to an external page) that created the CredentialListMapping resource to fetch.


DomainSidtype: SID<SD>Not PII
Path Parameter

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


Sidtype: SID<CL>Not PII
Path Parameter

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

Fetch a SIP CredentialListMapping resource

fetch-a-sip-credentiallistmapping-resource-1 page anchor
Node.js
Python
C#
Java
Go
PHP
Ruby
twilio-cli
curl

_13
// Download the helper library from https://www.twilio.com/docs/node/install
_13
// Find your Account SID and Auth Token at twilio.com/console
_13
// and set the environment variables. See http://twil.io/secure
_13
const accountSid = process.env.TWILIO_ACCOUNT_SID;
_13
const authToken = process.env.TWILIO_AUTH_TOKEN;
_13
const client = require('twilio')(accountSid, authToken);
_13
_13
client.sip.domains('SDXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX')
_13
.auth
_13
.calls
_13
.credentialListMappings('CLXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX')
_13
.fetch()
_13
.then(auth_calls_credential_list_mapping => console.log(auth_calls_credential_list_mapping.friendlyName));

Output

_10
{
_10
"account_sid": "ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_10
"date_created": "Thu, 30 Jul 2015 20:00:00 +0000",
_10
"date_updated": "Thu, 30 Jul 2015 20:00:00 +0000",
_10
"friendly_name": "friendly_name",
_10
"sid": "CLXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
_10
}


Read multiple SIP CredentialListMapping resources

read-multiple-sip-credentiallistmapping-resources page anchor
GET https://api.twilio.com/2010-04-01/Accounts/{AccountSid}/SIP/Domains/{DomainSid}/Auth/Calls/CredentialListMappings.json

URI parameters
AccountSidtype: SID<AC>Not PII
Path Parameter

The SID of the Account(link takes you to an external page) that created the CredentialListMapping resources to read.


DomainSidtype: SID<SD>Not PII
Path Parameter

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


PageSizetype: integerNot PII
Query Parameter

How many resources to return in each list page. The default is 50, and the maximum is 1000.


Pagetype: integerNot PII
Query Parameter

The page index. This value is simply for client state.


PageTokentype: stringNot PII
Query Parameter

The page token. This is provided by the API.

Read multiple SIP CredentialListMapping resources

read-multiple-sip-credentiallistmapping-resources-1 page anchor
Node.js
Python
C#
Java
Go
PHP
Ruby
twilio-cli
curl

_13
// Download the helper library from https://www.twilio.com/docs/node/install
_13
// Find your Account SID and Auth Token at twilio.com/console
_13
// and set the environment variables. See http://twil.io/secure
_13
const accountSid = process.env.TWILIO_ACCOUNT_SID;
_13
const authToken = process.env.TWILIO_AUTH_TOKEN;
_13
const client = require('twilio')(accountSid, authToken);
_13
_13
client.sip.domains('SDXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX')
_13
.auth
_13
.calls
_13
.credentialListMappings
_13
.list({limit: 20})
_13
.then(credentialListMappings => credentialListMappings.forEach(c => console.log(c.sid)));

Output

_11
{
_11
"first_page_uri": "/2010-04-01/Accounts/ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/SIP/Domains/SDXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Auth/Calls/CredentialListMappings.json?PageSize=50&Page=0",
_11
"end": 0,
_11
"previous_page_uri": "/2010-04-01/Accounts/ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/SIP/Domains/SDXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Auth/Calls/CredentialListMappings.json?PageSize=50&Page=0",
_11
"contents": [],
_11
"uri": "/2010-04-01/Accounts/ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/SIP/Domains/SDXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Auth/Calls/CredentialListMappings.json?PageSize=50&Page=0",
_11
"page_size": 50,
_11
"start": 0,
_11
"next_page_uri": "/2010-04-01/Accounts/ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/SIP/Domains/SDXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Auth/Calls/CredentialListMappings.json?PageSize=50&Page=50",
_11
"page": 0
_11
}


Delete a SIP CredentialListMapping resource

delete-a-sip-credentiallistmapping-resource page anchor
DELETE https://api.twilio.com/2010-04-01/Accounts/{AccountSid}/SIP/Domains/{DomainSid}/Auth/Calls/CredentialListMappings/{Sid}.json

URI parameters
AccountSidtype: SID<AC>Not PII
Path Parameter

The SID of the Account(link takes you to an external page) that created the CredentialListMapping resources to delete.


DomainSidtype: SID<SD>Not PII
Path Parameter

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


Sidtype: SID<CL>Not PII
Path Parameter

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

Delete a SIP CredentialListMapping resource

delete-a-sip-credentiallistmapping-resource-1 page anchor
Node.js
Python
C#
Java
Go
PHP
Ruby
twilio-cli
curl

_12
// Download the helper library from https://www.twilio.com/docs/node/install
_12
// Find your Account SID and Auth Token at twilio.com/console
_12
// and set the environment variables. See http://twil.io/secure
_12
const accountSid = process.env.TWILIO_ACCOUNT_SID;
_12
const authToken = process.env.TWILIO_AUTH_TOKEN;
_12
const client = require('twilio')(accountSid, authToken);
_12
_12
client.sip.domains('SDXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX')
_12
.auth
_12
.calls
_12
.credentialListMappings('CLXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX')
_12
.remove();


Rate this Page: