{"_id":"3scale-loader","_rev":"3-accab2868cd3a517936789b9743ba3fc","name":"3scale-loader","description":"A script that loads sample data in 3scale","dist-tags":{"latest":"0.1.1"},"versions":{"0.1.0":{"name":"3scale-loader","version":"0.1.0","description":"A script that loads sample data in 3scale","main":"index.js","scripts":{"test":"echo \"Error: no test specified\" && exit 1"},"author":{"name":"Nicolas MASSE"},"license":"MIT","bin":{"3scale-loader":"./index.js"},"dependencies":{"commander":"^2.9.0","faker":"^4.1.0"},"repository":{"type":"git","url":"git+https://github.com/nmasse-itix/3scale-loader.git"},"gitHead":"be1124ac687e794f70a45fd175b8cdbbc6acebce","bugs":{"url":"https://github.com/nmasse-itix/3scale-loader/issues"},"homepage":"https://github.com/nmasse-itix/3scale-loader#readme","_id":"3scale-loader@0.1.0","_shasum":"1c4ab5ca91d436700795580d88a0d41f43948d32","_from":".","_npmVersion":"4.2.0","_nodeVersion":"8.0.0","_npmUser":{"name":"nmasse-itix","email":"nicolas.masse@itix.fr"},"dist":{"shasum":"1c4ab5ca91d436700795580d88a0d41f43948d32","tarball":"https://registry.npmjs.org/3scale-loader/-/3scale-loader-0.1.0.tgz","integrity":"sha512-FoTsG2m4sywVpKbjEKgwju7yLwZG4RByWG7fDpz+zIRhNkqgV5HdxS8xqSX1bg+JcO2NwYE0x63862Z6DAoOhQ==","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIFgh1/kogGuQPXwxuxO3LPT380xPgxoqdD41iq/53vm1AiAZu6QDjHu6RxuiMAiDVuGlAPjQZydzPFE1O2tczGsM8A=="}]},"maintainers":[{"name":"nmasse-itix","email":"nicolas.masse@itix.fr"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/3scale-loader-0.1.0.tgz_1496308335046_0.6998607879504561"}},"0.1.1":{"name":"3scale-loader","version":"0.1.1","description":"A script that loads sample data in 3scale","main":"index.js","scripts":{"test":"echo \"Error: no test specified\" && exit 1"},"author":{"name":"Nicolas MASSE"},"license":"MIT","bin":{"3scale-loader":"./index.js"},"dependencies":{"commander":"^2.9.0","faker":"^4.1.0"},"repository":{"type":"git","url":"git+https://github.com/nmasse-itix/3scale-loader.git"},"gitHead":"a17a65411d16233964778dd01137e750b5b5e1ae","bugs":{"url":"https://github.com/nmasse-itix/3scale-loader/issues"},"homepage":"https://github.com/nmasse-itix/3scale-loader#readme","_id":"3scale-loader@0.1.1","_shasum":"b50763cc272afc85771f5e33b37604026ce90d9c","_from":".","_npmVersion":"4.2.0","_nodeVersion":"8.0.0","_npmUser":{"name":"nmasse-itix","email":"nicolas.masse@itix.fr"},"dist":{"shasum":"b50763cc272afc85771f5e33b37604026ce90d9c","tarball":"https://registry.npmjs.org/3scale-loader/-/3scale-loader-0.1.1.tgz","integrity":"sha512-txMbmETg/+GajPL9k7rT/ZIMEV2Vs4sETLJjU10JCOg++6zdP1bk+Qye4PRzlzGjPryUuua5tBHZTpDVIa8/1w==","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIHndx6FEHVK3Od/eHP68VOfnUyCrnaD6NnYg8ZL28OiEAiEA2pKbZkV3jBo6N2Yd7T/+zovkvGhXpVsMTioH7KyHT/Q="}]},"maintainers":[{"name":"nmasse-itix","email":"nicolas.masse@itix.fr"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/3scale-loader-0.1.1.tgz_1496308950556_0.7658751793205738"}}},"readme":"# A script that loads sample data in your 3scale account\n\n## Why ?\n\nSometime to do a demo of 3scale, you would like to populate your account with sample data.  \n\n## Overview\n\nThis scripts does two things :\n - create some sample data (accounts, applications, users) in your 3scale account.\n - cleanup your platform (ie. delete the previously created accounts, applications, users).\n\n## Preparation\n\n### Create an Access Token (MANDATORY)\n\nGo to your 3scale admin console and click on the gear icon on the top right corner\nand drill down to `Personal Settings` > `Tokens`.\n\nCreate an access token and keep the generated token in a safe place.\nMake sure the \"Account Management API\" scope is checked and permissions is\nset to \"Read/write\".\n\n![Create an Access Token](./doc/img/access_token.png)\n\n### Create an extra field (RECOMMENDED)\n\nIf you create an extra field named \"x-created-by\", the script will use it to mark\nthe accounts, applications and users so that it can do the cleanup later.\n\nIf this extra field is not created, the cleanup will not be done.\n\nTo create this field, go to your 3scale admin console and drill down to\n`Settings` > `Fields Definition` and create three fields :\n - a user field named `x-created-by`\n - an account field named `x-created-by`\n - an application field named `x-created-by`\n\nMake sure the name is `x-created-by` (the name is currently hardcoded) and :\n - `Hidden` is checked\n - `Read Only` is checked\n\n![Create a field](./doc/img/extra_field.png)\n\n![At the end you should have three new fields](./doc/img/extra_fields.png)\n\n## Installation\n\nThe easiest way to install this script is through NPM :\n```\nnpm install -g 3scale-loader\n```\n\n## How to use it\n\nTo create 2 sample accounts, 3 applications in each account and 1 additional user in each account :\n```\n3scale-loader create --host <tenant>-admin.3scale.net --token <your-access-token> --accounts 2 --applications 3 --users 1 --verbose\n```\n\nTo cleanup the created objects :\n```\n3scale-loader cleanup --host <tenant>-admin.3scale.net --token <your-access-token> --verbose\n```\n\nTo get some help :\n```\n3scale-loader --help\n```\n","maintainers":[{"name":"nmasse-itix","email":"nicolas.masse@itix.fr"}],"time":{"modified":"2022-06-12T14:07:29.862Z","created":"2017-06-01T09:12:15.972Z","0.1.0":"2017-06-01T09:12:15.972Z","0.1.1":"2017-06-01T09:22:31.421Z"},"homepage":"https://github.com/nmasse-itix/3scale-loader#readme","repository":{"type":"git","url":"git+https://github.com/nmasse-itix/3scale-loader.git"},"author":{"name":"Nicolas MASSE"},"bugs":{"url":"https://github.com/nmasse-itix/3scale-loader/issues"},"license":"MIT","readmeFilename":"README.md"}