{"id":23122582,"url":"https://github.com/folio-org/mod-users","last_synced_at":"2026-01-07T17:29:45.683Z","repository":{"id":37432582,"uuid":"70629815","full_name":"folio-org/mod-users","owner":"folio-org","description":"Domain Model to Manage Users","archived":false,"fork":false,"pushed_at":"2025-07-23T13:12:39.000Z","size":4963,"stargazers_count":1,"open_issues_count":2,"forks_count":16,"subscribers_count":23,"default_branch":"master","last_synced_at":"2025-07-23T15:15:36.175Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Java","has_issues":false,"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/folio-org.png","metadata":{"files":{"readme":"README.md","changelog":"NEWS.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2016-10-11T19:51:36.000Z","updated_at":"2025-07-14T17:12:00.000Z","dependencies_parsed_at":"2023-11-17T07:51:26.542Z","dependency_job_id":"87748500-8174-43c0-8215-9d5c660052a7","html_url":"https://github.com/folio-org/mod-users","commit_stats":null,"previous_names":[],"tags_count":61,"template":false,"template_full_name":null,"purl":"pkg:github/folio-org/mod-users","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/folio-org%2Fmod-users","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/folio-org%2Fmod-users/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/folio-org%2Fmod-users/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/folio-org%2Fmod-users/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/folio-org","download_url":"https://codeload.github.com/folio-org/mod-users/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/folio-org%2Fmod-users/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":270798843,"owners_count":24648034,"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-08-17T02:00:09.016Z","response_time":129,"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":"2024-12-17T07:28:15.966Z","updated_at":"2026-01-07T17:29:45.642Z","avatar_url":"https://github.com/folio-org.png","language":"Java","funding_links":[],"categories":[],"sub_categories":[],"readme":"# mod-users\n\nCopyright (C) 2016-2025 The Open Library Foundation\n\nThis software is distributed under the terms of the Apache License,\nVersion 2.0. See the file \"[LICENSE](LICENSE)\" for more information.\n\n## Introduction\n\nModule to provide central user management for FOLIO systems.\n\n## Prerequisites\n\n* Java 21 JDK\n* Maven 3.3.9\n\n## Additional information\n\nThe [raml-module-builder](https://github.com/folio-org/raml-module-builder) framework.\n\nOther [modules](https://dev.folio.org/source-code/#server-side).\n\nOther FOLIO Developer documentation is at [dev.folio.org](https://dev.folio.org/)\n\n### Issue tracker\n\nSee project [MODUSERS](https://issues.folio.org/browse/MODUSERS)\nat the [FOLIO issue tracker](https://dev.folio.org/guidelines/issue-tracker).\n\n### ModuleDescriptor\n\nSee the built `target/ModuleDescriptor.json` for the interfaces that this module\nrequires and provides, the permissions, and the additional module metadata.\n\n### API documentation\n\nThis module's [API documentation](https://dev.folio.org/reference/api/#mod-users).\n\n### Code analysis\n\n[SonarQube analysis](https://sonarcloud.io/dashboard?id=org.folio%3Amod-users).\n\n### Download and configuration\n\nThe built artifacts for this module are available.\nSee [configuration](https://dev.folio.org/download/artifacts) for repository access,\nand the [Docker image](https://hub.docker.com/r/folioorg/mod-users/).\n\n# Configuration setting for Profile-Picture Feature\nTo enable this feature for a tenant, we need to perform below operations\n### Permissions\n\n###### users.configurations.item.put\n###### users.configurations.item.get\n\n### Invoke GET endpoint\n#### Example request\nGET https://{okapi-location}/users/configurations/entry\n\n### After GET, PUT endpoint needs to be invoked\n#### Example request\nPUT https://{okapi-location}/users/configurations/entry/{id}\n\n{\n\"id\": {{id}},\n\"configName\": \"PROFILE_PICTURE_CONFIG\",\n\"enabled\": true,\n\"enabledObjectStorage\": false,\n\"encryptionKey\": \"fgrdvbfgjhutyrdhvbcxzmturdhgtiok\",\n\"maxFileSize\": 4\n}\n\nNote: maxFileSize must and should be within range of 0.1 to 10 megabytes.\n\nBy default DB storage will be enabled . To enable Object storage(S3/minio) below variables should be present in the env\nAWS_URL\nAWS_REGION\nAWS_ACCESS_KEY_ID\nAWS_SECRET_ACCESS_KEY\n\nNote:- Bucket should pre-exist with same name as tenantName.\n\n#### Example request\nPUT https://{okapi-location}/users/configurations/entry/{id}\n\n{\n\"id\": {{id}},\n\"configName\": \"PROFILE_PICTURE_CONFIG\",\n\"enabled\": true,\n\"enabledObjectStorage\": true,\n\"encryptionKey\": \"fgrdvbfgjhutyrdhvbcxzmturdhgtiok\",\n\"maxFileSize\": 4\n}\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffolio-org%2Fmod-users","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ffolio-org%2Fmod-users","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffolio-org%2Fmod-users/lists"}