{"id":15019392,"url":"https://github.com/ibm-cloud-security/appid-clientsdk-js","last_synced_at":"2025-05-02T07:31:53.741Z","repository":{"id":35110355,"uuid":"199486714","full_name":"ibm-cloud-security/appid-clientsdk-js","owner":"ibm-cloud-security","description":"Client-side javascript SDK for the IBM Cloud App ID service","archived":false,"fork":false,"pushed_at":"2024-09-30T05:31:26.000Z","size":3680,"stargazers_count":10,"open_issues_count":18,"forks_count":8,"subscribers_count":4,"default_branch":"master","last_synced_at":"2025-04-20T19:35:41.650Z","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":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ibm-cloud-security.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":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2019-07-29T16:12:00.000Z","updated_at":"2024-11-14T22:17:02.000Z","dependencies_parsed_at":"2024-06-18T22:37:34.979Z","dependency_job_id":"f8dae7f4-722a-4e35-8838-74d711d62647","html_url":"https://github.com/ibm-cloud-security/appid-clientsdk-js","commit_stats":{"total_commits":72,"total_committers":14,"mean_commits":5.142857142857143,"dds":0.7222222222222222,"last_synced_commit":"b5365233b9d4bf4e39f0668792a5307cf6b9d1a8"},"previous_names":[],"tags_count":7,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ibm-cloud-security%2Fappid-clientsdk-js","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ibm-cloud-security%2Fappid-clientsdk-js/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ibm-cloud-security%2Fappid-clientsdk-js/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ibm-cloud-security%2Fappid-clientsdk-js/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ibm-cloud-security","download_url":"https://codeload.github.com/ibm-cloud-security/appid-clientsdk-js/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":251912749,"owners_count":21664087,"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","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-09-24T19:53:25.364Z","updated_at":"2025-05-02T07:31:53.114Z","avatar_url":"https://github.com/ibm-cloud-security.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"[![IBM Cloud powered][img-ibmcloud-powered]][url-ibmcloud]\n[![Coveralls][img-coveralls-master]][url-coveralls-master]\n[![Version][img-version]][url-npm]\n[![DownloadsMonthly][img-npm-downloads-monthly]][url-npm]\n[![DownloadsTotal][img-npm-downloads-total]][url-npm]\n[![License][img-license]][url-npm]\n\n\n[![GithubWatch][img-github-watchers]][url-github-watchers]\n[![GithubStars][img-github-stars]][url-github-stars]\n[![GithubForks][img-github-forks]][url-github-forks]\n\n# IBM Cloud App ID JavaScript SDK\nClient-side javascript SDK for the IBM Cloud App ID service to use with single-page applications created in Angular, React, or other frontend frameworks. \nRead the [documentation](https://cloud.ibm.com/docs/services/appid?topic=appid-single-page) for information on getting started with IBM Cloud App ID and single-page applications.\nApps using Node.js should use our [server-side SDK](https://github.com/ibm-cloud-security/appid-serversdk-nodejs).\n## Table of Contents\n\n-   [Installation][1]\n\n-   [Getting Started][2]\n\n-   [API Reference][3]\n\n## Installation\nUsing npm:\n```javascript\nnpm install ibmcloud-appid-js\n```\n\n```javascript\nimport AppID from 'ibmcloud-appid-js';\n```\n\nFrom the CDN:\n```html\n\u003cscript src=\"https://cdn.appid.cloud.ibm.com/appid-1.0.1.min.js\"\u003e\u003c/script\u003e\n```\n\nOr for development purposes use the minified file in this repo:\n```html\n\u003cscript type='text/javascript' src=\"dist/appid.min.js\"\u003e\u003c/script\u003e\n```\n\n## Getting Started\nA sample application can be found in the `sample` folder in this repo.\n\nYou will need an [IBM Cloud App ID](https://www.ibm.com/cloud/app-id) instance with a `singlepageapp` application created.\nApps using Angular, React, or other frontend frameworks will require a specific type of credentials to use with IBM Cloud App ID. \nVisit [the docs](https://cloud.ibm.com/docs/services/appid?topic=appid-single-page#create-spa-credentials) to learn more about creating application credentials.\n\nUse the `clientId` and `discoveryEndpoint` from the application credentials to initialize the `AppID` instance. \n```javascript\nconst appID = new AppID();\nawait appID.init({\n    clientId: '\u003cSPA_CLIENT_ID\u003e',\n    discoveryEndpoint: '\u003cWELL_KNOWN_ENDPOINT\u003e'\n});\n``` \nUsing the signin() in your app to start authentication:\n```javascript\ndocument.getElementById('login').addEventListener('click', async () =\u003e {\n    try {\n        const tokens = await appID.signin();\n    } catch (e) {\n        ...\n    }\n});\n```\nRead the [documentation](https://cloud.ibm.com/docs/services/appid?topic=appid-getting-started#gettingstarted) for information about getting started with IBM Cloud App ID Service.\n\n## API Reference\nCheckout our API reference [here](https://ibm-cloud-security.github.io/appid-clientsdk-js/).\n\n[1]: #installation\n[2]: #getting-started\n[3]: #api-reference\n\n\n[img-ibmcloud-powered]: https://img.shields.io/badge/ibm%20cloud-powered-blue.svg\n[url-ibmcloud]: https://www.ibm.com/cloud/\n[url-npm]: https://www.npmjs.com/package/ibmcloud-appid-js\n[img-license]: https://img.shields.io/npm/l/ibmcloud-appid-js.svg\n[img-version]: https://img.shields.io/npm/v/ibmcloud-appid-js.svg\n[img-npm-downloads-monthly]: https://img.shields.io/npm/dm/ibmcloud-appid-js.svg\n[img-npm-downloads-total]: https://img.shields.io/npm/dt/ibmcloud-appid-js.svg\n\n[img-github-watchers]: https://img.shields.io/github/watchers/ibm-cloud-security/appid-clientsdk-js.svg?style=social\u0026label=Watch\n[url-github-watchers]: https://github.com/ibm-cloud-security/appid-clientsdk-js/watchers\n[img-github-stars]: https://img.shields.io/github/stars/ibm-cloud-security/appid-clientsdk-js.svg?style=social\u0026label=Star\n[url-github-stars]: https://github.com/ibm-cloud-security/appid-clientsdk-js/stargazers\n[img-github-forks]: https://img.shields.io/github/forks/ibm-cloud-security/appid-clientsdk-js.svg?style=social\u0026label=Fork\n[url-github-forks]: https://github.com/ibm-cloud-security/appid-clientsdk-js/network\n\n[img-coveralls-master]: https://coveralls.io/repos/github/ibm-cloud-security/appid-clientsdk-js/badge.svg\n[url-coveralls-master]: https://coveralls.io/github/ibm-cloud-security/appid-clientsdk-js\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fibm-cloud-security%2Fappid-clientsdk-js","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fibm-cloud-security%2Fappid-clientsdk-js","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fibm-cloud-security%2Fappid-clientsdk-js/lists"}