Skip to contentSkip to navigationSkip to topbar
Rate this page:
On this page

SIP CredentialList Resource


SIP CredentialList resources contain the credentials of the users who are allowed to reach your SIP Domain. We only allow traffic from users who have their credentials in the credential list.

For information about the individual Credential resources in the list, such as to create, list, read, update, or delete individual credentials, see the Credential Resource.

After you create a CredentialList resource, you will need to map it to your SIP domain for it to take effect. You can map a CredentialList to more than one SIP domain.

Your Account can have up to 100 CredentialList resources.

Each CredentialList resource can contain up to 1,000 unique users.


CredentialList Properties

credentiallist-properties page anchor
Property nameTypeRequiredDescriptionChild properties
account_sidSID<AC>Optional
Not PII

The unique id of the Account that owns this resource.

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

date_updatedstring<date-time-rfc-2822>Optional

The date that this resource was last updated, given as GMT in RFC 2822(link takes you to an external page) format.


friendly_namestringOptional

A human readable descriptive text that describes the CredentialList, up to 64 characters long.


sidSID<CL>Optional

A 34 character string that uniquely identifies this resource.

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

subresource_urisobject<uri-map>Optional

A list of credentials associated with this credential list.


uristringOptional

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


Create a SIP CredentialList resource

create-a-sip-credentiallist-resource page anchor
POST https://api.twilio.com/2010-04-01/Accounts/{AccountSid}/SIP/CredentialLists.json

Path parameters

path-parameters page anchor
Property nameTypeRequiredPIIDescription
AccountSidSID<AC>required

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

Pattern: ^AC[0-9a-fA-F]{32}$Min length: 34Max length: 34
Encoding type:application/x-www-form-urlencoded
SchemaExample
Property nameTypeRequiredDescriptionChild properties
FriendlyNamestringrequired

A human readable descriptive text that describes the CredentialList, up to 64 characters long.

Create a SIP CredentialList resourceLink to code sample: Create a SIP CredentialList resource
1
// Download the helper library from https://www.twilio.com/docs/node/install
2
const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";
3
4
// Find your Account SID and Auth Token at twilio.com/console
5
// and set the environment variables. See http://twil.io/secure
6
const accountSid = process.env.TWILIO_ACCOUNT_SID;
7
const authToken = process.env.TWILIO_AUTH_TOKEN;
8
const client = twilio(accountSid, authToken);
9
10
async function createSipCredentialList() {
11
const credentialList = await client.sip.credentialLists.create({
12
friendlyName: "friendly_name",
13
});
14
15
console.log(credentialList.accountSid);
16
}
17
18
createSipCredentialList();

Output

1
{
2
"account_sid": "ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
3
"date_created": "Wed, 11 Sep 2013 17:51:38 +0000",
4
"date_updated": "Wed, 11 Sep 2013 17:51:38 +0000",
5
"friendly_name": "friendly_name",
6
"sid": "CLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
7
"subresource_uris": {
8
"credentials": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/CredentialLists/CLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Credentials.json"
9
},
10
"uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/CredentialLists/CLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json"
11
}

Fetch a SIP CredentialList resource

fetch-a-sip-credentiallist-resource page anchor
GET https://api.twilio.com/2010-04-01/Accounts/{AccountSid}/SIP/CredentialLists/{Sid}.json

Property nameTypeRequiredPIIDescription
AccountSidSID<AC>required

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

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

SidSID<CL>required

The credential list Sid that uniquely identifies this resource

Pattern: ^CL[0-9a-fA-F]{32}$Min length: 34Max length: 34
1
// Download the helper library from https://www.twilio.com/docs/node/install
2
const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";
3
4
// Find your Account SID and Auth Token at twilio.com/console
5
// and set the environment variables. See http://twil.io/secure
6
const accountSid = process.env.TWILIO_ACCOUNT_SID;
7
const authToken = process.env.TWILIO_AUTH_TOKEN;
8
const client = twilio(accountSid, authToken);
9
10
async function fetchSipCredentialList() {
11
const credentialList = await client.sip
12
.credentialLists("CLXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX")
13
.fetch();
14
15
console.log(credentialList.accountSid);
16
}
17
18
fetchSipCredentialList();

Output

1
{
2
"account_sid": "ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
3
"date_created": "Wed, 11 Sep 2013 17:51:38 +0000",
4
"date_updated": "Wed, 11 Sep 2013 17:51:38 +0000",
5
"friendly_name": "Low Rises",
6
"sid": "CLXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
7
"subresource_uris": {
8
"credentials": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/CredentialLists/CLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Credentials.json"
9
},
10
"uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/CredentialLists/CLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json"
11
}

Read multiple SIP CredentialList resources

read-multiple-sip-credentiallist-resources page anchor
GET https://api.twilio.com/2010-04-01/Accounts/{AccountSid}/SIP/CredentialLists.json

Property nameTypeRequiredPIIDescription
AccountSidSID<AC>required

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

Pattern: ^AC[0-9a-fA-F]{32}$Min length: 34Max length: 34
Property nameTypeRequiredPIIDescription
PageSizeintegerOptional

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

Minimum: 1Maximum: 1000

PageintegerOptional

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

Minimum: 0

PageTokenstringOptional

The page token. This is provided by the API.

Read multiple SIP CredentialList resourcesLink to code sample: Read multiple SIP CredentialList resources
1
// Download the helper library from https://www.twilio.com/docs/node/install
2
const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";
3
4
// Find your Account SID and Auth Token at twilio.com/console
5
// and set the environment variables. See http://twil.io/secure
6
const accountSid = process.env.TWILIO_ACCOUNT_SID;
7
const authToken = process.env.TWILIO_AUTH_TOKEN;
8
const client = twilio(accountSid, authToken);
9
10
async function listSipCredentialList() {
11
const credentialLists = await client.sip.credentialLists.list({ limit: 20 });
12
13
credentialLists.forEach((c) => console.log(c.accountSid));
14
}
15
16
listSipCredentialList();

Output

1
{
2
"credential_lists": [
3
{
4
"account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
5
"date_created": "Wed, 11 Sep 2013 17:51:38 +0000",
6
"date_updated": "Wed, 11 Sep 2013 17:51:38 +0000",
7
"friendly_name": "Low Rises",
8
"sid": "CLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
9
"subresource_uris": {
10
"credentials": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/CredentialLists/CLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Credentials.json"
11
},
12
"uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/CredentialLists/CLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json"
13
}
14
],
15
"first_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/CredentialLists.json?PageSize=50&Page=0",
16
"next_page_uri": null,
17
"start": 0,
18
"end": 0,
19
"page": 0,
20
"page_size": 50,
21
"previous_page_uri": null,
22
"uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/CredentialLists.json?PageSize=50&Page=0"
23
}

Update a SIP CredentialList resource

update-a-sip-credentiallist-resource page anchor
POST https://api.twilio.com/2010-04-01/Accounts/{AccountSid}/SIP/CredentialLists/{Sid}.json

Property nameTypeRequiredPIIDescription
AccountSidSID<AC>required

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

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

SidSID<CL>required

The credential list Sid that uniquely identifies this resource

Pattern: ^CL[0-9a-fA-F]{32}$Min length: 34Max length: 34
Encoding type:application/x-www-form-urlencoded
SchemaExample
Property nameTypeRequiredDescriptionChild properties
FriendlyNamestringrequired

A human readable descriptive text for a CredentialList, up to 64 characters long.

1
// Download the helper library from https://www.twilio.com/docs/node/install
2
const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";
3
4
// Find your Account SID and Auth Token at twilio.com/console
5
// and set the environment variables. See http://twil.io/secure
6
const accountSid = process.env.TWILIO_ACCOUNT_SID;
7
const authToken = process.env.TWILIO_AUTH_TOKEN;
8
const client = twilio(accountSid, authToken);
9
10
async function updateSipCredentialList() {
11
const credentialList = await client.sip
12
.credentialLists("CLXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX")
13
.update({ friendlyName: "friendly_name" });
14
15
console.log(credentialList.accountSid);
16
}
17
18
updateSipCredentialList();

Output

1
{
2
"account_sid": "ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
3
"date_created": "Wed, 11 Sep 2013 17:51:38 +0000",
4
"date_updated": "Wed, 11 Sep 2013 17:51:38 +0000",
5
"friendly_name": "friendly_name",
6
"sid": "CLXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
7
"subresource_uris": {
8
"credentials": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/CredentialLists/CLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Credentials.json"
9
},
10
"uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/CredentialLists/CLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json"
11
}

Delete a SIP CredentialList resource

delete-a-sip-credentiallist-resource page anchor
DELETE https://api.twilio.com/2010-04-01/Accounts/{AccountSid}/SIP/CredentialLists/{Sid}.json

Property nameTypeRequiredPIIDescription
AccountSidSID<AC>required

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

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

SidSID<CL>required

The credential list Sid that uniquely identifies this resource

Pattern: ^CL[0-9a-fA-F]{32}$Min length: 34Max length: 34
1
// Download the helper library from https://www.twilio.com/docs/node/install
2
const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";
3
4
// Find your Account SID and Auth Token at twilio.com/console
5
// and set the environment variables. See http://twil.io/secure
6
const accountSid = process.env.TWILIO_ACCOUNT_SID;
7
const authToken = process.env.TWILIO_AUTH_TOKEN;
8
const client = twilio(accountSid, authToken);
9
10
async function deleteSipCredentialList() {
11
await client.sip
12
.credentialLists("CLXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX")
13
.remove();
14
}
15
16
deleteSipCredentialList();

Rate this page: