{"id":26064816,"url":"https://github.com/syncano/syncano-socket-aws-face-auth","last_synced_at":"2026-04-18T08:02:37.153Z","repository":{"id":77440723,"uuid":"113020771","full_name":"Syncano/syncano-socket-aws-face-auth","owner":"Syncano","description":null,"archived":false,"fork":false,"pushed_at":"2018-04-30T13:14:56.000Z","size":405,"stargazers_count":0,"open_issues_count":1,"forks_count":1,"subscribers_count":4,"default_branch":"master","last_synced_at":"2025-03-08T18:51:12.859Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Syncano.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"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}},"created_at":"2017-12-04T09:12:58.000Z","updated_at":"2017-12-04T09:21:32.000Z","dependencies_parsed_at":"2023-02-26T10:45:13.042Z","dependency_job_id":null,"html_url":"https://github.com/Syncano/syncano-socket-aws-face-auth","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/Syncano/syncano-socket-aws-face-auth","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Syncano%2Fsyncano-socket-aws-face-auth","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Syncano%2Fsyncano-socket-aws-face-auth/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Syncano%2Fsyncano-socket-aws-face-auth/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Syncano%2Fsyncano-socket-aws-face-auth/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Syncano","download_url":"https://codeload.github.com/Syncano/syncano-socket-aws-face-auth/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Syncano%2Fsyncano-socket-aws-face-auth/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":31961348,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-18T00:39:45.007Z","status":"online","status_checked_at":"2026-04-18T02:00:07.018Z","response_time":103,"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-03-08T18:49:27.499Z","updated_at":"2026-04-18T08:02:37.146Z","avatar_url":"https://github.com/Syncano.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Syncano Socket aws-face-auth\n[![CircleCI](https://circleci.com/gh/Syncano/syncano-socket-aws-face-auth.svg?style=svg)](https://circleci.com/gh/Syncano/syncano-socket-aws-face-auth)\n\nThis socket integrates face authentication with aws rekognition to Syncano.\n\n### Install\n\n```\nsyncano-cli add aws-face-auth\n```\n\n### Dependencies\n* **rest-auth socket**\n    \n    Since there can be no authentication without first registering to a system, it is important to use the `rest-auth` socket for basic registration.\n\n    [Link to rest-auth socket documentation](https://syncano.io/#/sockets/two-factor-auth)\n\n### Socket Documentation\n[Link to aws-face-auth socket documentation](https://syncano.io/#/sockets/aws-face-auth)\n\n\n## Endpoints\n\n#### create-collection\n\nThis endpoint creates a collection where face indexes will be stored in AWS Rekognition.\n\n*_Parameters_*\n\n| Name          | Type      | Description  | Example\n| ------------- |----------| ------------| ---------\n| collectionId  | string   | ID for the collection that you are creating | SyncanoFaces\n\n*_Response_*\n\n```\n{\n  \"collectionArn\": \"12345\",\n  \"statusCode\": 200\n}\n```\n\n#### delete-collection\n\nThis endpoint deletes a collection in AWS Rekognition.\n\n*_Parameters_*\n\n\n| Name          | Type      | Description  | Example\n| ------------- |-----------| ------------| ---------\n| collectionId  | string   | ID for the collection that you are deleting | SyncanoFaces\n\n*_Response_*\n\n```\n{\n  \"statusCode\": 200\n}\n```\n\n#### face-register\n\nThis endpoint register's a face to an existing user account for face authentication.\n\n*_Parameters_*\n\nUser required to input password as extra check when registering face to account.\n\n| Name          | Type      | Description  | Example\n| ------------- |-----------| ------------| ---------\n| username      | string   | User email   | you@domain.com\n| password     | string    | User password | user-password\n| collectionId | string    | Id collection to keep indexed image | SyncanoFaces\n| image        | string    | Path to image or an S3 object key | image.jpg\n| bucketName   | string    | Name of s3 bucket. Leave empty if image not on s3 bucket  | s3-bucket.\n\n*_Response_*\n\n```\n{\n  message: \"User face registered for face authentication.\"\n}\n```\n\n#### face-login\n\nThis endpoint login a user using face image.\n\n*_Parameters_*\n\n\n| Name          | Type      | Description  | Example\n| ------------- |-----------| ------------| ---------\n| collectionId | string    | Id collection to keep indexed image | SyncanoFaces\n| image        | string    | Path to image or an S3 object key | image.jpg\n| bucketName   | string    | Name of s3 bucket. Leave empty if image not on s3 bucket  | s3-bucket.\n\n*_Response_*\n\n```\n{\n  token: \"cb21ff98ac8c7dda8fcd01\",\n  username: \"you@domain.com\"\n}\n```\n\n#### remove-face-auth\n\nThis endpoint removes face authentication on user account\n\n*_Parameters_*\n\n\n| Name          | Type      | Description  | Example\n| ------------- |-----------| ------------| ---------\n| username      | string   | User email   | you@domain.com\n| token     | string    | User token | cb21fac8c7dda8fcd0129b0adb0254dea5c8e\n| collectionId | string    | Id collection to keep indexed image | SyncanoFaces\n| image        | string    | Path to image or an S3 object key | image.jpg\n| bucketName   | string    | Name of s3 bucket. Leave empty if image not on s3 bucket  | s3-bucket.\n\n\n*Response*\n\n```\n{\n  message: \"User account removed from face authentication.\"\n}\n```\n\n#### verify-face-auth\n\nThis endpoint checks if face authentication is enabled on user account\n\n*_Parameters_*\n\n\n| Name          | Type      | Description  | Example\n| ------------- |-----------| ------------| ---------\n| username      | string   | User email   | you@domain.com\n| token     | string    | User token | cb21fac8c7dda8fcd0129b0adb0254dea5c8e\n\n\n*Response*\n\n```\n{\n  message: \"Face auth enabled on user account.\",\n  is_face_auth: true\n}\n```\n\n### Contributing\n\n#### How to Contribute\n  * Fork this repository\n  * Clone from your fork\n  * Make your contributions (Make sure your work is well tested)\n  * Create Pull request from the fork to this repo\n\n#### Setting up environment variables\n  * Create a `.env` on parent folder\n  * Copy contents of `.env-sample` file to newly created `.env` file and assign appropriate values to the listed variables.\n\n#### Testing\n  * Ensure all your test are written on the `test` directory\n  * Use the command `npm test` to run test\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsyncano%2Fsyncano-socket-aws-face-auth","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsyncano%2Fsyncano-socket-aws-face-auth","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsyncano%2Fsyncano-socket-aws-face-auth/lists"}