Push credentials are required for the purpose of sending push notifications to a native application. Push credentials must be defined for the application.

The push credentials endpoint implements functions to create, read, update and delete the push credentials associated with native application resources.

There are two types of push credentials:

Push credentials data model

Property Description
type A string that specifies the type of the push credentials.
Mandatory.
Valid values:
  • APNS
  • FCM
key A string that Apple uses as an identifier to identify an authentication key.
Mandatory.
teamId A string that Apple uses as an identifier to identify teams.
  • Mandatory for APNS.
  • Should be left empty for FCM.
token A string that Apple uses as the authentication token signing key to securely connect to APNS. This is a p8 file with a private key format.
  • Mandatory for APNS.
  • Should be left empty for FCM.

Response codes

Code Message
200 Successful operation.
201 Successfully created.
204 Successfully removed. No content.
400 The request could not be completed.
401 You do not have access to this resource.
403 You do not have permissions or are not licensed to make this request.
404 The requested resource was not found.
500 Unexpected server error.