set_push_credentials

Set or replace one platform’s push credential; secrets are write-only.

platform “apns” takes team_id, key_id, bundle_id (matching an ios entry of identity_settings.mobile_apps), environment (“sandbox” or “production”) and the .p8 private_key. platform “fcm” takes project_id and the service account key file as service_account_json. Arguments of the other platform are refused. private_key and service_account_json are never returned. Listed and callable only while the application’s mobile_distribution capability resolves enabled.

Input schema

{
  "properties": {
    "application_id": {
      "title": "Application Id",
      "type": "string"
    },
    "bundle_id": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Bundle Id"
    },
    "environment": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Environment"
    },
    "is_active": {
      "default": true,
      "title": "Is Active",
      "type": "boolean"
    },
    "key_id": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Key Id"
    },
    "platform": {
      "title": "Platform",
      "type": "string"
    },
    "private_key": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Private Key"
    },
    "project_id": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Project Id"
    },
    "service_account_json": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "additionalProperties": true,
          "type": "object"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Service Account Json"
    },
    "team_id": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Team Id"
    }
  },
  "required": [
    "application_id",
    "platform"
  ],
  "title": "set_push_credentialsArguments",
  "type": "object"
}

Output schema

{
  "anyOf": [
    {
      "properties": {
        "active_registrations": {
          "default": 0,
          "title": "Active Registrations",
          "type": "integer"
        },
        "bundle_id": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "title": "Bundle Id"
        },
        "configured": {
          "title": "Configured",
          "type": "boolean"
        },
        "environment": {
          "anyOf": [
            {
              "enum": [
                "sandbox",
                "production"
              ],
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "title": "Environment"
        },
        "is_active": {
          "anyOf": [
            {
              "type": "boolean"
            },
            {
              "type": "null"
            }
          ],
          "title": "Is Active"
        },
        "key_id": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "title": "Key Id"
        },
        "team_id": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "title": "Team Id"
        },
        "updated_at": {
          "anyOf": [
            {
              "format": "date-time",
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "title": "Updated At"
        }
      },
      "required": [
        "configured"
      ],
      "title": "ApnsPushCredentialStatusResponse",
      "type": "object"
    },
    {
      "properties": {
        "active_registrations": {
          "default": 0,
          "title": "Active Registrations",
          "type": "integer"
        },
        "client_email": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "title": "Client Email"
        },
        "configured": {
          "title": "Configured",
          "type": "boolean"
        },
        "is_active": {
          "anyOf": [
            {
              "type": "boolean"
            },
            {
              "type": "null"
            }
          ],
          "title": "Is Active"
        },
        "project_id": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "title": "Project Id"
        },
        "updated_at": {
          "anyOf": [
            {
              "format": "date-time",
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "title": "Updated At"
        }
      },
      "required": [
        "configured"
      ],
      "title": "FcmPushCredentialStatusResponse",
      "type": "object"
    }
  ]
}