Skip to contentSkip to navigationSkip to topbar
Twilio Docs
On this page

CredentialList Resource

The Credential Lists subresource represents the Credential List instances associated with this Trunk. If an INVITE is received for a domain with a Credential List, Twilio will challenge the request. Your system will need to authenticate with a username and password. The username and password must be in one of the Credential Lists for the INVITE to be accepted.

This API will only allow you to list, add, and remove the Credential Lists associated with your Trunk. To create, remove, or list the Credential Lists in your account, check out the Credential List reference docs.

CredentialList Properties

credentiallist-properties page anchor
Property nameTypeRequiredDescriptionChild properties
accountSidSID<AC>

Optional

Not PII

The SID of the Account that created the CredentialList resource.

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

Optional

Not PII

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

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

Optional

Not PII

The SID of the Trunk the credential list in associated with.

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

Optional

Not PII

The string that you assigned to describe the resource.

dateCreatedstring<date-time>

Optional

Not PII

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

dateUpdatedstring<date-time>

Optional

Not PII

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

urlstring<uri>

Optional

Not PII

The absolute URL of the resource.

Create a CredentialList resource

create-a-credentiallist-resource page anchor

POST https://trunking.twilio.com/v1/Trunks/{TrunkSid}/CredentialLists

Path parameters

path-parameters page anchor
Property nameTypeRequiredPIIDescription
trunkSidSID<TK>
required
Not PII

The SID of the Trunk to associate the credential list with.

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

Request body parameters

request-body-parameters page anchor
Encoding type:application/x-www-form-urlencoded
SchemaExample
Property nameTypeRequiredDescriptionChild properties
credentialListSidSID<CL>
required
Not PII

The SID of the Credential List that you want to associate with the trunk. Once associated, we will authenticate access to the trunk against this list.

Pattern: ^CL[0-9a-fA-F]{32}$Min length: 34Max length: 34
Create Credential ListLink to code sample: Create Credential List
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 createCredentialList() {

11
  const credentialsList = await client.trunking.v1

12
    .trunks("TKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa")

13
    .credentialsLists.create({

14
      credentialListSid: "CLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",

15
    });

16


17
  console.log(credentialsList.accountSid);

18
}

19


20
createCredentialList();

Response

1
{

2
  "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",

3
  "trunk_sid": "TKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",

4
  "date_created": "2018-05-02T17:29:30Z",

5
  "date_updated": "2018-05-02T17:29:30Z",

6
  "friendly_name": "friendly_name",

7
  "sid": "CLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",

8
  "url": "https://trunking.twilio.com/v1/Trunks/TKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/CredentialLists/CLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"

9
}

Read multiple CredentialList resources

read-multiple-credentiallist-resources page anchor

GET https://trunking.twilio.com/v1/Trunks/{TrunkSid}/CredentialLists

Path parameters

path-parameters-1 page anchor
Property nameTypeRequiredPIIDescription
trunkSidSID<TK>
required
Not PII

The SID of the Trunk from which to read the credential lists.

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

Query parameters

query-parameters page anchor
Property nameTypeRequiredPIIDescription
pageSizeinteger<int64>

Optional

Not PII

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

Minimum: 1Maximum: 1000
pageinteger

Optional

Not PII

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

Minimum: 0
pageTokenstring

Optional

Not PII

The page token. This is provided by the API.

Read Credential ListLink to code sample: Read Credential List
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 listCredentialList() {

11
  const credentialsLists = await client.trunking.v1

12
    .trunks("TKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa")

13
    .credentialsLists.list({ limit: 20 });

14


15
  credentialsLists.forEach((c) => console.log(c.accountSid));

16
}

17


18
listCredentialList();

Response

1
{

2
  "credential_lists": [

3
    {

4
      "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",

5
      "trunk_sid": "TKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",

6
      "date_created": "2018-04-27T22:02:11Z",

7
      "date_updated": "2018-04-27T22:02:11Z",

8
      "friendly_name": "friendly_name",

9
      "sid": "CLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",

10
      "url": "https://trunking.twilio.com/v1/Trunks/TKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/CredentialLists/CLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"

11
    }

12
  ],

13
  "meta": {

14
    "page": 0,

15
    "page_size": 50,

16
    "first_page_url": "https://trunking.twilio.com/v1/Trunks/TKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/CredentialLists?PageSize=50&Page=0",

17
    "previous_page_url": null,

18
    "url": "https://trunking.twilio.com/v1/Trunks/TKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/CredentialLists?PageSize=50&Page=0",

19
    "next_page_url": null,

20
    "key": "credential_lists"

21
  }

22
}

Delete a CredentialList resource

delete-a-credentiallist-resource page anchor

DELETE https://trunking.twilio.com/v1/Trunks/{TrunkSid}/CredentialLists/{Sid}

Path parameters

path-parameters-2 page anchor
Property nameTypeRequiredPIIDescription
trunkSidSID<TK>
required
Not PII

The SID of the Trunk from which to delete the credential list.

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

The unique string that we created to identify the CredentialList resource to delete.

Pattern: ^CL[0-9a-fA-F]{32}$Min length: 34Max length: 34
Delete Credential ListLink to code sample: Delete Credential List
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 deleteCredentialList() {

11
  await client.trunking.v1

12
    .trunks("TKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa")

13
    .credentialsLists("CLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa")

14
    .remove();

15
}

16


17
deleteCredentialList();