メニュー

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 Node.js format
sid
sid<CR> Not PII

accountSid
sid<AC> Not PII

friendlyName
文字列 Not PII

保存されているクレデンシャルのフレンドリーネーム。

type
enum:push_service Not PII

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

sandbox
文字列 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
パラメーター
Names in None format
type
必須
post enum:push_service Not PII

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

friendly_name
オプション
post 文字列 Not PII

保存されているクレデンシャルのフレンドリーネーム。

certificate
オプション
post 文字列 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-----

private_key
オプション
post 文字列 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
オプション
post boolean Not PII

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

api_key
オプション
post 文字列 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
オプション
post 文字列 Not PII

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

        
        
        
        

        Fetch a Credential resource

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

              Read multiple Credential resources

              GET
              https://notify.twilio.com/v1/Credentials
                    
                    
                    
                    

                    Update a Credential resource

                    post
                    https://notify.twilio.com/v1/Credentials/{Sid}
                    パラメーター
                    Names in None format
                    friendly_name
                    オプション
                    post 文字列 Not PII

                    保存されているクレデンシャルのフレンドリーネーム。

                    certificate
                    オプション
                    post 文字列 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-----

                    private_key
                    オプション
                    post 文字列 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
                    オプション
                    post boolean Not PII

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

                    api_key
                    オプション
                    post 文字列 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
                    オプション
                    post 文字列 Not PII

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

                          
                          
                          
                          

                          Delete a Credential resource

                          削除する
                          https://notify.twilio.com/v1/Credentials/{Sid}
                                
                                
                                
                                
                                Rate this page:

                                ヘルプが必要ですか?

                                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.