Apple Wallet Provider

Get Apple Wallet provider settings

get

/api/{tenantId}/admin/walletProviders/apple

Returns the wallet fields of server/apple.yml. Private key material is never returned; only a presence flag (hasValue/hasKey) indicates whether it is currently set. Omit the corresponding field on PUT to keep the currently configured private key material unchanged.

Authorization

Requires tenant.configuration.walletProvider:read scope.

Required scopes

This endpoint requires the following scopes:

Authorizations

OAuth2implicitRequired

Authorization URL:

Path parameters

tenantIdstringRequired

Responses

200

Settings returned.

Apple Wallet provider settings.

teamIdentifierstringRequired

Team identifier of the organization that originated and signed the pass, as issued by Apple.

webServiceUrlstring · nullableOptional

WebServiceUrl used by Apple Wallet to migrate passes from neostore to another pass provider.

404

Apple Wallet is not configured.

get/api/{tenantId}/admin/walletProviders/apple

GET /api/{tenantId}/admin/walletProviders/apple HTTP/1.1
Host: app.neostore.cloud
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "teamIdentifier": "text",
  "apnKey": {
    "id": "text",
    "hasValue": true
  },
  "pass": {
    "passTypeIdentifier": "text",
    "certificate": {
      "certificate": "text",
      "hasKey": true
    },
    "certificateRequest": {
      "certificateRequest": null,
      "passTypeIdentifier": "text",
      "hasKey": true
    }
  },
  "webServiceUrl": null
}

Configure Apple Wallet provider settings

put

/api/{tenantId}/admin/walletProviders/apple

Replaces the wallet fields, leaving the "Sign in with Apple" serviceIdentifier field of the file untouched (or empty if this is the first time server/apple.yml is being created for this tenant).

Authorization

Requires tenant.configuration.walletProvider:write scope.

Required scopes

This endpoint requires the following scopes:

Authorizations

OAuth2implicitRequired

Authorization URL:

Path parameters

tenantIdstringRequired

Body

Request body to configure Apple Wallet.

teamIdentifierstring · min: 1Required

Team identifier of the organization that originated and signed the pass, as issued by Apple.

webServiceUrlstring · nullableOptional

WebServiceUrl used by Apple Wallet to migrate passes from neostore to another pass provider.

Responses

200

Settings updated.

Apple Wallet provider settings.

teamIdentifierstringRequired

Team identifier of the organization that originated and signed the pass, as issued by Apple.

webServiceUrlstring · nullableOptional

WebServiceUrl used by Apple Wallet to migrate passes from neostore to another pass provider.

400

A private key field (APNs key, certificate, or certificate request) was omitted and none is currently configured.

put/api/{tenantId}/admin/walletProviders/apple

PUT /api/{tenantId}/admin/walletProviders/apple HTTP/1.1
Host: app.neostore.cloud
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 255

{
  "teamIdentifier": "text",
  "apnKey": {
    "id": "text",
    "value": null
  },
  "pass": {
    "passTypeIdentifier": "text",
    "certificate": {
      "key": null,
      "certificate": "text"
    },
    "certificateRequest": {
      "key": null,
      "certificateRequest": null,
      "passTypeIdentifier": "text"
    }
  },
  "webServiceUrl": null
}

{
  "teamIdentifier": "text",
  "apnKey": {
    "id": "text",
    "hasValue": true
  },
  "pass": {
    "passTypeIdentifier": "text",
    "certificate": {
      "certificate": "text",
      "hasKey": true
    },
    "certificateRequest": {
      "certificateRequest": null,
      "passTypeIdentifier": "text",
      "hasKey": true
    }
  },
  "webServiceUrl": null
}