Skip to contentSkip to navigationSkip to topbar
Twilio Docs
Rate this page:
On 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

Property nameTypePIIDescription
account_sidSID<AC>
Not PII

The SID of the Account that created the CredentialListMapping resource.

Pattern: ^AC[0-9a-fA-F]{32}$Min length: 34Max length: 34
date_createdstring<date-time-rfc-2822>
Not PII

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

date_updatedstring<date-time-rfc-2822>
Not PII

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

friendly_namestring
PII MTL: 0 days

The string that you assigned to describe the resource.

sidSID<CL>
Not PII

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

Pattern: ^CL[0-9a-fA-F]{32}$Min length: 34Max length: 34

Create a SIP CredentialListMapping resource

POST https://api.twilio.com/2010-04-01/Accounts/{AccountSid}/SIP/Domains/{DomainSid}/Auth/Calls/CredentialListMappings.json

Path parameters

Property nameTypeRequiredPIIDescription
AccountSidSID<AC>required
Not PII

The SID of the Account that will create the resource.

Pattern: ^AC[0-9a-fA-F]{32}$Min length: 34Max length: 34
DomainSidSID<SD>required
Not PII

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

Pattern: ^SD[0-9a-fA-F]{32}$Min length: 34Max length: 34

Request body parameters

Property nameTypeRequiredPIIDescription
CredentialListSidSID<CL>required
Not PII

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

Pattern: ^CL[0-9a-fA-F]{32}$Min length: 34Max length: 34

Create a SIP CredentialListMapping resource

Node.js
Python
C#
Java
Go
PHP
Ruby
twilio-cli
curl

_20
// Download the helper library from https://www.twilio.com/docs/node/install
_20
const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";
_20
_20
// Find your Account SID and Auth Token at twilio.com/console
_20
// and set the environment variables. See http://twil.io/secure
_20
const accountSid = process.env.TWILIO_ACCOUNT_SID;
_20
const authToken = process.env.TWILIO_AUTH_TOKEN;
_20
const client = twilio(accountSid, authToken);
_20
_20
async function createSipAuthCallsCredentialListMapping() {
_20
const credentialListMapping = await client.sip
_20
.domains("SDXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX")
_20
.auth.calls.credentialListMappings.create({
_20
credentialListSid: "CLXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_20
});
_20
_20
console.log(credentialListMapping.accountSid);
_20
}
_20
_20
createSipAuthCallsCredentialListMapping();

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": "CLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
_10
}

Fetch a SIP CredentialListMapping resource

GET https://api.twilio.com/2010-04-01/Accounts/{AccountSid}/SIP/Domains/{DomainSid}/Auth/Calls/CredentialListMappings/{Sid}.json

Path parameters

Property nameTypeRequiredPIIDescription
AccountSidSID<AC>required
Not PII

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

Pattern: ^AC[0-9a-fA-F]{32}$Min length: 34Max length: 34
DomainSidSID<SD>required
Not PII

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

Pattern: ^SD[0-9a-fA-F]{32}$Min length: 34Max length: 34
SidSID<CL>required
Not PII

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

Pattern: ^CL[0-9a-fA-F]{32}$Min length: 34Max length: 34

Fetch a SIP CredentialListMapping resource

Node.js
Python
C#
Java
Go
PHP
Ruby
twilio-cli
curl

_19
// Download the helper library from https://www.twilio.com/docs/node/install
_19
const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";
_19
_19
// Find your Account SID and Auth Token at twilio.com/console
_19
// and set the environment variables. See http://twil.io/secure
_19
const accountSid = process.env.TWILIO_ACCOUNT_SID;
_19
const authToken = process.env.TWILIO_AUTH_TOKEN;
_19
const client = twilio(accountSid, authToken);
_19
_19
async function fetchSipAuthCallsCredentialListMapping() {
_19
const credentialListMapping = await client.sip
_19
.domains("SDXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX")
_19
.auth.calls.credentialListMappings("CLXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX")
_19
.fetch();
_19
_19
console.log(credentialListMapping.accountSid);
_19
}
_19
_19
fetchSipAuthCallsCredentialListMapping();

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

GET https://api.twilio.com/2010-04-01/Accounts/{AccountSid}/SIP/Domains/{DomainSid}/Auth/Calls/CredentialListMappings.json

Path parameters

Property nameTypeRequiredPIIDescription
AccountSidSID<AC>required
Not PII

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

Pattern: ^AC[0-9a-fA-F]{32}$Min length: 34Max length: 34
DomainSidSID<SD>required
Not PII

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

Pattern: ^SD[0-9a-fA-F]{32}$Min length: 34Max length: 34

Query parameters

Property nameTypeRequiredPIIDescription
PageSizeintegerOptional
Not PII

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

Minimum: 1Maximum: 1000
PageintegerOptional
Not PII

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

Minimum: 0
PageTokenstringOptional
Not PII

The page token. This is provided by the API.

Read multiple SIP CredentialListMapping resources

Node.js
Python
C#
Java
Go
PHP
Ruby
twilio-cli
curl

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

Output

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

Delete a SIP CredentialListMapping resource

DELETE https://api.twilio.com/2010-04-01/Accounts/{AccountSid}/SIP/Domains/{DomainSid}/Auth/Calls/CredentialListMappings/{Sid}.json

Path parameters

Property nameTypeRequiredPIIDescription
AccountSidSID<AC>required
Not PII

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

Pattern: ^AC[0-9a-fA-F]{32}$Min length: 34Max length: 34
DomainSidSID<SD>required
Not PII

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

Pattern: ^SD[0-9a-fA-F]{32}$Min length: 34Max length: 34
SidSID<CL>required
Not PII

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

Pattern: ^CL[0-9a-fA-F]{32}$Min length: 34Max length: 34

Delete a SIP CredentialListMapping resource

Node.js
Python
C#
Java
Go
PHP
Ruby
twilio-cli
curl

_17
// Download the helper library from https://www.twilio.com/docs/node/install
_17
const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";
_17
_17
// Find your Account SID and Auth Token at twilio.com/console
_17
// and set the environment variables. See http://twil.io/secure
_17
const accountSid = process.env.TWILIO_ACCOUNT_SID;
_17
const authToken = process.env.TWILIO_AUTH_TOKEN;
_17
const client = twilio(accountSid, authToken);
_17
_17
async function deleteSipAuthCallsCredentialListMapping() {
_17
await client.sip
_17
.domains("SDXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX")
_17
.auth.calls.credentialListMappings("CLXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX")
_17
.remove();
_17
}
_17
_17
deleteSipAuthCallsCredentialListMapping();

Rate this page: