# Credentials resource
> \[!IMPORTANT]
>
> The Push Notifications API is currently available as a
> Private Beta product. The information contained in this document is subject to change. You acknowledge
> and agree that your use of the Twilio Push Notifications API is subject to the terms of the [Services in
> Private Beta](https://www.twilio.com/en-us/legal/service-country-specific-terms/private-beta). This
> means that some features are not yet implemented and others may be changed before the product is
> declared as Generally Available. Private Beta products are not covered by the Twilio Support Terms or
> Twilio Service Level Agreement.
A Credential resource represents the authentication credentials required to send push notifications through a specific platform. Twilio supports two credential types:
* **FCM**: Google Firebase Cloud Messaging credentials for Android devices and all web browsers (including Safari).
* **APN**: Apple Push Notification service credentials for iOS devices.
After you upload a Credential, it is associated with an [App](/docs/push-notifications/api/app-resource). If you don't specify an App, the Credential is associated with your default App.
> \[!NOTE]
>
> You can create a maximum of 10 Apps per account and 10 Credentials per App.
## Credential Properties
## Credential types
| `credentialType` | Description |
| ---------------- | --------------------------------------------------------------------------------------------------------------------- |
| `FCM` | Firebase Cloud Messaging. Requires a base64-encoded `privateKey` (Google Cloud private key JSON object) in `content`. |
| `APN` | Apple Push Notification service. Requires a base64-encoded `certificate` and `privateKey` in `content`. |
## Create a Credential
`POST https://comms.twilio.com/v1/PushNotifications/Credentials`
Upload new push notification credentials by making an HTTP `POST` request to the Credentials resource URI.
When creating a Credential, specify an `appName`. If the [App](/docs/push-notifications/api/app-resource) doesn't exist, the API creates it. If no other Apps exist, the API sets the created App as the default.
> \[!NOTE]
>
> The `certificate` and `privateKey` values in the `content` object must be base64-encoded. See [Obtain FCM credentials](/docs/push-notifications/fcm-credentials) or [Obtain APNs credentials](/docs/push-notifications/apn-credentials) for encoding instructions.
### Request body parameters
```json
{"schema":{"title":"CreatePushCredentialRequest","type":"object","required":["credentialType","content","appName"],"properties":{"credentialType":{"x-twilio-version":1,"title":"PushCredentialType","description":"The credential types available for PushNotifications.","type":"string","enum":["APN","APN_SANDBOX","FCM"],"refName":"PushCredentialType","modelName":"PushCredentialType"},"content":{"x-twilio-version":1,"title":"PushCredentialContent","description":"Credential properties are specific to the channel type and provided by the vendor that supports it.","oneOf":[{"x-twilio-version":1,"title":"ApnCertificatePushCredential","description":"Certificate-based credentials are used to authenticate with the APN service before sending a Notification. It can be acquired from the Apple Developer Portal. Note that certificates have an expiration date and need to be renewed before they expire. Alternatively, you can use APN Signing Key credentials.","type":"object","properties":{"certificate":{"type":"string","format":"byte","description":"The base64 representation of the certificate. Strip everything outside of the headers, e.g. `-----BEGIN CERTIFICATE-----MIIFnTCCBIWgAwIBAgIIAjy9H849+E8wDQYJKoZIhvcNAQEFBQAwgZYxCzAJBgNV.....A==-----END CERTIFICATE-----` and encode with base64 encoding."},"privateKey":{"type":"string","format":"byte","description":"The base64 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-----` and encode with base64 encoding."}},"required":["privateKey","certificate"],"refName":"ApnCertificatePushCredential","modelName":"ApnCertificatePushCredential"},{"x-twilio-version":1,"title":"FcmPushCredential","description":"FCM credentials are used to authenticate with the Firebase Cloud Messaging service before sending a Notification. COMMS API uses this private key to authenticate with the FCM service before sending a Notification.","type":"object","properties":{"privateKey":{"type":"string","format":"byte","description":"The `privateKey` field is a JSON object that contains the Google Cloud private key, generated with minimal privileges, specifically for Cloud Messaging on the Google Cloud Platform. It is recommended to follow the principle of least privilege when generating this key to ensure security and limit potential misuse. The Google Cloud private key is in a JSON format and must be encoded with base64 before sending."}},"required":["privateKey"],"additionalProperties":false,"refName":"FcmPushCredential","modelName":"FcmPushCredential"}],"refName":"PushCredentialContent","modelName":"PushCredentialContent"},"isDefault":{"x-twilio-version":1,"title":"AccountPushCredentialFlag","description":"Use this Credential as the default for the Push Notification `App` for the\n given `credentialType` to send Push Notifications. \nIf a Credential of the given type doesn't already exist, \n this Credential automatically becomes the default.","type":"boolean","default":false,"refName":"AccountPushCredentialFlag","modelName":""},"appName":{"description":"The name of the `App` that this Credential will be associated with.\n\nTwilio will automatically create a new Push Notification `App` on your behalf\nwhen you create a Credential with a new `appName`.\n\nThe first `App` created will automatically be assigned as the default App.","x-twilio-version":1,"title":"PushNotificationAppName","type":"string","pattern":"^[a-z0-9_]+$","minLength":1,"maxLength":64,"refName":"PushNotificationAppName","modelName":""}}},"examples":{"CreateANewApnCertificateCredential":{"x-twilio-version":1,"summary":"Create a new APN Certificate Credential","value":{"lang":"json","value":"{\n \"credentialType\": \"APN\",\n \"appName\": \"limonade_app\",\n \"content\": {\n \"certificate\": \"LS0tLS1CRUdJTiBDRVJUSUZJQ0FURS0tLS0tTUlJRm5UQ0NCSVdnQXdJQkFnSUlBank5SDg0OStFOHdEUVlKS29aSWh2Y05BUUVGQlFBd2daWXhDekFKQmdOVi4uLi4uQT09LS0tLS1FTkQgQ0VSVElGSUNBVEUtLS0tLQ==\",\n \"privateKey\": \"LS0tLS1CRUdJTiBSU0EgUFJJVkFURSBLRVktLS0tLU1JSUVwUUlCQUFLQ0FRRUF1eWYvbE5ySDljazhEbU55bzNmR2d2Q0kxbDlzK2NtQlkzV0l6K2NVRHFteGlpZVIKLi0tLS0tRU5EIFJTQSBQUklWQVRFIEtFWS0tLS0t\"\n }\n}","meta":"","code":"{\n \"credentialType\": \"APN\",\n \"appName\": \"limonade_app\",\n \"content\": {\n \"certificate\": \"LS0tLS1CRUdJTiBDRVJUSUZJQ0FURS0tLS0tTUlJRm5UQ0NCSVdnQXdJQkFnSUlBank5SDg0OStFOHdEUVlKS29aSWh2Y05BUUVGQlFBd2daWXhDekFKQmdOVi4uLi4uQT09LS0tLS1FTkQgQ0VSVElGSUNBVEUtLS0tLQ==\",\n \"privateKey\": \"LS0tLS1CRUdJTiBSU0EgUFJJVkFURSBLRVktLS0tLU1JSUVwUUlCQUFLQ0FRRUF1eWYvbE5ySDljazhEbU55bzNmR2d2Q0kxbDlzK2NtQlkzV0l6K2NVRHFteGlpZVIKLi0tLS0tRU5EIFJTQSBQUklWQVRFIEtFWS0tLS0t\"\n }\n}","tokens":[["{","#C9D1D9"],"\n ",["\"credentialType\"","#7EE787"],[":","#C9D1D9"]," ",["\"APN\"","#A5D6FF"],[",","#C9D1D9"],"\n ",["\"appName\"","#7EE787"],[":","#C9D1D9"]," ",["\"limonade_app\"","#A5D6FF"],[",","#C9D1D9"],"\n ",["\"content\"","#7EE787"],[": {","#C9D1D9"],"\n ",["\"certificate\"","#7EE787"],[":","#C9D1D9"]," ",["\"LS0tLS1CRUdJTiBDRVJUSUZJQ0FURS0tLS0tTUlJRm5UQ0NCSVdnQXdJQkFnSUlBank5SDg0OStFOHdEUVlKS29aSWh2Y05BUUVGQlFBd2daWXhDekFKQmdOVi4uLi4uQT09LS0tLS1FTkQgQ0VSVElGSUNBVEUtLS0tLQ==\"","#A5D6FF"],[",","#C9D1D9"],"\n ",["\"privateKey\"","#7EE787"],[":","#C9D1D9"]," ",["\"LS0tLS1CRUdJTiBSU0EgUFJJVkFURSBLRVktLS0tLU1JSUVwUUlCQUFLQ0FRRUF1eWYvbE5ySDljazhEbU55bzNmR2d2Q0kxbDlzK2NtQlkzV0l6K2NVRHFteGlpZVIKLi0tLS0tRU5EIFJTQSBQUklWQVRFIEtFWS0tLS0t\"","#A5D6FF"],"\n ",["}","#C9D1D9"],"\n",["}","#C9D1D9"]],"annotations":[],"themeName":"github-dark","style":{"color":"#c9d1d9","background":"#0d1117"}}},"CreateANewApnCertificateCredentialForSandbox":{"x-twilio-version":1,"summary":"Create a new APN Certificate Credential for Sandbox","value":{"lang":"json","value":"{\n \"credentialType\": \"APN_SANDBOX\",\n \"appName\": \"limonade_app\",\n \"content\": {\n \"certificate\": \"LS0tLS1CRUdJTiBDRVJUSUZJQ0FURS0tLS0tTUlJRm5UQ0NCSVdnQXdJQkFnSUlBank5SDg0OStFOHdEUVlKS29aSWh2Y05BUUVGQlFBd2daWXhDekFKQmdOVi4uLi4uQT09LS0tLS1FTkQgQ0VSVElGSUNBVEUtLS0tLQ==\",\n \"privateKey\": \"LS0tLS1CRUdJTiBSU0EgUFJJVkFURSBLRVktLS0tLU1JSUVwUUlCQUFLQ0FRRUF1eWYvbE5ySDljazhEbU55bzNmR2d2Q0kxbDlzK2NtQlkzV0l6K2NVRHFteGlpZVIKLi0tLS0tRU5EIFJTQSBQUklWQVRFIEtFWS0tLS0t\"\n }\n}","meta":"","code":"{\n \"credentialType\": \"APN_SANDBOX\",\n \"appName\": \"limonade_app\",\n \"content\": {\n \"certificate\": \"LS0tLS1CRUdJTiBDRVJUSUZJQ0FURS0tLS0tTUlJRm5UQ0NCSVdnQXdJQkFnSUlBank5SDg0OStFOHdEUVlKS29aSWh2Y05BUUVGQlFBd2daWXhDekFKQmdOVi4uLi4uQT09LS0tLS1FTkQgQ0VSVElGSUNBVEUtLS0tLQ==\",\n \"privateKey\": \"LS0tLS1CRUdJTiBSU0EgUFJJVkFURSBLRVktLS0tLU1JSUVwUUlCQUFLQ0FRRUF1eWYvbE5ySDljazhEbU55bzNmR2d2Q0kxbDlzK2NtQlkzV0l6K2NVRHFteGlpZVIKLi0tLS0tRU5EIFJTQSBQUklWQVRFIEtFWS0tLS0t\"\n }\n}","tokens":[["{","#C9D1D9"],"\n ",["\"credentialType\"","#7EE787"],[":","#C9D1D9"]," ",["\"APN_SANDBOX\"","#A5D6FF"],[",","#C9D1D9"],"\n ",["\"appName\"","#7EE787"],[":","#C9D1D9"]," ",["\"limonade_app\"","#A5D6FF"],[",","#C9D1D9"],"\n ",["\"content\"","#7EE787"],[": {","#C9D1D9"],"\n ",["\"certificate\"","#7EE787"],[":","#C9D1D9"]," ",["\"LS0tLS1CRUdJTiBDRVJUSUZJQ0FURS0tLS0tTUlJRm5UQ0NCSVdnQXdJQkFnSUlBank5SDg0OStFOHdEUVlKS29aSWh2Y05BUUVGQlFBd2daWXhDekFKQmdOVi4uLi4uQT09LS0tLS1FTkQgQ0VSVElGSUNBVEUtLS0tLQ==\"","#A5D6FF"],[",","#C9D1D9"],"\n ",["\"privateKey\"","#7EE787"],[":","#C9D1D9"]," ",["\"LS0tLS1CRUdJTiBSU0EgUFJJVkFURSBLRVktLS0tLU1JSUVwUUlCQUFLQ0FRRUF1eWYvbE5ySDljazhEbU55bzNmR2d2Q0kxbDlzK2NtQlkzV0l6K2NVRHFteGlpZVIKLi0tLS0tRU5EIFJTQSBQUklWQVRFIEtFWS0tLS0t\"","#A5D6FF"],"\n ",["}","#C9D1D9"],"\n",["}","#C9D1D9"]],"annotations":[],"themeName":"github-dark","style":{"color":"#c9d1d9","background":"#0d1117"}}},"CreateANewFcmCredential":{"x-twilio-version":1,"summary":"Create a new FCM Credential","value":{"lang":"json","value":"{\n \"credentialType\": \"FCM\",\n \"appName\": \"limonade_app\",\n \"content\": {\n \"privateKey\": \"eyJ0eXBlIjoic2VydmljZV9hY2NvdW50IiwicHJvamVjdF9pZCI6Im15LXByb2plY3QiLCJwcml2YXRlX2tleV9pZCI6Im15LXByaXZhdGUta2V5LWlkIiwicHJpdmF0ZV9rZXkiOiItLS0tLUJFR0lOIFBSSVZBVEUgS0VZLS0tLS1cbiBleGFtcGxlIHByaXZhdGUga2V5IFxuLS0tLS1FTkQgUFJJVkFURSBLRVktLS0tLVxuIn0=\"\n }\n}","meta":"","code":"{\n \"credentialType\": \"FCM\",\n \"appName\": \"limonade_app\",\n \"content\": {\n \"privateKey\": \"eyJ0eXBlIjoic2VydmljZV9hY2NvdW50IiwicHJvamVjdF9pZCI6Im15LXByb2plY3QiLCJwcml2YXRlX2tleV9pZCI6Im15LXByaXZhdGUta2V5LWlkIiwicHJpdmF0ZV9rZXkiOiItLS0tLUJFR0lOIFBSSVZBVEUgS0VZLS0tLS1cbiBleGFtcGxlIHByaXZhdGUga2V5IFxuLS0tLS1FTkQgUFJJVkFURSBLRVktLS0tLVxuIn0=\"\n }\n}","tokens":[["{","#C9D1D9"],"\n ",["\"credentialType\"","#7EE787"],[":","#C9D1D9"]," ",["\"FCM\"","#A5D6FF"],[",","#C9D1D9"],"\n ",["\"appName\"","#7EE787"],[":","#C9D1D9"]," ",["\"limonade_app\"","#A5D6FF"],[",","#C9D1D9"],"\n ",["\"content\"","#7EE787"],[": {","#C9D1D9"],"\n ",["\"privateKey\"","#7EE787"],[":","#C9D1D9"]," ",["\"eyJ0eXBlIjoic2VydmljZV9hY2NvdW50IiwicHJvamVjdF9pZCI6Im15LXByb2plY3QiLCJwcml2YXRlX2tleV9pZCI6Im15LXByaXZhdGUta2V5LWlkIiwicHJpdmF0ZV9rZXkiOiItLS0tLUJFR0lOIFBSSVZBVEUgS0VZLS0tLS1cbiBleGFtcGxlIHByaXZhdGUga2V5IFxuLS0tLS1FTkQgUFJJVkFURSBLRVktLS0tLVxuIn0=\"","#A5D6FF"],"\n ",["}","#C9D1D9"],"\n",["}","#C9D1D9"]],"annotations":[],"themeName":"github-dark","style":{"color":"#c9d1d9","background":"#0d1117"}}},"CreateANewDefaultCredential":{"x-twilio-version":1,"summary":"Create a new Default Credential","value":{"lang":"json","value":"{\n \"credentialType\": \"APN\",\n \"appName\": \"limonade_app\",\n \"content\": {\n \"certificate\": \"LS0tLS1CRUdJTiBDRVJUSUZJQ0FURS0tLS0tTUlJRm5UQ0NCSVdnQXdJQkFnSUlBank5SDg0OStFOHdEUVlKS29aSWh2Y05BUUVGQlFBd2daWXhDekFKQmdOVi4uLi4uQT09LS0tLS1FTkQgQ0VSVElGSUNBVEUtLS0tLQ==\",\n \"privateKey\": \"LS0tLS1CRUdJTiBSU0EgUFJJVkFURSBLRVktLS0tLU1JSUVwUUlCQUFLQ0FRRUF1eWYvbE5ySDljazhEbU55bzNmR2d2Q0kxbDlzK2NtQlkzV0l6K2NVRHFteGlpZVIKLi0tLS0tRU5EIFJTQSBQUklWQVRFIEtFWS0tLS0t\"\n },\n \"isDefault\": true\n}","meta":"","code":"{\n \"credentialType\": \"APN\",\n \"appName\": \"limonade_app\",\n \"content\": {\n \"certificate\": \"LS0tLS1CRUdJTiBDRVJUSUZJQ0FURS0tLS0tTUlJRm5UQ0NCSVdnQXdJQkFnSUlBank5SDg0OStFOHdEUVlKS29aSWh2Y05BUUVGQlFBd2daWXhDekFKQmdOVi4uLi4uQT09LS0tLS1FTkQgQ0VSVElGSUNBVEUtLS0tLQ==\",\n \"privateKey\": \"LS0tLS1CRUdJTiBSU0EgUFJJVkFURSBLRVktLS0tLU1JSUVwUUlCQUFLQ0FRRUF1eWYvbE5ySDljazhEbU55bzNmR2d2Q0kxbDlzK2NtQlkzV0l6K2NVRHFteGlpZVIKLi0tLS0tRU5EIFJTQSBQUklWQVRFIEtFWS0tLS0t\"\n },\n \"isDefault\": true\n}","tokens":[["{","#C9D1D9"],"\n ",["\"credentialType\"","#7EE787"],[":","#C9D1D9"]," ",["\"APN\"","#A5D6FF"],[",","#C9D1D9"],"\n ",["\"appName\"","#7EE787"],[":","#C9D1D9"]," ",["\"limonade_app\"","#A5D6FF"],[",","#C9D1D9"],"\n ",["\"content\"","#7EE787"],[": {","#C9D1D9"],"\n ",["\"certificate\"","#7EE787"],[":","#C9D1D9"]," ",["\"LS0tLS1CRUdJTiBDRVJUSUZJQ0FURS0tLS0tTUlJRm5UQ0NCSVdnQXdJQkFnSUlBank5SDg0OStFOHdEUVlKS29aSWh2Y05BUUVGQlFBd2daWXhDekFKQmdOVi4uLi4uQT09LS0tLS1FTkQgQ0VSVElGSUNBVEUtLS0tLQ==\"","#A5D6FF"],[",","#C9D1D9"],"\n ",["\"privateKey\"","#7EE787"],[":","#C9D1D9"]," ",["\"LS0tLS1CRUdJTiBSU0EgUFJJVkFURSBLRVktLS0tLU1JSUVwUUlCQUFLQ0FRRUF1eWYvbE5ySDljazhEbU55bzNmR2d2Q0kxbDlzK2NtQlkzV0l6K2NVRHFteGlpZVIKLi0tLS0tRU5EIFJTQSBQUklWQVRFIEtFWS0tLS0t\"","#A5D6FF"],"\n ",["},","#C9D1D9"],"\n ",["\"isDefault\"","#7EE787"],[":","#C9D1D9"]," ",["true","#79C0FF"],"\n",["}","#C9D1D9"]],"annotations":[],"themeName":"github-dark","style":{"color":"#c9d1d9","background":"#0d1117"}}}},"encodingType":"application/json","conditionalParameterMap":{}}
```
### Responses
Create a Push Credential
```ts
import { TwilioClient } from "twilio-comms";
async function main() {
const client = new TwilioClient({
accountId: "",
authToken: "",
});
await client.pushNotifications.credentials.create({
credentialType: "APN",
content: {
certificate: "LS0tLS1CRUdJTiBDRVJUSUZJQ0FURS0tLS0tTUlJRm5UQ0NCSVdnQXdJQkFnSUlBank5SDg0OStFOHdEUVlKS29aSWh2Y05BUUVGQlFBd2daWXhDekFKQmdOVi4uLi4uQT09LS0tLS1FTkQgQ0VSVElGSUNBVEUtLS0tLQ==",
privateKey: "LS0tLS1CRUdJTiBSU0EgUFJJVkFURSBLRVktLS0tLU1JSUVwUUlCQUFLQ0FRRUF1eWYvbE5ySDljazhEbU55bzNmR2d2Q0kxbDlzK2NtQlkzV0l6K2NVRHFteGlpZVIKLi0tLS0tRU5EIFJTQSBQUklWQVRFIEtFWS0tLS0t",
},
appName: "limonade_app",
});
}
main();
```
```py
from twilio import TwilioComms, ApnCertificatePushCredential
client = TwilioComms(
account_id="",
auth_token="",
)
client.push_notifications.credentials.create(
credential_type="APN",
content=ApnCertificatePushCredential(
certificate="LS0tLS1CRUdJTiBDRVJUSUZJQ0FURS0tLS0tTUlJRm5UQ0NCSVdnQXdJQkFnSUlBank5SDg0OStFOHdEUVlKS29aSWh2Y05BUUVGQlFBd2daWXhDekFKQmdOVi4uLi4uQT09LS0tLS1FTkQgQ0VSVElGSUNBVEUtLS0tLQ==",
private_key="LS0tLS1CRUdJTiBSU0EgUFJJVkFURSBLRVktLS0tLU1JSUVwUUlCQUFLQ0FRRUF1eWYvbE5ySDljazhEbU55bzNmR2d2Q0kxbDlzK2NtQlkzV0l6K2NVRHFteGlpZVIKLi0tLS0tRU5EIFJTQSBQUklWQVRFIEtFWS0tLS0t",
),
app_name="limonade_app",
)
```
```cs
using TwilioComms;
using System.Threading.Tasks;
using TwilioComms.PushNotifications;
public partial class Examples
{
public async Task Example() {
var client = new TwilioCommsClient(
accountId: "",
authToken: ""
);
await client.PushNotifications.Credentials.CreateAsync(
new CredentialsCreateRequest {
CredentialType = PushCredentialType.Apn,
Content = new ApnCertificatePushCredential {
Certificate = "LS0tLS1CRUdJTiBDRVJUSUZJQ0FURS0tLS0tTUlJRm5UQ0NCSVdnQXdJQkFnSUlBank5SDg0OStFOHdEUVlKS29aSWh2Y05BUUVGQlFBd2daWXhDekFKQmdOVi4uLi4uQT09LS0tLS1FTkQgQ0VSVElGSUNBVEUtLS0tLQ==",
PrivateKey = "LS0tLS1CRUdJTiBSU0EgUFJJVkFURSBLRVktLS0tLU1JSUVwUUlCQUFLQ0FRRUF1eWYvbE5ySDljazhEbU55bzNmR2d2Q0kxbDlzK2NtQlkzV0l6K2NVRHFteGlpZVIKLi0tLS0tRU5EIFJTQSBQUklWQVRFIEtFWS0tLS0t"
},
AppName = "limonade_app"
}
);
}
}
```
```java
package com.example.usage;
import com.twilio.comms.TwilioCommsClient;
import com.twilio.comms.resources.pushnotifications.credentials.requests.CredentialsCreateRequest;
import com.twilio.comms.types.ApnCertificatePushCredential;
import com.twilio.comms.types.PushCredentialContent;
import com.twilio.comms.types.PushCredentialType;
public class Example {
public static void main(String[] args) {
TwilioCommsClient client = TwilioCommsClient
.builder()
.credentials("", "")
.build();
client.pushNotifications().credentials().create(
CredentialsCreateRequest
.builder()
.credentialType(PushCredentialType.APN)
.content(
PushCredentialContent.of(
ApnCertificatePushCredential
.builder()
.certificate("LS0tLS1CRUdJTiBDRVJUSUZJQ0FURS0tLS0tTUlJRm5UQ0NCSVdnQXdJQkFnSUlBank5SDg0OStFOHdEUVlKS29aSWh2Y05BUUVGQlFBd2daWXhDekFKQmdOVi4uLi4uQT09LS0tLS1FTkQgQ0VSVElGSUNBVEUtLS0tLQ==")
.privateKey("LS0tLS1CRUdJTiBSU0EgUFJJVkFURSBLRVktLS0tLU1JSUVwUUlCQUFLQ0FRRUF1eWYvbE5ySDljazhEbU55bzNmR2d2Q0kxbDlzK2NtQlkzV0l6K2NVRHFteGlpZVIKLi0tLS0tRU5EIFJTQSBQUklWQVRFIEtFWS0tLS0t")
.build()
)
)
.appName("limonade_app")
.build()
);
}
}
```
```go
package example
import (
context "context"
twiliocomms "github.com/twilio/twilio-comms-go/twilio"
client "github.com/twilio/twilio-comms-go/twilio/client"
option "github.com/twilio/twilio-comms-go/twilio/option"
)
func do() {
client := client.NewWithOptions(
option.WithBasicAuth(
"",
"",
),
)
request := &twiliocomms.CredentialsCreateRequest{
CredentialType: twiliocomms.PushCredentialTypeApn,
Content: &twiliocomms.PushCredentialContent{
ApnCertificatePushCredential: &twiliocomms.ApnCertificatePushCredential{
Certificate: "LS0tLS1CRUdJTiBDRVJUSUZJQ0FURS0tLS0tTUlJRm5UQ0NCSVdnQXdJQkFnSUlBank5SDg0OStFOHdEUVlKS29aSWh2Y05BUUVGQlFBd2daWXhDekFKQmdOVi4uLi4uQT09LS0tLS1FTkQgQ0VSVElGSUNBVEUtLS0tLQ==",
PrivateKey: "LS0tLS1CRUdJTiBSU0EgUFJJVkFURSBLRVktLS0tLU1JSUVwUUlCQUFLQ0FRRUF1eWYvbE5ySDljazhEbU55bzNmR2d2Q0kxbDlzK2NtQlkzV0l6K2NVRHFteGlpZVIKLi0tLS0tRU5EIFJTQSBQUklWQVRFIEtFWS0tLS0t",
},
},
AppName: "limonade_app",
}
client.PushNotifications.Credentials.Create(
context.TODO(),
request,
)
}
```
```php
',
authToken: '',
);
$client->pushNotifications->credentials->create(
new CredentialsCreateRequest([
'credentialType' => PushCredentialType::Apn->value,
'content' => new ApnCertificatePushCredential([
'certificate' => 'LS0tLS1CRUdJTiBDRVJUSUZJQ0FURS0tLS0tTUlJRm5UQ0NCSVdnQXdJQkFnSUlBank5SDg0OStFOHdEUVlKS29aSWh2Y05BUUVGQlFBd2daWXhDekFKQmdOVi4uLi4uQT09LS0tLS1FTkQgQ0VSVElGSUNBVEUtLS0tLQ==',
'privateKey' => 'LS0tLS1CRUdJTiBSU0EgUFJJVkFURSBLRVktLS0tLU1JSUVwUUlCQUFLQ0FRRUF1eWYvbE5ySDljazhEbU55bzNmR2d2Q0kxbDlzK2NtQlkzV0l6K2NVRHFteGlpZVIKLi0tLS0tRU5EIFJTQSBQUklWQVRFIEtFWS0tLS0t',
]),
'appName' => 'limonade_app',
]),
);
```
```rb
require "twilio"
client = Twilio::Client.new(
account_id: "",
auth_token: ""
)
client.push_notifications.credentials.create(
credential_type: "APN",
content: {
certificate: "LS0tLS1CRUdJTiBDRVJUSUZJQ0FURS0tLS0tTUlJRm5UQ0NCSVdnQXdJQkFnSUlBank5SDg0OStFOHdEUVlKS29aSWh2Y05BUUVGQlFBd2daWXhDekFKQmdOVi4uLi4uQT09LS0tLS1FTkQgQ0VSVElGSUNBVEUtLS0tLQ==",
private_key: "LS0tLS1CRUdJTiBSU0EgUFJJVkFURSBLRVktLS0tLU1JSUVwUUlCQUFLQ0FRRUF1eWYvbE5ySDljazhEbU55bzNmR2d2Q0kxbDlzK2NtQlkzV0l6K2NVRHFteGlpZVIKLi0tLS0tRU5EIFJTQSBQUklWQVRFIEtFWS0tLS0t"
},
app_name: "limonade_app"
)
```
```bash
curl -X POST 'https://comms.twilio.com/v1/PushNotifications/Credentials' \
--header 'Content-Type: application/json' \
--data '{
"credentialType": "APN",
"content": {
"certificate": "your_base64_encoded_certificate",
"privateKey": "your_base64_encoded_private_key"
},
"appName": "your_app_name"
}' \
-u $TWILIO_ACCOUNT_SID:$TWILIO_AUTH_TOKEN
```
## Fetch a Credential
`GET https://comms.twilio.com/v1/PushNotifications/Credentials/{credentialId}`
Retrieve a single Credential resource by making an HTTP `GET` request to the Credential resource URI with the Credential ID.
### Path parameters
```json
[{"schema":{"x-twilio-version":1,"title":"CredentialId","description":"A reference to Credential.","type":"string","pattern":"^comms_credential_[a-hjkmnpqrstv-z0-9]{26,34}","example":"comms_credential_01h9krwprkeee8fzqspvwy6nq8","refName":"CredentialId","modelName":""},"x-twilio-version":1,"name":"credentialId","in":"path","required":true}]
```
### Responses
Fetch a Push Credential
```ts
import { TwilioClient } from "twilio-comms";
async function main() {
const client = new TwilioClient({
accountId: "",
authToken: "",
});
await client.pushNotifications.credentials.fetch("comms_credential_01h9krwprkeee8fzqspvwy6nq8");
}
main();
```
```py
from twilio import TwilioComms
client = TwilioComms(
account_id="",
auth_token="",
)
client.push_notifications.credentials.fetch(
credential_id="comms_credential_01h9krwprkeee8fzqspvwy6nq8",
)
```
```cs
using TwilioComms;
using System.Threading.Tasks;
public partial class Examples
{
public async Task Example() {
var client = new TwilioCommsClient(
accountId: "",
authToken: ""
);
await client.PushNotifications.Credentials.FetchAsync(
"comms_credential_01h9krwprkeee8fzqspvwy6nq8"
);
}
}
```
```java
package com.example.usage;
import com.twilio.comms.TwilioCommsClient;
public class Example {
public static void main(String[] args) {
TwilioCommsClient client = TwilioCommsClient
.builder()
.credentials("", "")
.build();
client.pushNotifications().credentials().fetch("comms_credential_01h9krwprkeee8fzqspvwy6nq8");
}
}
```
```go
package example
import (
context "context"
client "github.com/twilio/twilio-comms-go/twilio/client"
option "github.com/twilio/twilio-comms-go/twilio/option"
)
func do() {
client := client.NewWithOptions(
option.WithBasicAuth(
"",
"",
),
)
client.PushNotifications.Credentials.Fetch(
context.TODO(),
"comms_credential_01h9krwprkeee8fzqspvwy6nq8",
)
}
```
```php
',
authToken: '',
);
$client->pushNotifications->credentials->fetch(
'comms_credential_01h9krwprkeee8fzqspvwy6nq8',
);
```
```rb
require "twilio"
client = Twilio::Client.new(
account_id: "",
auth_token: ""
)
client.push_notifications.credentials.fetch(credential_id: "comms_credential_01h9krwprkeee8fzqspvwy6nq8")
```
```bash
curl 'https://comms.twilio.com/v1/PushNotifications/Credentials/{credentialId}' \
-u $TWILIO_ACCOUNT_SID:$TWILIO_AUTH_TOKEN
```
## List Credentials
`GET https://comms.twilio.com/v1/PushNotifications/Credentials`
Returns a list of all Credentials associated with your account. You can filter by date range, app name, credential type, or default status.
### Query parameters
```json
[{"in":"query","name":"startDate","description":"Filter to Push Credentials created after the specified date and time.","schema":{"type":"string","format":"date-time"}},{"in":"query","name":"endDate","description":"Filter to Push Credentials created before the specified date and time.","schema":{"type":"string","format":"date-time"}},{"in":"query","name":"appName","description":"Filter Push Credentials by App name","schema":{"x-twilio-version":1,"title":"PushNotificationAppName","description":"The name of the Push Notification `App`.","type":"string","pattern":"^[a-z0-9_]+$","minLength":1,"maxLength":64,"refName":"PushNotificationAppName","modelName":""}},{"in":"query","name":"credentialType","description":"Filter Push Credentials by type.","schema":{"x-twilio-version":1,"title":"PushCredentialType","description":"The credential types available for PushNotifications.","type":"string","enum":["APN","APN_SANDBOX","FCM"],"refName":"PushCredentialType","modelName":"PushCredentialType"}},{"in":"query","name":"isDefault","description":"Filter only is_default credentials.","schema":{"type":"boolean"}},{"in":"query","name":"pageToken","description":"The token to retrieve the next page of results.","schema":{"x-twilio-version":1,"description":"The token that identifies the page of resources to fetch.","title":"PageToken","type":"string","refName":"PageToken","modelName":""}},{"in":"query","name":"pageSize","description":"The number of resources to return in a page.","schema":{"x-twilio-version":1,"description":"Total number of items returned in a single page, the minimum is 1 and maximum is 1000. Default is 50.","title":"PageSize","type":"integer","minimum":1,"maximum":1000,"default":50,"example":50,"refName":"PageSize","modelName":""}}]
```
### Responses
List Push Credentials
```ts
import { TwilioClient } from "twilio-comms";
async function main() {
const client = new TwilioClient({
accountId: "",
authToken: "",
});
await client.pushNotifications.credentials.list({
startDate: new Date("2024-01-15T09:30:00Z"),
endDate: new Date("2024-01-15T09:30:00Z"),
appName: "appName",
credentialType: "APN",
isDefault: true,
pageToken: "pageToken",
pageSize: 50,
});
}
main();
```
```py
from twilio import TwilioComms
import datetime
client = TwilioComms(
account_id="",
auth_token="",
)
client.push_notifications.credentials.list(
start_date=datetime.datetime.fromisoformat("2024-01-15T09:30:00+00:00"),
end_date=datetime.datetime.fromisoformat("2024-01-15T09:30:00+00:00"),
app_name="appName",
credential_type="APN",
is_default=True,
page_token="pageToken",
page_size=50,
)
```
```cs
using TwilioComms;
using System.Threading.Tasks;
using TwilioComms.PushNotifications;
using System;
using System.Globalization;
public partial class Examples
{
public async Task Example() {
var client = new TwilioCommsClient(
accountId: "",
authToken: ""
);
await client.PushNotifications.Credentials.ListAsync(
new CredentialsListRequest {
StartDate = DateTime.Parse("2024-01-15T09:30:00Z", null, DateTimeStyles.AdjustToUniversal),
EndDate = DateTime.Parse("2024-01-15T09:30:00Z", null, DateTimeStyles.AdjustToUniversal),
AppName = "appName",
CredentialType = PushCredentialType.Apn,
IsDefault = true,
PageToken = "pageToken",
PageSize = 50
}
);
}
}
```
```java
package com.example.usage;
import com.twilio.comms.TwilioCommsClient;
import com.twilio.comms.resources.pushnotifications.credentials.requests.CredentialsListRequest;
import com.twilio.comms.types.PushCredentialType;
import java.time.OffsetDateTime;
public class Example {
public static void main(String[] args) {
TwilioCommsClient client = TwilioCommsClient
.builder()
.credentials("", "")
.build();
client.pushNotifications().credentials().list(
CredentialsListRequest
.builder()
.startDate(OffsetDateTime.parse("2024-01-15T09:30:00Z"))
.endDate(OffsetDateTime.parse("2024-01-15T09:30:00Z"))
.appName("appName")
.credentialType(PushCredentialType.APN)
.isDefault(true)
.pageToken("pageToken")
.pageSize(50)
.build()
);
}
}
```
```go
package example
import (
context "context"
twiliocomms "github.com/twilio/twilio-comms-go/twilio"
client "github.com/twilio/twilio-comms-go/twilio/client"
option "github.com/twilio/twilio-comms-go/twilio/option"
)
func do() {
client := client.NewWithOptions(
option.WithBasicAuth(
"",
"",
),
)
request := &twiliocomms.CredentialsListRequest{
StartDate: twiliocomms.Time(
twiliocomms.MustParseDateTime(
"2024-01-15T09:30:00Z",
),
),
EndDate: twiliocomms.Time(
twiliocomms.MustParseDateTime(
"2024-01-15T09:30:00Z",
),
),
AppName: twiliocomms.String(
"appName",
),
CredentialType: twiliocomms.PushCredentialTypeApn.Ptr(),
IsDefault: twiliocomms.Bool(
true,
),
PageToken: twiliocomms.String(
"pageToken",
),
PageSize: twiliocomms.Int(
50,
),
}
client.PushNotifications.Credentials.List(
context.TODO(),
request,
)
}
```
```php
',
authToken: '',
);
$client->pushNotifications->credentials->list(
new CredentialsListRequest([
'startDate' => new DateTime('2024-01-15T09:30:00Z'),
'endDate' => new DateTime('2024-01-15T09:30:00Z'),
'appName' => 'appName',
'credentialType' => PushCredentialType::Apn->value,
'isDefault' => true,
'pageToken' => 'pageToken',
'pageSize' => 50,
]),
);
```
```rb
require "twilio"
client = Twilio::Client.new(
account_id: "",
auth_token: ""
)
client.push_notifications.credentials.list(
start_date: "2024-01-15T09:30:00Z",
end_date: "2024-01-15T09:30:00Z",
app_name: "appName",
credential_type: "APN",
is_default: true,
page_token: "pageToken",
page_size: 50
)
```
```bash
curl 'https://comms.twilio.com/v1/PushNotifications/Credentials?pageSize=50' \
-u $TWILIO_ACCOUNT_SID:$TWILIO_AUTH_TOKEN
```
## Update a Credential
`PATCH https://comms.twilio.com/v1/PushNotifications/Credentials/{credentialId}`
Update an existing Credential by making an HTTP `PATCH` request to the Credential resource URI with the Credential ID.
You can update whether this Credential is the default for its App and credential type.
### Path parameters
```json
[{"schema":{"x-twilio-version":1,"title":"CredentialId","description":"A reference to Credential.","type":"string","pattern":"^comms_credential_[a-hjkmnpqrstv-z0-9]{26,34}","example":"comms_credential_01h9krwprkeee8fzqspvwy6nq8","refName":"CredentialId","modelName":""},"x-twilio-version":1,"name":"credentialId","in":"path","required":true}]
```
### Request body parameters
```json
{"schema":{"title":"UpdatePushCredentialRequest","type":"object","required":["isDefault"],"properties":{"isDefault":{"x-twilio-version":1,"title":"AccountPushCredentialFlag","description":"Use this Credential as the default for the Push Notification `App` for the\n given `credentialType` to send Push Notifications. \nIf a Credential of the given type doesn't already exist, \n this Credential automatically becomes the default.","type":"boolean","default":false,"refName":"AccountPushCredentialFlag","modelName":""}}},"examples":{"UpdateToDefaultCredential":{"summary":"Update to Default Credential","x-twilio-version":1,"value":{"lang":"json","value":"{\n \"isDefault\": true\n}","meta":"","code":"{\n \"isDefault\": true\n}","tokens":[["{","#C9D1D9"],"\n ",["\"isDefault\"","#7EE787"],[":","#C9D1D9"]," ",["true","#79C0FF"],"\n",["}","#C9D1D9"]],"annotations":[],"themeName":"github-dark","style":{"color":"#c9d1d9","background":"#0d1117"}}}},"encodingType":"application/json","conditionalParameterMap":{}}
```
### Responses
Update a Push Credential
```ts
import { TwilioClient } from "twilio-comms";
async function main() {
const client = new TwilioClient({
accountId: "",
authToken: "",
});
await client.pushNotifications.credentials.update("comms_credential_01h9krwprkeee8fzqspvwy6nq8", {
isDefault: true,
});
}
main();
```
```py
from twilio import TwilioComms
client = TwilioComms(
account_id="",
auth_token="",
)
client.push_notifications.credentials.update(
credential_id="comms_credential_01h9krwprkeee8fzqspvwy6nq8",
is_default=True,
)
```
```cs
using TwilioComms;
using System.Threading.Tasks;
using TwilioComms.PushNotifications;
public partial class Examples
{
public async Task Example() {
var client = new TwilioCommsClient(
accountId: "",
authToken: ""
);
await client.PushNotifications.Credentials.UpdateAsync(
"comms_credential_01h9krwprkeee8fzqspvwy6nq8",
new CredentialsUpdateRequest {
IsDefault = true
}
);
}
}
```
```java
package com.example.usage;
import com.twilio.comms.TwilioCommsClient;
import com.twilio.comms.resources.pushnotifications.credentials.requests.CredentialsUpdateRequest;
public class Example {
public static void main(String[] args) {
TwilioCommsClient client = TwilioCommsClient
.builder()
.credentials("", "")
.build();
client.pushNotifications().credentials().update(
"comms_credential_01h9krwprkeee8fzqspvwy6nq8",
CredentialsUpdateRequest
.builder()
.isDefault(true)
.build()
);
}
}
```
```go
package example
import (
context "context"
twiliocomms "github.com/twilio/twilio-comms-go/twilio"
client "github.com/twilio/twilio-comms-go/twilio/client"
option "github.com/twilio/twilio-comms-go/twilio/option"
)
func do() {
client := client.NewWithOptions(
option.WithBasicAuth(
"",
"",
),
)
request := &twiliocomms.CredentialsUpdateRequest{
IsDefault: true,
}
client.PushNotifications.Credentials.Update(
context.TODO(),
"comms_credential_01h9krwprkeee8fzqspvwy6nq8",
request,
)
}
```
```php
',
authToken: '',
);
$client->pushNotifications->credentials->update(
'comms_credential_01h9krwprkeee8fzqspvwy6nq8',
new CredentialsUpdateRequest([
'isDefault' => true,
]),
);
```
```rb
require "twilio"
client = Twilio::Client.new(
account_id: "",
auth_token: ""
)
client.push_notifications.credentials.update(
credential_id: "comms_credential_01h9krwprkeee8fzqspvwy6nq8",
is_default: true
)
```
```bash
curl -X PATCH 'https://comms.twilio.com/v1/PushNotifications/Credentials/{credentialId}' \
--header 'Content-Type: application/json' \
--data '{
"isDefault": true
}' \
-u $TWILIO_ACCOUNT_SID:$TWILIO_AUTH_TOKEN
```
## Delete a Credential
`DELETE https://comms.twilio.com/v1/PushNotifications/Credentials/{credentialId}`
Delete a Credential by making an HTTP `DELETE` request to the Credential resource URI with the Credential ID.
If successful, returns HTTP 202 (Accepted) with a resource ID to check the result.
> \[!WARNING]
>
> If all Credentials belonging to an App are deleted, the App and its Device Registrations are deleted as well.
### Path parameters
```json
[{"schema":{"x-twilio-version":1,"title":"CredentialId","description":"A reference to Credential.","type":"string","pattern":"^comms_credential_[a-hjkmnpqrstv-z0-9]{26,34}","example":"comms_credential_01h9krwprkeee8fzqspvwy6nq8","refName":"CredentialId","modelName":""},"x-twilio-version":1,"name":"credentialId","in":"path","required":true}]
```
### Responses
Delete a Push Credential
```ts
import { TwilioClient } from "twilio-comms";
async function main() {
const client = new TwilioClient({
accountId: "",
authToken: "",
});
await client.pushNotifications.credentials.delete("comms_credential_01h9krwprkeee8fzqspvwy6nq8");
}
main();
```
```py
from twilio import TwilioComms
client = TwilioComms(
account_id="",
auth_token="",
)
client.push_notifications.credentials.delete(
credential_id="comms_credential_01h9krwprkeee8fzqspvwy6nq8",
)
```
```cs
using TwilioComms;
using System.Threading.Tasks;
public partial class Examples
{
public async Task Example() {
var client = new TwilioCommsClient(
accountId: "",
authToken: ""
);
await client.PushNotifications.Credentials.DeleteAsync(
"comms_credential_01h9krwprkeee8fzqspvwy6nq8"
);
}
}
```
```java
package com.example.usage;
import com.twilio.comms.TwilioCommsClient;
public class Example {
public static void main(String[] args) {
TwilioCommsClient client = TwilioCommsClient
.builder()
.credentials("", "")
.build();
client.pushNotifications().credentials().delete("comms_credential_01h9krwprkeee8fzqspvwy6nq8");
}
}
```
```go
package example
import (
context "context"
client "github.com/twilio/twilio-comms-go/twilio/client"
option "github.com/twilio/twilio-comms-go/twilio/option"
)
func do() {
client := client.NewWithOptions(
option.WithBasicAuth(
"",
"",
),
)
client.PushNotifications.Credentials.Delete(
context.TODO(),
"comms_credential_01h9krwprkeee8fzqspvwy6nq8",
)
}
```
```php
',
authToken: '',
);
$client->pushNotifications->credentials->delete(
'comms_credential_01h9krwprkeee8fzqspvwy6nq8',
);
```
```rb
require "twilio"
client = Twilio::Client.new(
account_id: "",
auth_token: ""
)
client.push_notifications.credentials.delete(credential_id: "comms_credential_01h9krwprkeee8fzqspvwy6nq8")
```
```bash
curl -X DELETE 'https://comms.twilio.com/v1/PushNotifications/Credentials/{credentialId}' \
-u $TWILIO_ACCOUNT_SID:$TWILIO_AUTH_TOKEN
```