{"id":28403845,"url":"https://github.com/openfga/action-openfga-deploy","last_synced_at":"2025-10-09T02:14:19.760Z","repository":{"id":216352769,"uuid":"741045048","full_name":"openfga/action-openfga-deploy","owner":"openfga","description":"Github Action for deploying your Authorization Model to an OpenFGA Store","archived":false,"fork":false,"pushed_at":"2025-09-18T23:05:57.000Z","size":92,"stargazers_count":7,"open_issues_count":1,"forks_count":4,"subscribers_count":13,"default_branch":"main","last_synced_at":"2025-09-19T00:44:24.993Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":null,"has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/openfga.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":".github/SECURITY-INSIGHTS.yml","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2024-01-09T15:31:55.000Z","updated_at":"2025-08-14T11:56:23.000Z","dependencies_parsed_at":"2024-05-07T23:25:46.663Z","dependency_job_id":"fd746f94-0cae-4411-a2ff-4ce1f26839d5","html_url":"https://github.com/openfga/action-openfga-deploy","commit_stats":null,"previous_names":["openfga/action-openfga-deploy"],"tags_count":2,"template":false,"template_full_name":null,"purl":"pkg:github/openfga/action-openfga-deploy","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openfga%2Faction-openfga-deploy","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openfga%2Faction-openfga-deploy/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openfga%2Faction-openfga-deploy/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openfga%2Faction-openfga-deploy/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/openfga","download_url":"https://codeload.github.com/openfga/action-openfga-deploy/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openfga%2Faction-openfga-deploy/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":279000781,"owners_count":26082906,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-10-09T02:00:07.460Z","response_time":59,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2025-06-01T19:11:01.881Z","updated_at":"2025-10-09T02:14:19.753Z","avatar_url":"https://github.com/openfga.png","language":null,"funding_links":[],"categories":["\u003ca name=\"Not%20Set\"\u003e\u003c/a\u003eNot Set"],"sub_categories":[],"readme":"# OpenFGA Github Action - Deploy\n[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Fopenfga%2Faction-openfga-deploy.svg?type=shield)](https://app.fossa.com/projects/git%2Bgithub.com%2Fopenfga%2Faction-openfga-deploy?ref=badge_shield)\n\n\nThis action can be used to deploy your authorization model to an OpenFGA store.\n\n## Parameter\n\n| Parameter         | Required/Optional | Description                                                                                                  |\n|-------------------|-------------------|--------------------------------------------------------------------------------------------------------------|\n| `api-url`         | Required          | The URL to your OpenFGA server                                                                               |\n| `api-token`       | Required          | The token used to when preshared keys are used to authenticate the OpenFGA server                            |\n| `store-id`        | Required          | The store to which the model should be deployed                                                              |\n| `model-file-path` | Optional          | The path to your model file relative to the root of your project                                             |\n| `model`           | Optional          | The model value if file is not used, Ensure it is character escaped.                                         |\n| `format`          | Optional          | Authorization model input format. Can be \"fga\" or \"json\", defaults to auto-detecting from the file extension |\n\n## Outputs\n\n| Output                   | Description                                |\n|--------------------------|--------------------------------------------|\n| `authorization_model_id` | The ID of the deployed Authorization Model |\n\n## Example\n\n```yaml\nname: Deploy Action\n\non:\n  workflow_dispatch:\n\njobs:\n  deploy:\n    name: Deploy Authorization Model\n    runs-on: ubuntu-latest\n    steps:\n      - uses: actions/checkout@v4\n      - name: Deploy using a file\n        uses: openfga/action-openfga-deploy@v0.1.0\n        with:\n          api-url: http://localhost:8080\n          api-token: ${{ secrets.KEY }}\n          store-id: ${{ env.STORE_ID }}\n          model-file-path: ./example/model.fga\n      - name: Deploy using a string\n        uses: openfga/action-openfga-deploy@v0.1.0\n        with:\n          api-url: http://localhost:8080\n          api-token: ${{ secrets.KEY }}\n          store-id: ${{ env.STORE_ID }}\n          format: json\n          model: '{\\\"schema_version\\\":\\\"1.1\\\",\\\"type_definitions\\\":\\[\\{\\\"type\\\":\\\"user\\\"\\},\\{\\\"type\\\":\\\"document\\\",\\\"relations\\\":\\{\\\"reader\\\":\\{\\\"this\\\":\\{\\}\\},\\\"writer\\\":\\{\\\"this\\\":\\{\\}\\},\\\"owner\\\":\\{\\\"this\\\":\\{\\}\\}\\},\\\"metadata\\\":\\{\\\"relations\\\":\\{\\\"reader\\\":\\{\\\"directly_related_user_types\\\":\\[\\{\\\"type\\\":\\\"user\\\"\\}\\]\\},\\\"writer\\\":\\{\\\"directly_related_user_types\\\":\\[\\{\\\"type\\\":\\\"user\\\"\\}\\]\\},\\\"owner\\\":\\{\\\"directly_related_user_types\\\":\\[\\{\\\"type\\\":\\\"user\\\"\\}\\]\\}\\}\\}\\}\\]\\}'\n```\n\n\n## License\n[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Fopenfga%2Faction-openfga-deploy.svg?type=large)](https://app.fossa.com/projects/git%2Bgithub.com%2Fopenfga%2Faction-openfga-deploy?ref=badge_large)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fopenfga%2Faction-openfga-deploy","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fopenfga%2Faction-openfga-deploy","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fopenfga%2Faction-openfga-deploy/lists"}