Menu

Rate this page:

Thanks for rating this page!

We are always striving to improve our documentation quality, and your feedback is valuable to us. How could this documentation serve you better?

Credential Resource

The Credential resource stores the credentials to use with a notification Binding. Credentials can be stored for APNS, FCM, and GCM 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

Names in PHP format
sid
sid<CR> Not PII

accountSid
sid<AC> Not PII

friendlyName
string Not PII

Friendly name for stored credential

type
enum:push_service Not PII

Credential type, one of "gcm", "fcm", or "apn"

sandbox
string Not PII

[APN only] use this credential for sending to production or sandbox APNs (string true or false)

dateCreated
date_time<iso8601> Not PII

dateUpdated
date_time<iso8601> Not PII

url
url Not PII

Create a Credential resource

post
https://notify.twilio.com/v1/Credentials
Parameters
Names in PHP format
type
Required
post enum:push_service Not PII

Credential type, one of "gcm", "fcm", or "apn"

friendlyName
Optional
post string Not PII

Friendly name for stored credential

certificate
Optional
post string Not PII

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

privateKey
Optional
post string Not PII

[APN only] 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-----

sandbox
Optional
post boolean Not PII

[APN only] use this credential for sending to production or sandbox APNs (string true or false)

apiKey
Optional
post string Not PII

[GCM only] This is the "Server key" of your project from Firebase console under Settings / Cloud messaging. Yes, you can use the server key from the Firebase console for GCM.

secret
Optional
post string Not PII

[FCM only] This is the "Server key" of your project from Firebase console under Settings / Cloud messaging.

Example
        
        
        
        

        Fetch a Credential resource

        get
        https://notify.twilio.com/v1/Credentials/{Sid}
        Example
              
              
              
              

              Read multiple Credential resources

              get
              https://notify.twilio.com/v1/Credentials
              Example
                    
                    
                    
                    

                    Update a Credential resource

                    post
                    https://notify.twilio.com/v1/Credentials/{Sid}
                    Parameters
                    Names in PHP format
                    friendlyName
                    Optional
                    post string Not PII

                    Friendly name for stored credential

                    certificate
                    Optional
                    post string Not PII

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

                    privateKey
                    Optional
                    post string Not PII

                    [APN only] 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-----

                    sandbox
                    Optional
                    post boolean Not PII

                    [APN only] use this credential for sending to production or sandbox APNs (string true or false)

                    apiKey
                    Optional
                    post string Not PII

                    [GCM only] This is the "Server key" of your project from Firebase console under Settings / Cloud messaging. Yes, you can use the server key from the Firebase console for GCM.

                    secret
                    Optional
                    post string Not PII

                    [FCM only] This is the "Server key" of your project from Firebase console under Settings / Cloud messaging.

                    Example
                          
                          
                          
                          

                          Delete a Credential resource

                          delete
                          https://notify.twilio.com/v1/Credentials/{Sid}
                          Example
                                
                                
                                
                                

                                Need some help?

                                We all do sometimes; code is hard. Get help now from our support team, or lean on the wisdom of the crowd browsing the Twilio tag on Stack Overflow.