{"id":23421316,"url":"https://github.com/nhsdigital/identity-service-api","last_synced_at":"2026-03-03T19:04:43.261Z","repository":{"id":37468500,"uuid":"251603074","full_name":"NHSDigital/identity-service-api","owner":"NHSDigital","description":"API Spec \u0026 Proxy for the NHS Identity IdP for NHS Digital's API Platform","archived":false,"fork":false,"pushed_at":"2026-02-27T14:55:09.000Z","size":3137,"stargazers_count":2,"open_issues_count":16,"forks_count":4,"subscribers_count":41,"default_branch":"master","last_synced_at":"2026-02-27T19:23:47.960Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/NHSDigital.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":"SECURITY.md","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":"2020-03-31T12:57:05.000Z","updated_at":"2026-02-27T14:53:48.000Z","dependencies_parsed_at":"2024-08-28T14:41:55.471Z","dependency_job_id":"992b3f75-3af0-4e29-b976-6d385bac349e","html_url":"https://github.com/NHSDigital/identity-service-api","commit_stats":null,"previous_names":[],"tags_count":289,"template":false,"template_full_name":"NHSDigital/api-management-service-template","purl":"pkg:github/NHSDigital/identity-service-api","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/NHSDigital%2Fidentity-service-api","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/NHSDigital%2Fidentity-service-api/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/NHSDigital%2Fidentity-service-api/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/NHSDigital%2Fidentity-service-api/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/NHSDigital","download_url":"https://codeload.github.com/NHSDigital/identity-service-api/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/NHSDigital%2Fidentity-service-api/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":30056056,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-03-03T18:21:05.932Z","status":"ssl_error","status_checked_at":"2026-03-03T18:20:59.341Z","response_time":61,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"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":"2024-12-23T02:14:46.431Z","updated_at":"2026-03-03T19:04:43.255Z","avatar_url":"https://github.com/NHSDigital.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# identity-service-api\n\n![Build](https://github.com/NHSDigital/identity-service-api/workflows/Build/badge.svg?branch=master)\n\nThis is a RESTful HL7® FHIR® API specification for the *Identity Service API*.\n\n* `specification/` This [Open API Specification](https://swagger.io/docs/specification/about/) describes the endpoints, methods and messages exchanged by the API. Use it to generate interactive documentation; the contract between the API and its consumers.\n* `scripts/` Utilities helpful to developers of this specification.\n* `proxies/` The Apigee API Proxy\n\nConsumers of the API will find developer documentation on the [NHS Digital Developer Hub](https://emea-demo8-nhsdportal.apigee.io/).\n\n## Contributing\nContributions to this project are welcome from anyone, providing that they conform to the [guidelines for contribution](https://github.com/NHSDigital/template-api/blob/master/CONTRIBUTING.md) and the [community code of conduct](https://github.com/NHSDigital/template-api/blob/master/CODE_OF_CONDUCT.md).\n\n### Licensing\nThis code is dual licensed under the MIT license and the OGL (Open Government License). Any new work added to this repository must conform to the conditions of these licenses. In particular this means that this project may not depend on GPL-licensed or AGPL-licensed libraries, as these would violate the terms of those libraries' licenses.\n\nThe contents of this repository are protected by Crown Copyright (C).\n\n## Development\n\n### Requirements\n* make\n* nodejs + npm/yarn\n* [poetry](https://github.com/python-poetry/poetry)\n\n### Install\nTo setup\n```\n$ make install\n```\n\n### Environment Variables\nVarious scripts and commands rely on environment variables being set. These are documented with the commands.\n\n:bulb: Consider using [direnv](https://direnv.net/) to manage your environment variables during development and maintaining your own `.envrc` file - the values of these variables will be specific to you and/or sensitive.\n\n### Make commands\nThere are `make` commands that alias some of this functionality:\n * `lint` -- Lints the spec and code\n * `publish` -- Outputs the specification as a **single file** into the `build/` directory\n * `serve` -- Serves a preview of the specification in human-readable format\n\n### Running tests\nFor detailed instructions see `/e2e`.\n\n### VS Code Plugins\n\n * [openapi-lint](https://marketplace.visualstudio.com/items?itemName=mermade.openapi-lint) resolves links and validates entire spec with the 'OpenAPI Resolve and Validate' command\n * [OpenAPI (Swagger) Editor](https://marketplace.visualstudio.com/items?itemName=42Crunch.vscode-openapi) provides sidebar navigation\n\n\n### Emacs Plugins\n\n * [**openapi-yaml-mode**](https://github.com/esc-emacs/openapi-yaml-mode) provides syntax highlighting, completion, and path help\n\n### Speccy\n\n\u003e [Speccy](http://speccy.io/) *A handy toolkit for OpenAPI, with a linter to enforce quality rules, documentation rendering, and resolution.*\n\nSpeccy does the lifting for the following npm scripts:\n\n * `test` -- Lints the definition\n * `publish` -- Outputs the specification as a **single file** into the `build/` directory\n * `serve` -- Serves a preview of the specification in human-readable format\n\n(Workflow detailed in a [post](https://developerjack.com/blog/2018/maintaining-large-design-first-api-specs/) on the *developerjack* blog.)\n\n:bulb: The `publish` command is useful when uploading to Apigee which requires the spec as a single file.\n\n### Caveats\n\n#### Swagger UI\nSwagger UI unfortunately doesn't correctly render `$ref`s in examples, so use `speccy serve` instead.\n\n### Platform setup\n\nSuccessful deployment of the API Proxy requires:\n\n 1. A *Key-Value Map* named identity_service_variables\n 2. An encrypted *Key-Value Map* named identity-service-variables-encrypted\n\nThe Key-Value maps need to be specified within the [api-management-infrastructure repository](https://github.com/NHSDigital/api-management-infrastructure) to be able to be used with the API proxy.\n:bulb: For Sandbox-running environments (`test`) these need to be present for successful deployment but can be set to empty/dummy values.","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnhsdigital%2Fidentity-service-api","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnhsdigital%2Fidentity-service-api","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnhsdigital%2Fidentity-service-api/lists"}