{"id":18298313,"url":"https://github.com/fusionauth/fusionauth-openapi","last_synced_at":"2025-09-06T03:42:44.523Z","repository":{"id":41141687,"uuid":"444941886","full_name":"FusionAuth/fusionauth-openapi","owner":"FusionAuth","description":"FusionAuth OpenAPI specification","archived":false,"fork":false,"pushed_at":"2025-09-04T14:50:48.000Z","size":647,"stargazers_count":8,"open_issues_count":6,"forks_count":1,"subscribers_count":10,"default_branch":"develop","last_synced_at":"2025-09-04T16:34:49.541Z","etag":null,"topics":["client-library","fusionauth","openapi","swagger"],"latest_commit_sha":null,"homepage":"https://fusionauth.io/docs/sdks/openapi","language":"Shell","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/FusionAuth.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":null,"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":"2022-01-05T20:31:30.000Z","updated_at":"2025-08-27T21:51:44.000Z","dependencies_parsed_at":"2024-04-25T23:50:20.212Z","dependency_job_id":"018e9b54-7228-4372-b522-f2307c269b79","html_url":"https://github.com/FusionAuth/fusionauth-openapi","commit_stats":null,"previous_names":[],"tags_count":72,"template":false,"template_full_name":null,"purl":"pkg:github/FusionAuth/fusionauth-openapi","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/FusionAuth%2Ffusionauth-openapi","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/FusionAuth%2Ffusionauth-openapi/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/FusionAuth%2Ffusionauth-openapi/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/FusionAuth%2Ffusionauth-openapi/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/FusionAuth","download_url":"https://codeload.github.com/FusionAuth/fusionauth-openapi/tar.gz/refs/heads/develop","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/FusionAuth%2Ffusionauth-openapi/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":273854444,"owners_count":25180008,"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-09-06T02:00:13.247Z","response_time":2576,"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":["client-library","fusionauth","openapi","swagger"],"created_at":"2024-11-05T15:05:46.285Z","updated_at":"2025-09-06T03:42:44.503Z","avatar_url":"https://github.com/FusionAuth.png","language":"Shell","funding_links":[],"categories":[],"sub_categories":[],"readme":"# FusionAuth OpenAPI\n\nThis is an OpenAPI specification for the FusionAuth API.\n\n[Here's the openapi specification YAML file](https://github.com/FusionAuth/fusionauth-openapi/blob/main/openapi.yaml).\n\nIt can be used in a variety of contexts, including generating client libraries, tracking API changes over time and testing. More here: https://openapi.tools/\n\nUse this file to do all your OpenAPI related actions. For additional information and documentation on FusionAuth refer to [https://fusionauth.io](https://fusionauth.io).\n\n* [Generate libraries](#generate-libraries)\n* [Java](#java)\n* [Ruby](#ruby)\n* [Test the YAML](#test-the-yaml)\n* [Postman Collection](#postman-collection)\n* [Known issues](#known-issues)\n* [Next steps](#next-steps)\n* [Questions and support](#contributions-and-support)\n* [Contributing](#contributing)\n* [License](#license)\n\n\n## Generate libraries\n\nInstall either Swagger: https://github.com/swagger-api/swagger-codegen/ or openapi: https://github.com/OpenAPITools/openapi-generator\n\nThese instructions will be for openapi.\n\n### Java\n\nTo build the java client libraries:\n\n```\nbin/java/build.sh\n```\n\nThis will produce a jar you can use.\n\n### Ruby\n\nTo build the ruby client libraries:\n\n```\nbin/ruby/build.sh\n```\n\nRead the readme in `ruby/README.md` for installation and usage instructions. To install it as a gem locally using --dev, I had to build it and then install a couple of rspec dependencies by hand.\n\nMore docs here: https://openapi-generator.tech/docs/generators/ruby\n\n### Dart\n\nTo build the dart client libraries:\n\n```\nbin/dart/build.sh\n```\n\nThis will produce a dart package you can import.\n\n## Test the YAML\n\n```\npip3 install schemathesis # one time\nschemathesis run -vvvv --checks not_a_server_error openapi.yaml --base-url http://localhost:9011 -H \"Authorization: bf69486b-4733-4470-a592-f1bfce7af580\" \n```\n\n## Postman Collection\n\nYou can also explore around with our API in postman.\n\nHere's our [Postman profile](https://www.postman.com/fusionauth) and [public workspace](https://www.postman.com/fusionauth/workspace).\n\n### Import Postman Collection\n\n* Log into the FusionAuth Postman team \n* Click the `Import` button on the left hand nav, toward the top\n* Import the API definition. This should also create a new collection\n* Rename the API and collection with the correct API version\n* Copy over the description from a previously imported API (easiest to do it in two tabs)\n* Copy the new collection into the workspace.\n* Go to the [FusionAuth Postman homepage](https://www.postman.com/fusionauth) and edit the new collection and put the date on it.\n\n\n## Known issues\n\nWhile the specification is valid, the generated client libraries haven't been fully exercised.\n\n* FusionAuth uses polymorphic responses for some API calls, particularly Identity Providers. The support for that in client library generation code is problematic, based on our testing. I'm not sure if there are workarounds, but it seems like some work is being done. See https://github.com/swagger-api/swagger-codegen/issues/10011 and https://github.com/OpenAPITools/openapi-generator/issues/10880#issuecomment-995243186 for an openapi workaround.\n* This spec is built using the [fusionauth-client-builder](https://github.com/fusionauth/fusionauth-client-builder) project JSON files. This covers almost all of the API, but not everything. A few calls may be missing. If you find one that you need, please open a bug report.\n* Deprecated API endpoints are not included.\n* There's no information about what parameters are required or not, because that is not part of the API JSON files.\n* There are certain operations, status codes and security mechanisms (JWT auth, cookies for auth) that are not currently supported because they are not included in the API JSON files.\n* OAuth grant actions aren't currently supported (the /oauth2/ endpoints).\n* There is an issue generating the ruby client libraries. https://github.com/OpenAPITools/openapi-generator/issues/11350 has the repro steps. The `RUBY_POST_PROCESS_FILE` environment variable is a workaround.\n\n## Next steps\n\nWe are publishing this to see how useful the FusionAuth community finds it. We welcome feedback on your usage of this spec. We'll plan to revisit this after we've received some feedback on how useful it is and determine if there are additional features we need to implement.\n\nPlease open bugs on this repository. For support in using this, please see the next section.\n\n## Questions and support\n\nIf you have a question or support issue regarding this OpenAPI spec, we'd love to hear from you.\n\nIf you have a paid edition with support included, please [open a ticket in your account portal](https://account.fusionauth.io/account/support/). Learn more about [paid editions here](https://fusionauth.io/pricing).\n\nOtherwise, please [post your question in the community forum](https://fusionauth.io/community/forum/).\n\n## Contributing\n\nBug reports and pull requests are welcome on GitHub at https://github.com/FusionAuth/go-client.\n\nIf you find an issue with syntax, etc - this is likely a bug in the generation script. Feel free to submit a PR against the Client Builder project.\n- [Client Builder](https://github.com/FusionAuth/fusionauth-client-builder)\n- [build-openapi-yaml.rb](https://github.com/FusionAuth/fusionauth-client-builder/blob/master/bin/build-openapi-yaml.rb)\n\n## License\n\nThe code is available as open source under the terms of the [Apache v2.0 License](https://opensource.org/licenses/Apache-2.0).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffusionauth%2Ffusionauth-openapi","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ffusionauth%2Ffusionauth-openapi","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffusionauth%2Ffusionauth-openapi/lists"}