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.


SipCredentialList Properties

sipcredentiallist-properties page anchor
account_sidSID<AC>
Not PII

The unique id of the Account(link takes you to an external page) that owns this resource.

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

date_createdstring<date-time-rfc-2822>

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


date_updatedstring<date-time-rfc-2822>

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


friendly_namestring

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


sidSID<CL>

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>

A list of credentials associated with this credential list.


uristring

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
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
FriendlyNamestringrequired

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

Create a SIP CredentialList resource

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

_10
// Download the helper library from https://www.twilio.com/docs/node/install
_10
// Find your Account SID and Auth Token at twilio.com/console
_10
// and set the environment variables. See http://twil.io/secure
_10
const accountSid = process.env.TWILIO_ACCOUNT_SID;
_10
const authToken = process.env.TWILIO_AUTH_TOKEN;
_10
const client = require('twilio')(accountSid, authToken);
_10
_10
client.sip.credentialLists
_10
.create({friendlyName: 'friendly_name'})
_10
.then(credential_list => console.log(credential_list.sid));

Output

_11
{
_11
"account_sid": "ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_11
"date_created": "Wed, 11 Sep 2013 17:51:38 +0000",
_11
"date_updated": "Wed, 11 Sep 2013 17:51:38 +0000",
_11
"friendly_name": "friendly_name",
_11
"sid": "CLXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_11
"subresource_uris": {
_11
"credentials": "/2010-04-01/Accounts/ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/SIP/CredentialLists/CLXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Credentials.json"
_11
},
_11
"uri": "/2010-04-01/Accounts/ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/SIP/CredentialLists/CLXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX.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

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

Fetch a SIP CredentialList resource

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

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

Output

_11
{
_11
"account_sid": "ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_11
"date_created": "Wed, 11 Sep 2013 17:51:38 +0000",
_11
"date_updated": "Wed, 11 Sep 2013 17:51:38 +0000",
_11
"friendly_name": "Low Rises",
_11
"sid": "CLXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_11
"subresource_uris": {
_11
"credentials": "/2010-04-01/Accounts/ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/SIP/CredentialLists/CLXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Credentials.json"
_11
},
_11
"uri": "/2010-04-01/Accounts/ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/SIP/CredentialLists/CLXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX.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

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
PageSizeinteger

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

Minimum: 1Maximum: 1000

Pageinteger

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

Minimum: 0

PageTokenstring

The page token. This is provided by the API.

Read multiple SIP CredentialList resources

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

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

Output

_23
{
_23
"credential_lists": [
_23
{
_23
"account_sid": "ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_23
"date_created": "Wed, 11 Sep 2013 17:51:38 +0000",
_23
"date_updated": "Wed, 11 Sep 2013 17:51:38 +0000",
_23
"friendly_name": "Low Rises",
_23
"sid": "CLXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_23
"subresource_uris": {
_23
"credentials": "/2010-04-01/Accounts/ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/SIP/CredentialLists/CLXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Credentials.json"
_23
},
_23
"uri": "/2010-04-01/Accounts/ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/SIP/CredentialLists/CLXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX.json"
_23
}
_23
],
_23
"first_page_uri": "/2010-04-01/Accounts/ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/SIP/CredentialLists.json?PageSize=50&Page=0",
_23
"next_page_uri": "/2010-04-01/Accounts/ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/SIP/CredentialLists.json?PageSize=50&Page=50",
_23
"start": 0,
_23
"end": 0,
_23
"page": 0,
_23
"page_size": 50,
_23
"previous_page_uri": "/2010-04-01/Accounts/ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/SIP/CredentialLists.json?PageSize=50&Page=0",
_23
"uri": "/2010-04-01/Accounts/ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/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

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
FriendlyNamestringrequired

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

Update a SIP CredentialList resource

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

_10
// Download the helper library from https://www.twilio.com/docs/node/install
_10
// Find your Account SID and Auth Token at twilio.com/console
_10
// and set the environment variables. See http://twil.io/secure
_10
const accountSid = process.env.TWILIO_ACCOUNT_SID;
_10
const authToken = process.env.TWILIO_AUTH_TOKEN;
_10
const client = require('twilio')(accountSid, authToken);
_10
_10
client.sip.credentialLists('CLXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX')
_10
.update({friendlyName: 'friendly_name'})
_10
.then(credential_list => console.log(credential_list.friendlyName));

Output

_11
{
_11
"account_sid": "ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_11
"date_created": "Wed, 11 Sep 2013 17:51:38 +0000",
_11
"date_updated": "Wed, 11 Sep 2013 17:51:38 +0000",
_11
"friendly_name": "friendly_name",
_11
"sid": "CLXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_11
"subresource_uris": {
_11
"credentials": "/2010-04-01/Accounts/ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/SIP/CredentialLists/CLXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Credentials.json"
_11
},
_11
"uri": "/2010-04-01/Accounts/ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/SIP/CredentialLists/CLXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX.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

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

Delete a SIP CredentialList resource

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

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


Rate this page: