ApnsCredential Class

Description of a NotificationHub ApnsCredential.

Inheritance
msrest.serialization.Model
ApnsCredential

Constructor

ApnsCredential(*, apns_certificate: str | None = None, certificate_key: str | None = None, endpoint: str | None = None, thumbprint: str | None = None, key_id: str | None = None, app_name: str | None = None, app_id: str | None = None, token: str | None = None, **kwargs)

Keyword-Only Parameters

Name Description
apns_certificate
str

The APNS certificate. Specify if using Certificate Authentication Mode.

certificate_key
str

The APNS certificate password if it exists.

endpoint
str

The APNS endpoint of this credential. If using Certificate Authentication Mode and Sandbox specify 'gateway.sandbox.push.apple.com'. If using Certificate Authentication Mode and Production specify 'gateway.push.apple.com'. If using Token Authentication Mode and Sandbox specify 'https://api.development.push.apple.com:443/3/device'. If using Token Authentication Mode and Production specify 'https://api.push.apple.com:443/3/device'.

thumbprint
str

The APNS certificate thumbprint. Specify if using Certificate Authentication Mode.

key_id
str

A 10-character key identifier (kid) key, obtained from your developer account. Specify if using Token Authentication Mode.

app_name
str

The name of the application or BundleId. Specify if using Token Authentication Mode.

app_id
str

The issuer (iss) registered claim key. The value is a 10-character TeamId, obtained from your developer account. Specify if using Token Authentication Mode.

token
str

Provider Authentication Token, obtained through your developer account. Specify if using Token Authentication Mode.

Variables

Name Description
apns_certificate
str

The APNS certificate. Specify if using Certificate Authentication Mode.

certificate_key
str

The APNS certificate password if it exists.

endpoint
str

The APNS endpoint of this credential. If using Certificate Authentication Mode and Sandbox specify 'gateway.sandbox.push.apple.com'. If using Certificate Authentication Mode and Production specify 'gateway.push.apple.com'. If using Token Authentication Mode and Sandbox specify 'https://api.development.push.apple.com:443/3/device'. If using Token Authentication Mode and Production specify 'https://api.push.apple.com:443/3/device'.

thumbprint
str

The APNS certificate thumbprint. Specify if using Certificate Authentication Mode.

key_id
str

A 10-character key identifier (kid) key, obtained from your developer account. Specify if using Token Authentication Mode.

app_name
str

The name of the application or BundleId. Specify if using Token Authentication Mode.

app_id
str

The issuer (iss) registered claim key. The value is a 10-character TeamId, obtained from your developer account. Specify if using Token Authentication Mode.

token
str

Provider Authentication Token, obtained through your developer account. Specify if using Token Authentication Mode.