Menu

Expand
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

A Credential resource represents one credential record for a specific push notifications channel. We support the APNS, FCM, and GCM push notification channels. Each push notification channel vendor issues its own Credentials and they can vary between vendors. This resource allows you to save the Credentials that should be used for push notifications to a specific channel.

You can learn more about provisioning vendor-specific credentials in these topics.

Twilio Console

You can also manage the Credentials for Programmable Chat in your Twilio console when you are logged in.

Credential properties

Each Credential resource contains these properties.

Names in REST API format
sid
sid<CR> Not PII

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

account_sid
sid<AC> Not PII

The SID of the Account that created the Credential resource.

friendly_name

The string that you assigned to describe the resource.

type
enum:push_service Not PII

The type of push-notification service the credential is for. Can be: gcm, fcm, or apn.

sandbox
string 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_created
date_time<iso8601> Not PII

The date and time in GMT when the resource was created specified in ISO 8601 format.

date_updated
date_time<iso8601> Not PII

The date and time in GMT when the resource was last updated specified in ISO 8601 format.

url
url Not PII

The absolute URL of the Credential resource.

Create a Credential resource

post
https://chat.twilio.com/v2/Credentials
Parameters
Names in REST API format
type
Required
post enum:push_service Not PII

The type of push-notification service the credential is for. Can be: gcm, fcm, or apn.

friendly_name
Optional
post string PII MTL: 120 DAYS

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

certificate
Optional
post string Not PII

[APN only] The URL encoded representation of the certificate. For example, -----BEGIN CERTIFICATE----- MIIFnTCCBIWgAwIBAgIIAjy9H849+E8wDQYJKoZIhvcNAQEF.....A== -----END CERTIFICATE-----

private_key
Optional
post string Not PII

[APN only] The URL encoded representation of the private key. For example, -----BEGIN RSA PRIVATE KEY----- MIIEpQIBAAKCAQEAuyf/lNrH9ck8DmNyo3fG... -----END RSA PRIVATE KEY-----

sandbox
Optional
post boolean 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.

api_key
Optional
post string Not PII

[GCM only] The API key for the project that was obtained from the Google Developer console for your GCM Service application credential.

secret
Optional
post string Not PII

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

Example 1
        
        
        
        

        Fetch a Credential resource

        get
        https://chat.twilio.com/v2/Credentials/{Sid}
        Parameters
        Names in REST API format
        sid
        Path
        get sid<CR> Not PII

        The SID of the Credential resource to fetch.

        Example 1
              
              
              
              

              Read multiple Credential resources

              get
              https://chat.twilio.com/v2/Credentials
              Example 1
                    
                    
                    
                    

                    Update a Credential resource

                    post
                    https://chat.twilio.com/v2/Credentials/{Sid}
                    Parameters
                    Names in REST API format
                    sid
                    Path
                    post sid<CR> Not PII

                    The SID of the Credential resource to update.

                    friendly_name
                    Optional
                    post string PII MTL: 120 DAYS

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

                    certificate
                    Optional
                    post string Not PII

                    [APN only] The URL encoded representation of the certificate. For example, -----BEGIN CERTIFICATE----- MIIFnTCCBIWgAwIBAgIIAjy9H849+E8wDQYJKoZIhvcNAQEF.....A== -----END CERTIFICATE-----

                    private_key
                    Optional
                    post string Not PII

                    [APN only] The URL encoded representation of the private key. For example, -----BEGIN RSA PRIVATE KEY----- MIIEpQIBAAKCAQEAuyf/lNrH9ck8DmNyo3fG... -----END RSA PRIVATE KEY-----

                    sandbox
                    Optional
                    post boolean 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.

                    api_key
                    Optional
                    post string Not PII

                    [GCM only] The API key for the project that was obtained from the Google Developer console for your GCM Service application credential.

                    secret
                    Optional
                    post string Not PII

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

                    Example 1
                          
                          
                          
                          

                          Delete a Credential resource

                          delete
                          https://chat.twilio.com/v2/Credentials/{Sid}
                          Parameters
                          Names in REST API format
                          sid
                          Path
                          delete sid<CR> Not PII

                          The SID of the Credential resource to delete.

                          Example 1
                                
                                
                                
                                
                                Rate this page:

                                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.