{"_id":"@affinidi-tdk/consumer-iam-client","_rev":"2-eae5a97dd580ecaaecefaad5124663b9","name":"@affinidi-tdk/consumer-iam-client","dist-tags":{"latest":"1.2.0"},"versions":{"1.1.0":{"name":"@affinidi-tdk/consumer-iam-client","version":"1.1.0","keywords":["affinidi-tdk","identity","holistic","network","openapi-client","openapi-generator","@affinidi-tdk/consumer-iam-client"],"author":{"name":"Affinidi"},"license":"Apache-2.0","_id":"@affinidi-tdk/consumer-iam-client@1.1.0","maintainers":[{"name":"maratsh-affinidi","email":"marat.s@affinidi.com"},{"name":"aeffinidi","email":"atsuhiro.e@affinidi.com"},{"name":"carlos-affinidi","email":"carlos.r@affinidi.com"},{"name":"npmafad","email":"npm.afad@affinidi.com"}],"homepage":"https://github.com/affinidi/affinidi-tdk/tree/main#readme","bugs":{"url":"https://github.com/affinidi/affinidi-tdk/issues"},"dist":{"shasum":"59675fecd4529c9756d6b96450ec8688fe8cc35d","tarball":"https://registry.npmjs.org/@affinidi-tdk/consumer-iam-client/-/consumer-iam-client-1.1.0.tgz","fileCount":57,"integrity":"sha512-cbzMgFYprZuT3F+bXhNS23biA5ilnpKv0wRh7PjhWZ+RhkUsrtMJEZ8wuCXhxHmZvKv2Ia3+Br9HavqWejZdJA==","signatures":[{"sig":"MEQCIA//n8EGOlS2WheTGTLGo0FDxe46M0VG1FyEp/vNURS9AiA2NkK00+N+5Ftp1Cuz0nW1TLwwzdO2kET0hOWPHyqeCw==","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":248820},"main":"./dist/index.js","module":"./dist/esm/index.js","engines":{"node":"20.x"},"gitHead":"ae53bee806e3627977c929520f1124c05acfc43d","private":false,"scripts":{"lint":"eslint . --ext .ts","build":"tsc && tsc -p tsconfig.esm.json","prepare":"npm run build"},"typings":"./dist/index.d.ts","_npmUser":{"name":"maratsh-affinidi","email":"marat.s@affinidi.com"},"repository":{"url":"git+https://github.com/affinidi/affinidi-tdk.git#main","type":"git"},"_npmVersion":"10.8.2","description":"Affinidi TDK typescript client for Affinidi CONSUMER IAM","directories":{},"sideEffects":false,"_nodeVersion":"20.19.5","dependencies":{"url":"^0.11.4","axios":"^1.11.0","axios-retry":"^4.5.0"},"publishConfig":{"access":"public","registry":"https://registry.npmjs.org/"},"_hasShrinkwrap":false,"devDependencies":{"typescript":"^4.0","@types/node":"^18.18.2"},"_npmOperationalInternal":{"tmp":"tmp/consumer-iam-client_1.1.0_1764696264753_0.484936724184029","host":"s3://npm-registry-packages-npm-production"}},"1.2.0":{"name":"@affinidi-tdk/consumer-iam-client","version":"1.2.0","description":"Affinidi TDK typescript client for Affinidi CONSUMER IAM","author":{"name":"Affinidi"},"private":false,"repository":{"type":"git","url":"git+https://github.com/affinidi/affinidi-tdk.git#main"},"keywords":["affinidi-tdk","identity","holistic","network","openapi-client","openapi-generator","@affinidi-tdk/consumer-iam-client"],"license":"Apache-2.0","main":"./dist/index.js","typings":"./dist/index.d.ts","module":"./dist/esm/index.js","sideEffects":false,"engines":{"node":">=20.x"},"scripts":{"build":"tsc && tsc -p tsconfig.esm.json","lint":"eslint . --ext .ts","prepare":"npm run build"},"dependencies":{"axios":"^1.11.0","axios-retry":"^4.5.0","url":"^0.11.4"},"devDependencies":{"@types/node":"^18.18.2","typescript":"^4.0"},"publishConfig":{"access":"public","registry":"https://registry.npmjs.org/"},"gitHead":"fc41a1c7551f283b7422cbc94701b900c3bf716e","bugs":{"url":"https://github.com/affinidi/affinidi-tdk/issues"},"homepage":"https://github.com/affinidi/affinidi-tdk/tree/main#readme","_id":"@affinidi-tdk/consumer-iam-client@1.2.0","_nodeVersion":"20.20.2","_npmVersion":"10.8.2","dist":{"integrity":"sha512-xliUvRkdJNlo0F6JI5DMQuhW+5mLwwLkCaKntnUTw7kgxKmO3+2hZ/Vh/vJE/9nzVA/1uhKGiZ15esv0MYOu+Q==","shasum":"915007a86085d35798e7f529f1dca203611ee802","tarball":"https://registry.npmjs.org/@affinidi-tdk/consumer-iam-client/-/consumer-iam-client-1.2.0.tgz","fileCount":55,"unpackedSize":240902,"signatures":[{"keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U","sig":"MEQCIGaXElol0zhDiSkk0Sr2AqBUcecULE8pvknd4GSUJou3AiA7DWm5ICTpDWK0AmC33gYmURwMTnIOiOCK02DJR+o1gg=="}]},"_npmUser":{"name":"maratsh-affinidi","email":"marat.s@affinidi.com"},"directories":{},"maintainers":[{"name":"maratsh-affinidi","email":"marat.s@affinidi.com"},{"name":"aeffinidi","email":"atsuhiro.e@affinidi.com"},{"name":"carlos-affinidi","email":"carlos.r@affinidi.com"},{"name":"npmafad","email":"npm.afad@affinidi.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages-npm-production","tmp":"tmp/consumer-iam-client_1.2.0_1775581266598_0.8033887921177938"},"_hasShrinkwrap":false}},"time":{"created":"2025-12-02T17:24:24.660Z","modified":"2026-04-07T17:01:06.945Z","1.1.0":"2025-12-02T17:24:24.962Z","1.2.0":"2026-04-07T17:01:06.772Z"},"bugs":{"url":"https://github.com/affinidi/affinidi-tdk/issues"},"author":{"name":"Affinidi"},"license":"Apache-2.0","homepage":"https://github.com/affinidi/affinidi-tdk/tree/main#readme","keywords":["affinidi-tdk","identity","holistic","network","openapi-client","openapi-generator","@affinidi-tdk/consumer-iam-client"],"repository":{"type":"git","url":"git+https://github.com/affinidi/affinidi-tdk.git#main"},"description":"Affinidi TDK typescript client for Affinidi CONSUMER IAM","maintainers":[{"name":"maratsh-affinidi","email":"marat.s@affinidi.com"},{"name":"aeffinidi","email":"atsuhiro.e@affinidi.com"},{"name":"carlos-affinidi","email":"carlos.r@affinidi.com"},{"name":"npmafad","email":"npm.afad@affinidi.com"}],"readme":"## @affinidi-tdk/consumer-iam-client@1.0.0\n\nThis generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments:\n\nEnvironment\n\n- Node.js\n- Webpack\n- Browserify\n\nLanguage level\n\n- ES5 - you must have a Promises/A+ library installed\n- ES6\n\nModule system\n\n- CommonJS\n- ES6 module system\n\nIt can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html))\n\n### Building\n\nTo build and compile the typescript sources to javascript use:\n\n```\nnpm install\nnpm run build\n```\n\n### Publishing\n\nFirst build the package then run `npm publish`\n\n### Consuming\n\nnavigate to the folder of your consuming project and run one of the following commands.\n\n_published:_\n\n```\nnpm install @affinidi-tdk/consumer-iam-client@1.0.0 --save\n```\n\n_unPublished (not recommended):_\n\n```\nnpm install PATH_TO_GENERATED_PACKAGE --save\n```\n\n### Documentation for API Endpoints\n\nAll URIs are relative to *https://apse1.api.affinidi.io/cid*\n\n| Class             | Method                                                                             | HTTP request                                 | Description                                              |\n| ----------------- | ---------------------------------------------------------------------------------- | -------------------------------------------- | -------------------------------------------------------- |\n| _AuthzApi_        | [**deleteAccessVfs**](docs/AuthzApi.md#deleteaccessvfs)                            | **DELETE** /v1/authz/vfs/access/{granteeDid} | delete access of granteeDid                              |\n| _AuthzApi_        | [**getAccessVfs**](docs/AuthzApi.md#getaccessvfs)                                  | **GET** /v1/authz/vfs/access/{granteeDid}    | Get permissions to the virtual file system for a subject |\n| _AuthzApi_        | [**grantAccessVfs**](docs/AuthzApi.md#grantaccessvfs)                              | **POST** /v1/authz/vfs/access/{granteeDid}   | Grant access to the virtual file system                  |\n| _AuthzApi_        | [**updateAccessVfs**](docs/AuthzApi.md#updateaccessvfs)                            | **PUT** /v1/authz/vfs/access/{granteeDid}    | Update access of granteeDid                              |\n| _ConsumerAuthApi_ | [**consumerAuthTokenEndpoint**](docs/ConsumerAuthApi.md#consumerauthtokenendpoint) | **POST** /v1/consumer/oauth2/token           | The Consumer OAuth 2.0 Token Endpoint                    |\n| _WellKnownApi_    | [**getWellKnownJwks**](docs/WellKnownApi.md#getwellknownjwks)                      | **GET** /.well-known/jwks.json               |\n\n### Documentation For Models\n\n- [ConsumerAuthTokenEndpointInput](docs/ConsumerAuthTokenEndpointInput.md)\n- [ConsumerAuthTokenEndpointOutput](docs/ConsumerAuthTokenEndpointOutput.md)\n- [GetAccessOutput](docs/GetAccessOutput.md)\n- [GrantAccessInput](docs/GrantAccessInput.md)\n- [GrantAccessOutput](docs/GrantAccessOutput.md)\n- [InvalidDIDError](docs/InvalidDIDError.md)\n- [InvalidJwtTokenError](docs/InvalidJwtTokenError.md)\n- [InvalidJwtTokenErrorDetailsInner](docs/InvalidJwtTokenErrorDetailsInner.md)\n- [JsonWebKeyDto](docs/JsonWebKeyDto.md)\n- [JsonWebKeySetDto](docs/JsonWebKeySetDto.md)\n- [Permission](docs/Permission.md)\n- [RightsEnum](docs/RightsEnum.md)\n- [UnauthorizedError](docs/UnauthorizedError.md)\n- [UnexpectedError](docs/UnexpectedError.md)\n- [UpdateAccessInput](docs/UpdateAccessInput.md)\n- [UpdateAccessOutput](docs/UpdateAccessOutput.md)\n\n<a id=\"documentation-for-authorization\"></a>\n\n## Documentation For Authorization\n\nAuthentication schemes defined for the API:\n<a id=\"ConsumerTokenAuth\"></a>\n\n### ConsumerTokenAuth\n\n- **Type**: API key\n- **API key parameter name**: authorization\n- **Location**: HTTP header\n\n#### Obtaining auth token\n\n💡 To create personal access token (PAT), use Affinidi CLI's [create-token](https://github.com/affinidi/affinidi-cli/blob/main/docs/token.md#affinidi-token-create-token) command.\n\nLogin to your Affinidi Vault.\n\n```bash\naffinidi login\n```\n\nCheck for command details if you want to set optional passphrase and keyId:\n\n```bash\naffinidi token --help\n```\n\nCreate PAT:\n\n```bash\naffinidi token create-token -n YourTokenName -g -w --no-input\n```\n\nThis command will return you variables to initialize AuthProvider as required below.\n\n```ts\nimport { SomeClassApi, Configuration } from '@affinidi-tdk/consumer-iam-client'\nimport { AuthProvider } from '@affinidi-tdk/auth-provider'\n\nconst authProvider = new AuthProvider({ tokenId, privateKey, projectId })\n\nconst api = new SomeClassApi(\n  new Configuration({\n    apiKey: authProvider.fetchProjectScopedToken.bind(authProvider),\n  }),\n)\n\nawait api.oneOfMethods()\n```\n","readmeFilename":"README.md"}