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

Notify API Credential Resource

The Credential resource stores the credentials to use with a notification Binding. Credentials can be stored for APNS and FCM binding types.

Credential properties are specific to the binding type and provided by the vendor that supports it. Learn more about vendor-specific credentials at:

Credential Properties

credential-properties page anchor
Property nameTypeRequiredDescriptionChild properties
sidSID<CR>

Optional

Not PII

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

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

Optional

Not PII

The SID of the Account that created the Credential resource.

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

Optional

Not PII

The string that you assigned to describe the resource.

typeenum<string>

Optional

Not PII

The Credential type. Can be: gcm, fcm, or apn.

Possible values:
gcmapnfcm
sandboxstring

Optional

Not PII

[APN only] Whether to send the credential to sandbox APNs. Can be true to send to sandbox APNs or false to send to production.

date_createdstring<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.

date_updatedstring<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 Credential resource.

Create a Credential resource

create-a-credential-resource page anchor
POST https://notify.twilio.com/v1/Credentials

Request body parameters

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

The Credential type. Can be: gcm, fcm, or apn.

Possible values:
gcmapnfcm
FriendlyNamestring

Optional

Not PII

A descriptive string that you create to describe the resource. It can be up to 64 characters long.

Certificatestring

Optional

Not PII

[APN only] The URL-encoded representation of the certificate. Strip everything outside of the headers, e.g. -----BEGIN CERTIFICATE-----MIIFnTCCBIWgAwIBAgIIAjy9H849+E8wDQYJKoZIhvcNAQEFBQAwgZYxCzAJBgNV.....A==-----END CERTIFICATE-----

PrivateKeystring

Optional

Not PII

[APN only] The URL-encoded representation of the private key. Strip everything outside of the headers, e.g. -----BEGIN RSA PRIVATE KEY-----MIIEpQIBAAKCAQEAuyf/lNrH9ck8DmNyo3fGgvCI1l9s+cmBY3WIz+cUDqmxiieR\n.-----END RSA PRIVATE KEY-----

Sandboxboolean

Optional

Not PII

[APN only] Whether to send the credential to sandbox APNs. Can be true to send to sandbox APNs or false to send to production.

ApiKeystring

Optional

Not PII

[GCM only] The Server key of your project from Firebase console under Settings / Cloud messaging.

Secretstring

Optional

Not PII

[FCM only] The Server key of your project from Firebase console under Settings / Cloud messaging.

Create a Credential resourceLink to code sample: Create a Credential 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 createCredential() {

11
  const credential = await client.notify.v1.credentials.create({ type: "gcm" });

12


13
  console.log(credential.sid);

14
}

15


16
createCredential();

Output

1
{

2
  "sid": "CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",

3
  "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",

4
  "friendly_name": "Test slow create",

5
  "type": "gcm",

6
  "sandbox": "False",

7
  "date_created": "2015-10-07T17:50:01Z",

8
  "date_updated": "2015-10-07T17:50:01Z",

9
  "url": "https://notify.twilio.com/v1/Credentials/CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"

10
}

Fetch a Credential resource

fetch-a-credential-resource page anchor
GET https://notify.twilio.com/v1/Credentials/{Sid}

Path parameters

path-parameters page anchor
Property nameTypeRequiredPIIDescription
SidSID<CR>required
Not PII

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

Pattern: ^CR[0-9a-fA-F]{32}$Min length: 34Max length: 34
Fetch a Credential resourceLink to code sample: Fetch a Credential 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 fetchCredential() {

11
  const credential = await client.notify.v1

12
    .credentials("CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa")

13
    .fetch();

14


15
  console.log(credential.sid);

16
}

17


18
fetchCredential();

Output

1
{

2
  "sid": "CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",

3
  "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",

4
  "friendly_name": "Test slow create",

5
  "type": "apn",

6
  "sandbox": "False",

7
  "date_created": "2015-10-07T17:50:01Z",

8
  "date_updated": "2015-10-07T17:50:01Z",

9
  "url": "https://notify.twilio.com/v1/Credentials/CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"

10
}

Read multiple Credential resources

read-multiple-credential-resources page anchor
GET https://notify.twilio.com/v1/Credentials

Query parameters

query-parameters page anchor
Property nameTypeRequiredPIIDescription
PageSizeinteger

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 multiple Credential resourcesLink to code sample: Read multiple Credential 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 listCredential() {

11
  const credentials = await client.notify.v1.credentials.list({ limit: 20 });

12


13
  credentials.forEach((c) => console.log(c.sid));

14
}

15


16
listCredential();

Output

1
{

2
  "credentials": [

3
    {

4
      "sid": "CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",

5
      "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",

6
      "friendly_name": "Test slow create",

7
      "type": "apn",

8
      "sandbox": "False",

9
      "date_created": "2015-10-07T17:50:01Z",

10
      "date_updated": "2015-10-07T17:50:01Z",

11
      "url": "https://notify.twilio.com/v1/Credentials/CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"

12
    }

13
  ],

14
  "meta": {

15
    "page": 0,

16
    "page_size": 50,

17
    "first_page_url": "https://notify.twilio.com/v1/Credentials?PageSize=50&Page=0",

18
    "previous_page_url": null,

19
    "url": "https://notify.twilio.com/v1/Credentials?PageSize=50&Page=0",

20
    "next_page_url": null,

21
    "key": "credentials"

22
  }

23
}

Update a Credential resource

update-a-credential-resource page anchor
POST https://notify.twilio.com/v1/Credentials/{Sid}

Path parameters

path-parameters-1 page anchor
Property nameTypeRequiredPIIDescription
SidSID<CR>required
Not PII

The Twilio-provided string that uniquely identifies the Credential resource to update.

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

Request body parameters

request-body-parameters-1 page anchor
Encoding type:application/x-www-form-urlencoded
SchemaExample
Property nameTypeRequiredDescriptionChild properties
FriendlyNamestring

Optional

Not PII

A descriptive string that you create to describe the resource. It can be up to 64 characters long.

Certificatestring

Optional

Not PII

[APN only] The URL-encoded representation of the certificate. Strip everything outside of the headers, e.g. -----BEGIN CERTIFICATE-----MIIFnTCCBIWgAwIBAgIIAjy9H849+E8wDQYJKoZIhvcNAQEFBQAwgZYxCzAJBgNV.....A==-----END CERTIFICATE-----

PrivateKeystring

Optional

Not PII

[APN only] The URL-encoded representation of the private key. Strip everything outside of the headers, e.g. -----BEGIN RSA PRIVATE KEY-----MIIEpQIBAAKCAQEAuyf/lNrH9ck8DmNyo3fGgvCI1l9s+cmBY3WIz+cUDqmxiieR\n.-----END RSA PRIVATE KEY-----

Sandboxboolean

Optional

Not PII

[APN only] Whether to send the credential to sandbox APNs. Can be true to send to sandbox APNs or false to send to production.

ApiKeystring

Optional

Not PII

[GCM only] The Server key of your project from Firebase console under Settings / Cloud messaging.

Secretstring

Optional

Not PII

[FCM only] The Server key of your project from Firebase console under Settings / Cloud messaging.

Update a Credential resourceLink to code sample: Update a Credential 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 updateCredential() {

11
  const credential = await client.notify.v1

12
    .credentials("CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa")

13
    .update({ friendlyName: "FriendlyName" });

14


15
  console.log(credential.sid);

16
}

17


18
updateCredential();

Output

1
{

2
  "sid": "CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",

3
  "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",

4
  "friendly_name": "FriendlyName",

5
  "type": "apn",

6
  "sandbox": "False",

7
  "date_created": "2015-10-07T17:50:01Z",

8
  "date_updated": "2015-10-07T17:50:01Z",

9
  "url": "https://notify.twilio.com/v1/Credentials/CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"

10
}

Delete a Credential resource

delete-a-credential-resource page anchor
DELETE https://notify.twilio.com/v1/Credentials/{Sid}

Path parameters

path-parameters-2 page anchor
Property nameTypeRequiredPIIDescription
SidSID<CR>required
Not PII

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

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

11
  await client.notify.v1

12
    .credentials("CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa")

13
    .remove();

14
}

15


16
deleteCredential();

Need some help?

Terms of service
Privacy Policy

Copyright © 2024 Twilio Inc.