@unkey/api 2.0.2 → 2.0.4
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +4 -2
- package/bin/mcp-server.js +371 -222
- package/bin/mcp-server.js.map +33 -31
- package/dist/commonjs/funcs/apisDeleteApi.d.ts +4 -2
- package/dist/commonjs/funcs/apisDeleteApi.d.ts.map +1 -1
- package/dist/commonjs/funcs/apisDeleteApi.js +4 -2
- package/dist/commonjs/funcs/apisDeleteApi.js.map +1 -1
- package/dist/commonjs/funcs/identitiesCreateIdentity.d.ts +2 -2
- package/dist/commonjs/funcs/identitiesCreateIdentity.js +2 -2
- package/dist/commonjs/funcs/keysRerollKey.d.ts +49 -0
- package/dist/commonjs/funcs/keysRerollKey.d.ts.map +1 -0
- package/dist/commonjs/funcs/keysRerollKey.js +159 -0
- package/dist/commonjs/funcs/keysRerollKey.js.map +1 -0
- package/dist/commonjs/funcs/permissionsListPermissions.d.ts +2 -1
- package/dist/commonjs/funcs/permissionsListPermissions.d.ts.map +1 -1
- package/dist/commonjs/funcs/permissionsListPermissions.js +2 -1
- package/dist/commonjs/funcs/permissionsListPermissions.js.map +1 -1
- package/dist/commonjs/funcs/permissionsListRoles.d.ts +2 -1
- package/dist/commonjs/funcs/permissionsListRoles.d.ts.map +1 -1
- package/dist/commonjs/funcs/permissionsListRoles.js +2 -1
- package/dist/commonjs/funcs/permissionsListRoles.js.map +1 -1
- package/dist/commonjs/lib/config.d.ts +3 -3
- package/dist/commonjs/lib/config.js +3 -3
- package/dist/commonjs/mcp-server/mcp-server.js +1 -1
- package/dist/commonjs/mcp-server/server.d.ts.map +1 -1
- package/dist/commonjs/mcp-server/server.js +3 -1
- package/dist/commonjs/mcp-server/server.js.map +1 -1
- package/dist/commonjs/mcp-server/tools/apisDeleteApi.d.ts.map +1 -1
- package/dist/commonjs/mcp-server/tools/apisDeleteApi.js +4 -2
- package/dist/commonjs/mcp-server/tools/apisDeleteApi.js.map +1 -1
- package/dist/commonjs/mcp-server/tools/identitiesCreateIdentity.js +2 -2
- package/dist/commonjs/mcp-server/tools/identitiesUpdateIdentity.js +2 -2
- package/dist/commonjs/mcp-server/tools/keysRerollKey.d.ts +8 -0
- package/dist/commonjs/mcp-server/tools/keysRerollKey.d.ts.map +1 -0
- package/dist/commonjs/mcp-server/tools/keysRerollKey.js +96 -0
- package/dist/commonjs/mcp-server/tools/keysRerollKey.js.map +1 -0
- package/dist/commonjs/mcp-server/tools/permissionsListPermissions.d.ts.map +1 -1
- package/dist/commonjs/mcp-server/tools/permissionsListPermissions.js +2 -1
- package/dist/commonjs/mcp-server/tools/permissionsListPermissions.js.map +1 -1
- package/dist/commonjs/mcp-server/tools/permissionsListRoles.d.ts.map +1 -1
- package/dist/commonjs/mcp-server/tools/permissionsListRoles.js +2 -1
- package/dist/commonjs/mcp-server/tools/permissionsListRoles.js.map +1 -1
- package/dist/commonjs/models/components/identity.d.ts +8 -2
- package/dist/commonjs/models/components/identity.d.ts.map +1 -1
- package/dist/commonjs/models/components/identity.js +2 -2
- package/dist/commonjs/models/components/identity.js.map +1 -1
- package/dist/commonjs/models/components/index.d.ts +3 -3
- package/dist/commonjs/models/components/index.d.ts.map +1 -1
- package/dist/commonjs/models/components/index.js +3 -3
- package/dist/commonjs/models/components/index.js.map +1 -1
- package/dist/commonjs/models/components/keyresponsedata.d.ts +0 -5
- package/dist/commonjs/models/components/keyresponsedata.d.ts.map +1 -1
- package/dist/commonjs/models/components/keyresponsedata.js +0 -2
- package/dist/commonjs/models/components/keyresponsedata.js.map +1 -1
- package/dist/commonjs/models/components/permission.d.ts +1 -1
- package/dist/commonjs/models/components/v2identitiesgetidentityresponsebody.d.ts +3 -3
- package/dist/commonjs/models/components/v2identitiesgetidentityresponsebody.d.ts.map +1 -1
- package/dist/commonjs/models/components/v2identitiesgetidentityresponsebody.js +3 -3
- package/dist/commonjs/models/components/v2identitiesgetidentityresponsebody.js.map +1 -1
- package/dist/commonjs/models/components/v2identitiesupdateidentityrequestbody.d.ts +3 -7
- package/dist/commonjs/models/components/v2identitiesupdateidentityrequestbody.d.ts.map +1 -1
- package/dist/commonjs/models/components/v2identitiesupdateidentityrequestbody.js +2 -2
- package/dist/commonjs/models/components/v2identitiesupdateidentityrequestbody.js.map +1 -1
- package/dist/commonjs/models/components/v2keysaddpermissionsresponsebody.d.ts +0 -1
- package/dist/commonjs/models/components/v2keysaddpermissionsresponsebody.d.ts.map +1 -1
- package/dist/commonjs/models/components/v2keysaddpermissionsresponsebody.js.map +1 -1
- package/dist/commonjs/models/components/v2keysaddrolesresponsebody.d.ts +0 -1
- package/dist/commonjs/models/components/v2keysaddrolesresponsebody.d.ts.map +1 -1
- package/dist/commonjs/models/components/v2keysaddrolesresponsebody.js.map +1 -1
- package/dist/commonjs/models/components/v2keysremoverolesresponsebody.d.ts +0 -1
- package/dist/commonjs/models/components/v2keysremoverolesresponsebody.d.ts.map +1 -1
- package/dist/commonjs/models/components/v2keysremoverolesresponsebody.js.map +1 -1
- package/dist/commonjs/models/components/v2keysrerollkeyrequestbody.d.ts +60 -0
- package/dist/commonjs/models/components/v2keysrerollkeyrequestbody.d.ts.map +1 -0
- package/dist/commonjs/models/components/{v2permissionsgetroleresponsedata.js → v2keysrerollkeyrequestbody.js} +21 -20
- package/dist/commonjs/models/components/v2keysrerollkeyrequestbody.js.map +1 -0
- package/dist/commonjs/models/components/v2keysrerollkeyresponsebody.d.ts +36 -0
- package/dist/commonjs/models/components/v2keysrerollkeyresponsebody.d.ts.map +1 -0
- package/dist/commonjs/models/components/v2keysrerollkeyresponsebody.js +73 -0
- package/dist/commonjs/models/components/v2keysrerollkeyresponsebody.js.map +1 -0
- package/dist/commonjs/models/components/v2keysrerollkeyresponsedata.d.ts +62 -0
- package/dist/commonjs/models/components/v2keysrerollkeyresponsedata.d.ts.map +1 -0
- package/dist/commonjs/models/components/v2keysrerollkeyresponsedata.js +71 -0
- package/dist/commonjs/models/components/v2keysrerollkeyresponsedata.js.map +1 -0
- package/dist/commonjs/models/components/v2keyssetpermissionsresponsebody.d.ts +0 -1
- package/dist/commonjs/models/components/v2keyssetpermissionsresponsebody.d.ts.map +1 -1
- package/dist/commonjs/models/components/v2keyssetpermissionsresponsebody.js.map +1 -1
- package/dist/commonjs/models/components/v2keyssetrolesresponsebody.d.ts +0 -1
- package/dist/commonjs/models/components/v2keyssetrolesresponsebody.d.ts.map +1 -1
- package/dist/commonjs/models/components/v2keyssetrolesresponsebody.js.map +1 -1
- package/dist/commonjs/models/components/v2permissionsgetpermissionresponsebody.d.ts +3 -6
- package/dist/commonjs/models/components/v2permissionsgetpermissionresponsebody.d.ts.map +1 -1
- package/dist/commonjs/models/components/v2permissionsgetpermissionresponsebody.js +3 -3
- package/dist/commonjs/models/components/v2permissionsgetpermissionresponsebody.js.map +1 -1
- package/dist/commonjs/models/components/v2permissionsgetroleresponsebody.d.ts +3 -6
- package/dist/commonjs/models/components/v2permissionsgetroleresponsebody.d.ts.map +1 -1
- package/dist/commonjs/models/components/v2permissionsgetroleresponsebody.js +3 -3
- package/dist/commonjs/models/components/v2permissionsgetroleresponsebody.js.map +1 -1
- package/dist/commonjs/sdk/apis.d.ts +4 -2
- package/dist/commonjs/sdk/apis.d.ts.map +1 -1
- package/dist/commonjs/sdk/apis.js +4 -2
- package/dist/commonjs/sdk/apis.js.map +1 -1
- package/dist/commonjs/sdk/identities.d.ts +2 -2
- package/dist/commonjs/sdk/identities.js +2 -2
- package/dist/commonjs/sdk/keys.d.ts +38 -0
- package/dist/commonjs/sdk/keys.d.ts.map +1 -1
- package/dist/commonjs/sdk/keys.js +41 -0
- package/dist/commonjs/sdk/keys.js.map +1 -1
- package/dist/commonjs/sdk/permissions.d.ts +4 -2
- package/dist/commonjs/sdk/permissions.d.ts.map +1 -1
- package/dist/commonjs/sdk/permissions.js +4 -2
- package/dist/commonjs/sdk/permissions.js.map +1 -1
- package/dist/esm/funcs/apisDeleteApi.d.ts +4 -2
- package/dist/esm/funcs/apisDeleteApi.d.ts.map +1 -1
- package/dist/esm/funcs/apisDeleteApi.js +4 -2
- package/dist/esm/funcs/apisDeleteApi.js.map +1 -1
- package/dist/esm/funcs/identitiesCreateIdentity.d.ts +2 -2
- package/dist/esm/funcs/identitiesCreateIdentity.js +2 -2
- package/dist/esm/funcs/keysRerollKey.d.ts +49 -0
- package/dist/esm/funcs/keysRerollKey.d.ts.map +1 -0
- package/dist/esm/funcs/keysRerollKey.js +123 -0
- package/dist/esm/funcs/keysRerollKey.js.map +1 -0
- package/dist/esm/funcs/permissionsListPermissions.d.ts +2 -1
- package/dist/esm/funcs/permissionsListPermissions.d.ts.map +1 -1
- package/dist/esm/funcs/permissionsListPermissions.js +2 -1
- package/dist/esm/funcs/permissionsListPermissions.js.map +1 -1
- package/dist/esm/funcs/permissionsListRoles.d.ts +2 -1
- package/dist/esm/funcs/permissionsListRoles.d.ts.map +1 -1
- package/dist/esm/funcs/permissionsListRoles.js +2 -1
- package/dist/esm/funcs/permissionsListRoles.js.map +1 -1
- package/dist/esm/lib/config.d.ts +3 -3
- package/dist/esm/lib/config.js +3 -3
- package/dist/esm/mcp-server/mcp-server.js +1 -1
- package/dist/esm/mcp-server/server.d.ts.map +1 -1
- package/dist/esm/mcp-server/server.js +3 -1
- package/dist/esm/mcp-server/server.js.map +1 -1
- package/dist/esm/mcp-server/tools/apisDeleteApi.d.ts.map +1 -1
- package/dist/esm/mcp-server/tools/apisDeleteApi.js +4 -2
- package/dist/esm/mcp-server/tools/apisDeleteApi.js.map +1 -1
- package/dist/esm/mcp-server/tools/identitiesCreateIdentity.js +2 -2
- package/dist/esm/mcp-server/tools/identitiesUpdateIdentity.js +2 -2
- package/dist/esm/mcp-server/tools/keysRerollKey.d.ts +8 -0
- package/dist/esm/mcp-server/tools/keysRerollKey.d.ts.map +1 -0
- package/dist/esm/mcp-server/tools/keysRerollKey.js +60 -0
- package/dist/esm/mcp-server/tools/keysRerollKey.js.map +1 -0
- package/dist/esm/mcp-server/tools/permissionsListPermissions.d.ts.map +1 -1
- package/dist/esm/mcp-server/tools/permissionsListPermissions.js +2 -1
- package/dist/esm/mcp-server/tools/permissionsListPermissions.js.map +1 -1
- package/dist/esm/mcp-server/tools/permissionsListRoles.d.ts.map +1 -1
- package/dist/esm/mcp-server/tools/permissionsListRoles.js +2 -1
- package/dist/esm/mcp-server/tools/permissionsListRoles.js.map +1 -1
- package/dist/esm/models/components/identity.d.ts +8 -2
- package/dist/esm/models/components/identity.d.ts.map +1 -1
- package/dist/esm/models/components/identity.js +2 -2
- package/dist/esm/models/components/identity.js.map +1 -1
- package/dist/esm/models/components/index.d.ts +3 -3
- package/dist/esm/models/components/index.d.ts.map +1 -1
- package/dist/esm/models/components/index.js +3 -3
- package/dist/esm/models/components/index.js.map +1 -1
- package/dist/esm/models/components/keyresponsedata.d.ts +0 -5
- package/dist/esm/models/components/keyresponsedata.d.ts.map +1 -1
- package/dist/esm/models/components/keyresponsedata.js +0 -2
- package/dist/esm/models/components/keyresponsedata.js.map +1 -1
- package/dist/esm/models/components/permission.d.ts +1 -1
- package/dist/esm/models/components/v2identitiesgetidentityresponsebody.d.ts +3 -3
- package/dist/esm/models/components/v2identitiesgetidentityresponsebody.d.ts.map +1 -1
- package/dist/esm/models/components/v2identitiesgetidentityresponsebody.js +3 -3
- package/dist/esm/models/components/v2identitiesgetidentityresponsebody.js.map +1 -1
- package/dist/esm/models/components/v2identitiesupdateidentityrequestbody.d.ts +3 -7
- package/dist/esm/models/components/v2identitiesupdateidentityrequestbody.d.ts.map +1 -1
- package/dist/esm/models/components/v2identitiesupdateidentityrequestbody.js +2 -2
- package/dist/esm/models/components/v2identitiesupdateidentityrequestbody.js.map +1 -1
- package/dist/esm/models/components/v2keysaddpermissionsresponsebody.d.ts +0 -1
- package/dist/esm/models/components/v2keysaddpermissionsresponsebody.d.ts.map +1 -1
- package/dist/esm/models/components/v2keysaddpermissionsresponsebody.js.map +1 -1
- package/dist/esm/models/components/v2keysaddrolesresponsebody.d.ts +0 -1
- package/dist/esm/models/components/v2keysaddrolesresponsebody.d.ts.map +1 -1
- package/dist/esm/models/components/v2keysaddrolesresponsebody.js.map +1 -1
- package/dist/esm/models/components/v2keysremoverolesresponsebody.d.ts +0 -1
- package/dist/esm/models/components/v2keysremoverolesresponsebody.d.ts.map +1 -1
- package/dist/esm/models/components/v2keysremoverolesresponsebody.js.map +1 -1
- package/dist/esm/models/components/v2keysrerollkeyrequestbody.d.ts +60 -0
- package/dist/esm/models/components/v2keysrerollkeyrequestbody.d.ts.map +1 -0
- package/dist/esm/models/components/v2keysrerollkeyrequestbody.js +33 -0
- package/dist/esm/models/components/v2keysrerollkeyrequestbody.js.map +1 -0
- package/dist/esm/models/components/v2keysrerollkeyresponsebody.d.ts +36 -0
- package/dist/esm/models/components/v2keysrerollkeyresponsebody.d.ts.map +1 -0
- package/dist/esm/models/components/v2keysrerollkeyresponsebody.js +35 -0
- package/dist/esm/models/components/v2keysrerollkeyresponsebody.js.map +1 -0
- package/dist/esm/models/components/v2keysrerollkeyresponsedata.d.ts +62 -0
- package/dist/esm/models/components/v2keysrerollkeyresponsedata.d.ts.map +1 -0
- package/dist/esm/models/components/v2keysrerollkeyresponsedata.js +33 -0
- package/dist/esm/models/components/v2keysrerollkeyresponsedata.js.map +1 -0
- package/dist/esm/models/components/v2keyssetpermissionsresponsebody.d.ts +0 -1
- package/dist/esm/models/components/v2keyssetpermissionsresponsebody.d.ts.map +1 -1
- package/dist/esm/models/components/v2keyssetpermissionsresponsebody.js.map +1 -1
- package/dist/esm/models/components/v2keyssetrolesresponsebody.d.ts +0 -1
- package/dist/esm/models/components/v2keyssetrolesresponsebody.d.ts.map +1 -1
- package/dist/esm/models/components/v2keyssetrolesresponsebody.js.map +1 -1
- package/dist/esm/models/components/v2permissionsgetpermissionresponsebody.d.ts +3 -6
- package/dist/esm/models/components/v2permissionsgetpermissionresponsebody.d.ts.map +1 -1
- package/dist/esm/models/components/v2permissionsgetpermissionresponsebody.js +3 -3
- package/dist/esm/models/components/v2permissionsgetpermissionresponsebody.js.map +1 -1
- package/dist/esm/models/components/v2permissionsgetroleresponsebody.d.ts +3 -6
- package/dist/esm/models/components/v2permissionsgetroleresponsebody.d.ts.map +1 -1
- package/dist/esm/models/components/v2permissionsgetroleresponsebody.js +3 -3
- package/dist/esm/models/components/v2permissionsgetroleresponsebody.js.map +1 -1
- package/dist/esm/sdk/apis.d.ts +4 -2
- package/dist/esm/sdk/apis.d.ts.map +1 -1
- package/dist/esm/sdk/apis.js +4 -2
- package/dist/esm/sdk/apis.js.map +1 -1
- package/dist/esm/sdk/identities.d.ts +2 -2
- package/dist/esm/sdk/identities.js +2 -2
- package/dist/esm/sdk/keys.d.ts +38 -0
- package/dist/esm/sdk/keys.d.ts.map +1 -1
- package/dist/esm/sdk/keys.js +41 -0
- package/dist/esm/sdk/keys.js.map +1 -1
- package/dist/esm/sdk/permissions.d.ts +4 -2
- package/dist/esm/sdk/permissions.d.ts.map +1 -1
- package/dist/esm/sdk/permissions.js +4 -2
- package/dist/esm/sdk/permissions.js.map +1 -1
- package/docs/sdks/apis/README.md +6 -4
- package/docs/sdks/identities/README.md +6 -6
- package/docs/sdks/keys/README.md +113 -0
- package/docs/sdks/permissions/README.md +4 -2
- package/examples/apisCreateApi.example.ts +1 -1
- package/examples/package-lock.json +3 -3
- package/jsr.json +1 -1
- package/package.json +3 -3
- package/src/funcs/apisDeleteApi.ts +4 -2
- package/src/funcs/identitiesCreateIdentity.ts +2 -2
- package/src/funcs/keysRerollKey.ts +227 -0
- package/src/funcs/permissionsListPermissions.ts +2 -1
- package/src/funcs/permissionsListRoles.ts +2 -1
- package/src/lib/config.ts +3 -3
- package/src/mcp-server/mcp-server.ts +1 -1
- package/src/mcp-server/server.ts +3 -1
- package/src/mcp-server/tools/apisDeleteApi.ts +4 -2
- package/src/mcp-server/tools/identitiesCreateIdentity.ts +2 -2
- package/src/mcp-server/tools/identitiesUpdateIdentity.ts +2 -2
- package/src/mcp-server/tools/keysRerollKey.ts +69 -0
- package/src/mcp-server/tools/permissionsListPermissions.ts +2 -1
- package/src/mcp-server/tools/permissionsListRoles.ts +2 -1
- package/src/models/components/identity.ts +10 -4
- package/src/models/components/index.ts +3 -3
- package/src/models/components/keyresponsedata.ts +0 -7
- package/src/models/components/permission.ts +1 -1
- package/src/models/components/v2identitiesgetidentityresponsebody.ts +10 -10
- package/src/models/components/v2identitiesupdateidentityrequestbody.ts +5 -9
- package/src/models/components/v2keysaddpermissionsresponsebody.ts +0 -1
- package/src/models/components/v2keysaddrolesresponsebody.ts +0 -1
- package/src/models/components/v2keysremoverolesresponsebody.ts +0 -1
- package/src/models/components/v2keysrerollkeyrequestbody.ts +99 -0
- package/src/models/components/v2keysrerollkeyresponsebody.ts +87 -0
- package/src/models/components/v2keysrerollkeyresponsedata.ts +103 -0
- package/src/models/components/v2keyssetpermissionsresponsebody.ts +0 -1
- package/src/models/components/v2keyssetrolesresponsebody.ts +0 -1
- package/src/models/components/v2permissionsgetpermissionresponsebody.ts +9 -12
- package/src/models/components/v2permissionsgetroleresponsebody.ts +9 -12
- package/src/sdk/apis.ts +4 -2
- package/src/sdk/identities.ts +2 -2
- package/src/sdk/keys.ts +49 -0
- package/src/sdk/permissions.ts +4 -2
- package/dist/commonjs/models/components/v2identitiesgetidentityresponsedata.d.ts +0 -47
- package/dist/commonjs/models/components/v2identitiesgetidentityresponsedata.d.ts.map +0 -1
- package/dist/commonjs/models/components/v2identitiesgetidentityresponsedata.js +0 -74
- package/dist/commonjs/models/components/v2identitiesgetidentityresponsedata.js.map +0 -1
- package/dist/commonjs/models/components/v2permissionsgetpermissionresponsedata.d.ts +0 -33
- package/dist/commonjs/models/components/v2permissionsgetpermissionresponsedata.d.ts.map +0 -1
- package/dist/commonjs/models/components/v2permissionsgetpermissionresponsedata.js +0 -70
- package/dist/commonjs/models/components/v2permissionsgetpermissionresponsedata.js.map +0 -1
- package/dist/commonjs/models/components/v2permissionsgetroleresponsedata.d.ts +0 -33
- package/dist/commonjs/models/components/v2permissionsgetroleresponsedata.d.ts.map +0 -1
- package/dist/commonjs/models/components/v2permissionsgetroleresponsedata.js.map +0 -1
- package/dist/esm/models/components/v2identitiesgetidentityresponsedata.d.ts +0 -47
- package/dist/esm/models/components/v2identitiesgetidentityresponsedata.d.ts.map +0 -1
- package/dist/esm/models/components/v2identitiesgetidentityresponsedata.js +0 -36
- package/dist/esm/models/components/v2identitiesgetidentityresponsedata.js.map +0 -1
- package/dist/esm/models/components/v2permissionsgetpermissionresponsedata.d.ts +0 -33
- package/dist/esm/models/components/v2permissionsgetpermissionresponsedata.d.ts.map +0 -1
- package/dist/esm/models/components/v2permissionsgetpermissionresponsedata.js +0 -32
- package/dist/esm/models/components/v2permissionsgetpermissionresponsedata.js.map +0 -1
- package/dist/esm/models/components/v2permissionsgetroleresponsedata.d.ts +0 -33
- package/dist/esm/models/components/v2permissionsgetroleresponsedata.d.ts.map +0 -1
- package/dist/esm/models/components/v2permissionsgetroleresponsedata.js +0 -32
- package/dist/esm/models/components/v2permissionsgetroleresponsedata.js.map +0 -1
- package/src/models/components/v2identitiesgetidentityresponsedata.ts +0 -94
- package/src/models/components/v2permissionsgetpermissionresponsedata.ts +0 -81
- package/src/models/components/v2permissionsgetroleresponsedata.ts +0 -77
|
@@ -32,7 +32,6 @@ export type V2KeysRemoveRolesResponseBody = {
|
|
|
32
32
|
* The response includes:
|
|
33
33
|
* - The remaining roles still assigned to the key (after removing the specified roles)
|
|
34
34
|
* - Both ID and name for each role for easy reference
|
|
35
|
-
* - Roles sorted alphabetically by name for consistent response format
|
|
36
35
|
*
|
|
37
36
|
* Important notes:
|
|
38
37
|
* - The response reflects the current state after the removal operation
|
|
@@ -0,0 +1,99 @@
|
|
|
1
|
+
/*
|
|
2
|
+
* Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
|
|
3
|
+
*/
|
|
4
|
+
|
|
5
|
+
import * as z from "zod";
|
|
6
|
+
import { safeParse } from "../../lib/schemas.js";
|
|
7
|
+
import { Result as SafeParseResult } from "../../types/fp.js";
|
|
8
|
+
import { SDKValidationError } from "../errors/sdkvalidationerror.js";
|
|
9
|
+
|
|
10
|
+
export type V2KeysRerollKeyRequestBody = {
|
|
11
|
+
/**
|
|
12
|
+
* The database identifier of the key to reroll.
|
|
13
|
+
*
|
|
14
|
+
* @remarks
|
|
15
|
+
*
|
|
16
|
+
* This is the unique ID returned when creating or listing keys, NOT the actual API key token.
|
|
17
|
+
* You can find this ID in:
|
|
18
|
+
* - The response from `keys.createKey`
|
|
19
|
+
* - Key verification responses
|
|
20
|
+
* - The Unkey dashboard
|
|
21
|
+
* - API key listing endpoints
|
|
22
|
+
*/
|
|
23
|
+
keyId: string;
|
|
24
|
+
/**
|
|
25
|
+
* Duration in milliseconds until the ORIGINAL key is revoked, starting from now.
|
|
26
|
+
*
|
|
27
|
+
* @remarks
|
|
28
|
+
*
|
|
29
|
+
* This parameter controls the overlap period for key rotation:
|
|
30
|
+
* - Set to `0` to revoke the original key immediately
|
|
31
|
+
* - Positive values keep the original key active for the specified duration
|
|
32
|
+
* - Allows graceful migration by giving users time to update their credentials
|
|
33
|
+
*
|
|
34
|
+
* Common overlap periods:
|
|
35
|
+
* - Immediate revocation: 0
|
|
36
|
+
* - 1 hour grace period: 3600000
|
|
37
|
+
* - 24 hours grace period: 86400000
|
|
38
|
+
* - 7 days grace period: 604800000
|
|
39
|
+
* - 30 days grace period: 2592000000
|
|
40
|
+
*/
|
|
41
|
+
expiration: number;
|
|
42
|
+
};
|
|
43
|
+
|
|
44
|
+
/** @internal */
|
|
45
|
+
export const V2KeysRerollKeyRequestBody$inboundSchema: z.ZodType<
|
|
46
|
+
V2KeysRerollKeyRequestBody,
|
|
47
|
+
z.ZodTypeDef,
|
|
48
|
+
unknown
|
|
49
|
+
> = z.object({
|
|
50
|
+
keyId: z.string(),
|
|
51
|
+
expiration: z.number().int(),
|
|
52
|
+
});
|
|
53
|
+
|
|
54
|
+
/** @internal */
|
|
55
|
+
export type V2KeysRerollKeyRequestBody$Outbound = {
|
|
56
|
+
keyId: string;
|
|
57
|
+
expiration: number;
|
|
58
|
+
};
|
|
59
|
+
|
|
60
|
+
/** @internal */
|
|
61
|
+
export const V2KeysRerollKeyRequestBody$outboundSchema: z.ZodType<
|
|
62
|
+
V2KeysRerollKeyRequestBody$Outbound,
|
|
63
|
+
z.ZodTypeDef,
|
|
64
|
+
V2KeysRerollKeyRequestBody
|
|
65
|
+
> = z.object({
|
|
66
|
+
keyId: z.string(),
|
|
67
|
+
expiration: z.number().int(),
|
|
68
|
+
});
|
|
69
|
+
|
|
70
|
+
/**
|
|
71
|
+
* @internal
|
|
72
|
+
* @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
|
|
73
|
+
*/
|
|
74
|
+
export namespace V2KeysRerollKeyRequestBody$ {
|
|
75
|
+
/** @deprecated use `V2KeysRerollKeyRequestBody$inboundSchema` instead. */
|
|
76
|
+
export const inboundSchema = V2KeysRerollKeyRequestBody$inboundSchema;
|
|
77
|
+
/** @deprecated use `V2KeysRerollKeyRequestBody$outboundSchema` instead. */
|
|
78
|
+
export const outboundSchema = V2KeysRerollKeyRequestBody$outboundSchema;
|
|
79
|
+
/** @deprecated use `V2KeysRerollKeyRequestBody$Outbound` instead. */
|
|
80
|
+
export type Outbound = V2KeysRerollKeyRequestBody$Outbound;
|
|
81
|
+
}
|
|
82
|
+
|
|
83
|
+
export function v2KeysRerollKeyRequestBodyToJSON(
|
|
84
|
+
v2KeysRerollKeyRequestBody: V2KeysRerollKeyRequestBody,
|
|
85
|
+
): string {
|
|
86
|
+
return JSON.stringify(
|
|
87
|
+
V2KeysRerollKeyRequestBody$outboundSchema.parse(v2KeysRerollKeyRequestBody),
|
|
88
|
+
);
|
|
89
|
+
}
|
|
90
|
+
|
|
91
|
+
export function v2KeysRerollKeyRequestBodyFromJSON(
|
|
92
|
+
jsonString: string,
|
|
93
|
+
): SafeParseResult<V2KeysRerollKeyRequestBody, SDKValidationError> {
|
|
94
|
+
return safeParse(
|
|
95
|
+
jsonString,
|
|
96
|
+
(x) => V2KeysRerollKeyRequestBody$inboundSchema.parse(JSON.parse(x)),
|
|
97
|
+
`Failed to parse 'V2KeysRerollKeyRequestBody' from JSON`,
|
|
98
|
+
);
|
|
99
|
+
}
|
|
@@ -0,0 +1,87 @@
|
|
|
1
|
+
/*
|
|
2
|
+
* Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
|
|
3
|
+
*/
|
|
4
|
+
|
|
5
|
+
import * as z from "zod";
|
|
6
|
+
import { safeParse } from "../../lib/schemas.js";
|
|
7
|
+
import { Result as SafeParseResult } from "../../types/fp.js";
|
|
8
|
+
import { SDKValidationError } from "../errors/sdkvalidationerror.js";
|
|
9
|
+
import {
|
|
10
|
+
Meta,
|
|
11
|
+
Meta$inboundSchema,
|
|
12
|
+
Meta$Outbound,
|
|
13
|
+
Meta$outboundSchema,
|
|
14
|
+
} from "./meta.js";
|
|
15
|
+
import {
|
|
16
|
+
V2KeysRerollKeyResponseData,
|
|
17
|
+
V2KeysRerollKeyResponseData$inboundSchema,
|
|
18
|
+
V2KeysRerollKeyResponseData$Outbound,
|
|
19
|
+
V2KeysRerollKeyResponseData$outboundSchema,
|
|
20
|
+
} from "./v2keysrerollkeyresponsedata.js";
|
|
21
|
+
|
|
22
|
+
export type V2KeysRerollKeyResponseBody = {
|
|
23
|
+
/**
|
|
24
|
+
* Metadata object included in every API response. This provides context about the request and is essential for debugging, audit trails, and support inquiries. The `requestId` is particularly important when troubleshooting issues with the Unkey support team.
|
|
25
|
+
*/
|
|
26
|
+
meta: Meta;
|
|
27
|
+
data: V2KeysRerollKeyResponseData;
|
|
28
|
+
};
|
|
29
|
+
|
|
30
|
+
/** @internal */
|
|
31
|
+
export const V2KeysRerollKeyResponseBody$inboundSchema: z.ZodType<
|
|
32
|
+
V2KeysRerollKeyResponseBody,
|
|
33
|
+
z.ZodTypeDef,
|
|
34
|
+
unknown
|
|
35
|
+
> = z.object({
|
|
36
|
+
meta: Meta$inboundSchema,
|
|
37
|
+
data: V2KeysRerollKeyResponseData$inboundSchema,
|
|
38
|
+
});
|
|
39
|
+
|
|
40
|
+
/** @internal */
|
|
41
|
+
export type V2KeysRerollKeyResponseBody$Outbound = {
|
|
42
|
+
meta: Meta$Outbound;
|
|
43
|
+
data: V2KeysRerollKeyResponseData$Outbound;
|
|
44
|
+
};
|
|
45
|
+
|
|
46
|
+
/** @internal */
|
|
47
|
+
export const V2KeysRerollKeyResponseBody$outboundSchema: z.ZodType<
|
|
48
|
+
V2KeysRerollKeyResponseBody$Outbound,
|
|
49
|
+
z.ZodTypeDef,
|
|
50
|
+
V2KeysRerollKeyResponseBody
|
|
51
|
+
> = z.object({
|
|
52
|
+
meta: Meta$outboundSchema,
|
|
53
|
+
data: V2KeysRerollKeyResponseData$outboundSchema,
|
|
54
|
+
});
|
|
55
|
+
|
|
56
|
+
/**
|
|
57
|
+
* @internal
|
|
58
|
+
* @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
|
|
59
|
+
*/
|
|
60
|
+
export namespace V2KeysRerollKeyResponseBody$ {
|
|
61
|
+
/** @deprecated use `V2KeysRerollKeyResponseBody$inboundSchema` instead. */
|
|
62
|
+
export const inboundSchema = V2KeysRerollKeyResponseBody$inboundSchema;
|
|
63
|
+
/** @deprecated use `V2KeysRerollKeyResponseBody$outboundSchema` instead. */
|
|
64
|
+
export const outboundSchema = V2KeysRerollKeyResponseBody$outboundSchema;
|
|
65
|
+
/** @deprecated use `V2KeysRerollKeyResponseBody$Outbound` instead. */
|
|
66
|
+
export type Outbound = V2KeysRerollKeyResponseBody$Outbound;
|
|
67
|
+
}
|
|
68
|
+
|
|
69
|
+
export function v2KeysRerollKeyResponseBodyToJSON(
|
|
70
|
+
v2KeysRerollKeyResponseBody: V2KeysRerollKeyResponseBody,
|
|
71
|
+
): string {
|
|
72
|
+
return JSON.stringify(
|
|
73
|
+
V2KeysRerollKeyResponseBody$outboundSchema.parse(
|
|
74
|
+
v2KeysRerollKeyResponseBody,
|
|
75
|
+
),
|
|
76
|
+
);
|
|
77
|
+
}
|
|
78
|
+
|
|
79
|
+
export function v2KeysRerollKeyResponseBodyFromJSON(
|
|
80
|
+
jsonString: string,
|
|
81
|
+
): SafeParseResult<V2KeysRerollKeyResponseBody, SDKValidationError> {
|
|
82
|
+
return safeParse(
|
|
83
|
+
jsonString,
|
|
84
|
+
(x) => V2KeysRerollKeyResponseBody$inboundSchema.parse(JSON.parse(x)),
|
|
85
|
+
`Failed to parse 'V2KeysRerollKeyResponseBody' from JSON`,
|
|
86
|
+
);
|
|
87
|
+
}
|
|
@@ -0,0 +1,103 @@
|
|
|
1
|
+
/*
|
|
2
|
+
* Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
|
|
3
|
+
*/
|
|
4
|
+
|
|
5
|
+
import * as z from "zod";
|
|
6
|
+
import { safeParse } from "../../lib/schemas.js";
|
|
7
|
+
import { Result as SafeParseResult } from "../../types/fp.js";
|
|
8
|
+
import { SDKValidationError } from "../errors/sdkvalidationerror.js";
|
|
9
|
+
|
|
10
|
+
export type V2KeysRerollKeyResponseData = {
|
|
11
|
+
/**
|
|
12
|
+
* The unique identifier for the newly created key.
|
|
13
|
+
*
|
|
14
|
+
* @remarks
|
|
15
|
+
*
|
|
16
|
+
* This is NOT the actual API key token, but a reference ID for management operations.
|
|
17
|
+
* Store this ID to:
|
|
18
|
+
* - Update or revoke the key later
|
|
19
|
+
* - Track the key in your database
|
|
20
|
+
* - Display in admin dashboards (safe to log)
|
|
21
|
+
*
|
|
22
|
+
* Note: This is a new ID - the original key retains its own ID.
|
|
23
|
+
*/
|
|
24
|
+
keyId: string;
|
|
25
|
+
/**
|
|
26
|
+
* The newly generated API key token (the actual secret that authenticates requests).
|
|
27
|
+
*
|
|
28
|
+
* @remarks
|
|
29
|
+
*
|
|
30
|
+
* **SECURITY CRITICAL:**
|
|
31
|
+
* - This is the only time you'll receive the complete key
|
|
32
|
+
* - Unkey stores only a hashed version (unless the original key was created with `recoverable=true`)
|
|
33
|
+
* - Never log, store, or expose this value in your systems
|
|
34
|
+
* - Transmit directly to the end user via secure channels only
|
|
35
|
+
* - If lost and not recoverable, you must reroll or create a new key
|
|
36
|
+
*
|
|
37
|
+
* The key format follows: `[prefix]_[random_bytes]`
|
|
38
|
+
* - Prefix is extracted from the original key or uses API default
|
|
39
|
+
* - Random bytes follow API configuration (default: 16 bytes)
|
|
40
|
+
*
|
|
41
|
+
* This is NOT the keyId - it's the actual secret token used for authentication.
|
|
42
|
+
*/
|
|
43
|
+
key: string;
|
|
44
|
+
};
|
|
45
|
+
|
|
46
|
+
/** @internal */
|
|
47
|
+
export const V2KeysRerollKeyResponseData$inboundSchema: z.ZodType<
|
|
48
|
+
V2KeysRerollKeyResponseData,
|
|
49
|
+
z.ZodTypeDef,
|
|
50
|
+
unknown
|
|
51
|
+
> = z.object({
|
|
52
|
+
keyId: z.string(),
|
|
53
|
+
key: z.string(),
|
|
54
|
+
});
|
|
55
|
+
|
|
56
|
+
/** @internal */
|
|
57
|
+
export type V2KeysRerollKeyResponseData$Outbound = {
|
|
58
|
+
keyId: string;
|
|
59
|
+
key: string;
|
|
60
|
+
};
|
|
61
|
+
|
|
62
|
+
/** @internal */
|
|
63
|
+
export const V2KeysRerollKeyResponseData$outboundSchema: z.ZodType<
|
|
64
|
+
V2KeysRerollKeyResponseData$Outbound,
|
|
65
|
+
z.ZodTypeDef,
|
|
66
|
+
V2KeysRerollKeyResponseData
|
|
67
|
+
> = z.object({
|
|
68
|
+
keyId: z.string(),
|
|
69
|
+
key: z.string(),
|
|
70
|
+
});
|
|
71
|
+
|
|
72
|
+
/**
|
|
73
|
+
* @internal
|
|
74
|
+
* @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
|
|
75
|
+
*/
|
|
76
|
+
export namespace V2KeysRerollKeyResponseData$ {
|
|
77
|
+
/** @deprecated use `V2KeysRerollKeyResponseData$inboundSchema` instead. */
|
|
78
|
+
export const inboundSchema = V2KeysRerollKeyResponseData$inboundSchema;
|
|
79
|
+
/** @deprecated use `V2KeysRerollKeyResponseData$outboundSchema` instead. */
|
|
80
|
+
export const outboundSchema = V2KeysRerollKeyResponseData$outboundSchema;
|
|
81
|
+
/** @deprecated use `V2KeysRerollKeyResponseData$Outbound` instead. */
|
|
82
|
+
export type Outbound = V2KeysRerollKeyResponseData$Outbound;
|
|
83
|
+
}
|
|
84
|
+
|
|
85
|
+
export function v2KeysRerollKeyResponseDataToJSON(
|
|
86
|
+
v2KeysRerollKeyResponseData: V2KeysRerollKeyResponseData,
|
|
87
|
+
): string {
|
|
88
|
+
return JSON.stringify(
|
|
89
|
+
V2KeysRerollKeyResponseData$outboundSchema.parse(
|
|
90
|
+
v2KeysRerollKeyResponseData,
|
|
91
|
+
),
|
|
92
|
+
);
|
|
93
|
+
}
|
|
94
|
+
|
|
95
|
+
export function v2KeysRerollKeyResponseDataFromJSON(
|
|
96
|
+
jsonString: string,
|
|
97
|
+
): SafeParseResult<V2KeysRerollKeyResponseData, SDKValidationError> {
|
|
98
|
+
return safeParse(
|
|
99
|
+
jsonString,
|
|
100
|
+
(x) => V2KeysRerollKeyResponseData$inboundSchema.parse(JSON.parse(x)),
|
|
101
|
+
`Failed to parse 'V2KeysRerollKeyResponseData' from JSON`,
|
|
102
|
+
);
|
|
103
|
+
}
|
|
@@ -32,7 +32,6 @@ export type V2KeysSetPermissionsResponseBody = {
|
|
|
32
32
|
* The response includes:
|
|
33
33
|
* - The comprehensive, updated set of direct permissions (reflecting the complete replacement)
|
|
34
34
|
* - Both ID and name for each permission for easy reference
|
|
35
|
-
* - Permissions sorted alphabetically by name for consistent response format
|
|
36
35
|
*
|
|
37
36
|
* Important notes:
|
|
38
37
|
* - This only shows direct permissions, not those granted through roles
|
|
@@ -32,7 +32,6 @@ export type V2KeysSetRolesResponseBody = {
|
|
|
32
32
|
* The response includes:
|
|
33
33
|
* - The comprehensive, updated set of roles (reflecting the complete replacement)
|
|
34
34
|
* - Both ID and name for each role for easy reference
|
|
35
|
-
* - Roles sorted alphabetically by name for consistent response format
|
|
36
35
|
*
|
|
37
36
|
* Important notes:
|
|
38
37
|
* - This response shows the final state after the complete replacement
|
|
@@ -13,21 +13,18 @@ import {
|
|
|
13
13
|
Meta$outboundSchema,
|
|
14
14
|
} from "./meta.js";
|
|
15
15
|
import {
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
} from "./
|
|
16
|
+
Permission,
|
|
17
|
+
Permission$inboundSchema,
|
|
18
|
+
Permission$Outbound,
|
|
19
|
+
Permission$outboundSchema,
|
|
20
|
+
} from "./permission.js";
|
|
21
21
|
|
|
22
22
|
export type V2PermissionsGetPermissionResponseBody = {
|
|
23
23
|
/**
|
|
24
24
|
* Metadata object included in every API response. This provides context about the request and is essential for debugging, audit trails, and support inquiries. The `requestId` is particularly important when troubleshooting issues with the Unkey support team.
|
|
25
25
|
*/
|
|
26
26
|
meta: Meta;
|
|
27
|
-
|
|
28
|
-
* Complete permission details including ID, name, and metadata.
|
|
29
|
-
*/
|
|
30
|
-
data: V2PermissionsGetPermissionResponseData;
|
|
27
|
+
data: Permission;
|
|
31
28
|
};
|
|
32
29
|
|
|
33
30
|
/** @internal */
|
|
@@ -37,13 +34,13 @@ export const V2PermissionsGetPermissionResponseBody$inboundSchema: z.ZodType<
|
|
|
37
34
|
unknown
|
|
38
35
|
> = z.object({
|
|
39
36
|
meta: Meta$inboundSchema,
|
|
40
|
-
data:
|
|
37
|
+
data: Permission$inboundSchema,
|
|
41
38
|
});
|
|
42
39
|
|
|
43
40
|
/** @internal */
|
|
44
41
|
export type V2PermissionsGetPermissionResponseBody$Outbound = {
|
|
45
42
|
meta: Meta$Outbound;
|
|
46
|
-
data:
|
|
43
|
+
data: Permission$Outbound;
|
|
47
44
|
};
|
|
48
45
|
|
|
49
46
|
/** @internal */
|
|
@@ -53,7 +50,7 @@ export const V2PermissionsGetPermissionResponseBody$outboundSchema: z.ZodType<
|
|
|
53
50
|
V2PermissionsGetPermissionResponseBody
|
|
54
51
|
> = z.object({
|
|
55
52
|
meta: Meta$outboundSchema,
|
|
56
|
-
data:
|
|
53
|
+
data: Permission$outboundSchema,
|
|
57
54
|
});
|
|
58
55
|
|
|
59
56
|
/**
|
|
@@ -13,21 +13,18 @@ import {
|
|
|
13
13
|
Meta$outboundSchema,
|
|
14
14
|
} from "./meta.js";
|
|
15
15
|
import {
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
} from "./
|
|
16
|
+
Role,
|
|
17
|
+
Role$inboundSchema,
|
|
18
|
+
Role$Outbound,
|
|
19
|
+
Role$outboundSchema,
|
|
20
|
+
} from "./role.js";
|
|
21
21
|
|
|
22
22
|
export type V2PermissionsGetRoleResponseBody = {
|
|
23
23
|
/**
|
|
24
24
|
* Metadata object included in every API response. This provides context about the request and is essential for debugging, audit trails, and support inquiries. The `requestId` is particularly important when troubleshooting issues with the Unkey support team.
|
|
25
25
|
*/
|
|
26
26
|
meta: Meta;
|
|
27
|
-
|
|
28
|
-
* Complete role details including assigned permissions.
|
|
29
|
-
*/
|
|
30
|
-
data: V2PermissionsGetRoleResponseData;
|
|
27
|
+
data: Role;
|
|
31
28
|
};
|
|
32
29
|
|
|
33
30
|
/** @internal */
|
|
@@ -37,13 +34,13 @@ export const V2PermissionsGetRoleResponseBody$inboundSchema: z.ZodType<
|
|
|
37
34
|
unknown
|
|
38
35
|
> = z.object({
|
|
39
36
|
meta: Meta$inboundSchema,
|
|
40
|
-
data:
|
|
37
|
+
data: Role$inboundSchema,
|
|
41
38
|
});
|
|
42
39
|
|
|
43
40
|
/** @internal */
|
|
44
41
|
export type V2PermissionsGetRoleResponseBody$Outbound = {
|
|
45
42
|
meta: Meta$Outbound;
|
|
46
|
-
data:
|
|
43
|
+
data: Role$Outbound;
|
|
47
44
|
};
|
|
48
45
|
|
|
49
46
|
/** @internal */
|
|
@@ -53,7 +50,7 @@ export const V2PermissionsGetRoleResponseBody$outboundSchema: z.ZodType<
|
|
|
53
50
|
V2PermissionsGetRoleResponseBody
|
|
54
51
|
> = z.object({
|
|
55
52
|
meta: Meta$outboundSchema,
|
|
56
|
-
data:
|
|
53
|
+
data: Role$outboundSchema,
|
|
57
54
|
});
|
|
58
55
|
|
|
59
56
|
/**
|
package/src/sdk/apis.ts
CHANGED
|
@@ -43,9 +43,11 @@ export class Apis extends ClientSDK {
|
|
|
43
43
|
* @remarks
|
|
44
44
|
* Permanently delete an API namespace and immediately invalidate all associated keys.
|
|
45
45
|
*
|
|
46
|
-
* Use this for cleaning up development environments, retiring deprecated services, or removing unused resources.
|
|
46
|
+
* Use this for cleaning up development environments, retiring deprecated services, or removing unused resources.
|
|
47
|
+
* All keys in the namespace are immediately marked as deleted and will fail verification with `code=NOT_FOUND`.
|
|
47
48
|
*
|
|
48
|
-
* **Important**: This operation is immediate and permanent. Verify you have the correct API ID before deletion.
|
|
49
|
+
* **Important**: This operation is immediate and permanent. Verify you have the correct API ID before deletion.
|
|
50
|
+
* If delete protection is enabled, disable it first through the dashboard or API configuration.
|
|
49
51
|
*
|
|
50
52
|
* **Required Permissions**
|
|
51
53
|
*
|
package/src/sdk/identities.ts
CHANGED
|
@@ -22,8 +22,8 @@ export class Identities extends ClientSDK {
|
|
|
22
22
|
*
|
|
23
23
|
* Perfect for users with multiple devices, organizations with multiple API keys, or when you need unified rate limiting across different services.
|
|
24
24
|
*
|
|
25
|
-
*
|
|
26
|
-
*
|
|
25
|
+
* **Important**
|
|
26
|
+
* Requires `identity.*.create_identity` permission
|
|
27
27
|
*/
|
|
28
28
|
async createIdentity(
|
|
29
29
|
request: components.V2IdentitiesCreateIdentityRequestBody,
|
package/src/sdk/keys.ts
CHANGED
|
@@ -9,6 +9,7 @@ import { keysDeleteKey } from "../funcs/keysDeleteKey.js";
|
|
|
9
9
|
import { keysGetKey } from "../funcs/keysGetKey.js";
|
|
10
10
|
import { keysRemovePermissions } from "../funcs/keysRemovePermissions.js";
|
|
11
11
|
import { keysRemoveRoles } from "../funcs/keysRemoveRoles.js";
|
|
12
|
+
import { keysRerollKey } from "../funcs/keysRerollKey.js";
|
|
12
13
|
import { keysSetPermissions } from "../funcs/keysSetPermissions.js";
|
|
13
14
|
import { keysSetRoles } from "../funcs/keysSetRoles.js";
|
|
14
15
|
import { keysUpdateCredits } from "../funcs/keysUpdateCredits.js";
|
|
@@ -233,6 +234,54 @@ export class Keys extends ClientSDK {
|
|
|
233
234
|
));
|
|
234
235
|
}
|
|
235
236
|
|
|
237
|
+
/**
|
|
238
|
+
* Reroll Key
|
|
239
|
+
*
|
|
240
|
+
* @remarks
|
|
241
|
+
* Generate a new API key while preserving the configuration from an existing key.
|
|
242
|
+
*
|
|
243
|
+
* This operation creates a fresh key with a new token while maintaining all settings from the original key:
|
|
244
|
+
* - Permissions and roles
|
|
245
|
+
* - Custom metadata
|
|
246
|
+
* - Rate limit configurations
|
|
247
|
+
* - Identity associations
|
|
248
|
+
* - Remaining credits
|
|
249
|
+
* - Recovery settings
|
|
250
|
+
*
|
|
251
|
+
* **Key Generation:**
|
|
252
|
+
* - The system attempts to extract the prefix from the original key
|
|
253
|
+
* - If prefix extraction fails, the default API prefix is used
|
|
254
|
+
* - Key length follows the API's default byte configuration (or 16 bytes if not specified)
|
|
255
|
+
*
|
|
256
|
+
* **Original Key Handling:**
|
|
257
|
+
* - The original key will be revoked after the duration specified in `expiration`
|
|
258
|
+
* - Set `expiration` to 0 to revoke immediately
|
|
259
|
+
* - This allows for graceful key rotation with an overlap period
|
|
260
|
+
*
|
|
261
|
+
* Common use cases include:
|
|
262
|
+
* - Rotating keys for security compliance
|
|
263
|
+
* - Issuing replacement keys for compromised credentials
|
|
264
|
+
* - Creating backup keys with identical permissions
|
|
265
|
+
*
|
|
266
|
+
* **Important:** Analytics and usage metrics are tracked at both the key level AND identity level. If the original key has an identity, the new key will inherit it, allowing you to track usage across both individual keys and the overall identity.
|
|
267
|
+
*
|
|
268
|
+
* **Required Permissions**
|
|
269
|
+
*
|
|
270
|
+
* Your root key must have:
|
|
271
|
+
* - `api.*.create_key` or `api.<api_id>.create_key`
|
|
272
|
+
* - `api.*.encrypt_key` or `api.<api_id>.encrypt_key` (only when the original key is recoverable)
|
|
273
|
+
*/
|
|
274
|
+
async rerollKey(
|
|
275
|
+
request: components.V2KeysRerollKeyRequestBody,
|
|
276
|
+
options?: RequestOptions,
|
|
277
|
+
): Promise<components.V2KeysRerollKeyResponseBody> {
|
|
278
|
+
return unwrapAsync(keysRerollKey(
|
|
279
|
+
this,
|
|
280
|
+
request,
|
|
281
|
+
options,
|
|
282
|
+
));
|
|
283
|
+
}
|
|
284
|
+
|
|
236
285
|
/**
|
|
237
286
|
* Set key permissions
|
|
238
287
|
*
|
package/src/sdk/permissions.ts
CHANGED
|
@@ -161,7 +161,8 @@ export class Permissions extends ClientSDK {
|
|
|
161
161
|
* List permissions
|
|
162
162
|
*
|
|
163
163
|
* @remarks
|
|
164
|
-
* Retrieve all permissions in your workspace.
|
|
164
|
+
* Retrieve all permissions in your workspace.
|
|
165
|
+
* Results are paginated and sorted by their id.
|
|
165
166
|
*
|
|
166
167
|
* **Required Permissions**
|
|
167
168
|
*
|
|
@@ -183,7 +184,8 @@ export class Permissions extends ClientSDK {
|
|
|
183
184
|
* List roles
|
|
184
185
|
*
|
|
185
186
|
* @remarks
|
|
186
|
-
* Retrieve all roles in your workspace including their assigned permissions.
|
|
187
|
+
* Retrieve all roles in your workspace including their assigned permissions.
|
|
188
|
+
* Results are paginated and sorted by their id.
|
|
187
189
|
*
|
|
188
190
|
* **Required Permissions**
|
|
189
191
|
*
|
|
@@ -1,47 +0,0 @@
|
|
|
1
|
-
import * as z from "zod";
|
|
2
|
-
import { Result as SafeParseResult } from "../../types/fp.js";
|
|
3
|
-
import { SDKValidationError } from "../errors/sdkvalidationerror.js";
|
|
4
|
-
import { RatelimitResponse, RatelimitResponse$Outbound } from "./ratelimitresponse.js";
|
|
5
|
-
export type V2IdentitiesGetIdentityResponseData = {
|
|
6
|
-
/**
|
|
7
|
-
* The external identifier for this identity in your system. This is the ID you provided during identity creation.
|
|
8
|
-
*/
|
|
9
|
-
externalId: string;
|
|
10
|
-
/**
|
|
11
|
-
* Custom metadata associated with this identity. This can include any JSON-serializable data you stored with the identity during creation or updates.
|
|
12
|
-
*/
|
|
13
|
-
meta?: {
|
|
14
|
-
[k: string]: any;
|
|
15
|
-
} | undefined;
|
|
16
|
-
/**
|
|
17
|
-
* Rate limits associated with this identity. These limits are shared across all API keys linked to this identity, providing consistent rate limiting regardless of which key is used.
|
|
18
|
-
*/
|
|
19
|
-
ratelimits?: Array<RatelimitResponse> | undefined;
|
|
20
|
-
};
|
|
21
|
-
/** @internal */
|
|
22
|
-
export declare const V2IdentitiesGetIdentityResponseData$inboundSchema: z.ZodType<V2IdentitiesGetIdentityResponseData, z.ZodTypeDef, unknown>;
|
|
23
|
-
/** @internal */
|
|
24
|
-
export type V2IdentitiesGetIdentityResponseData$Outbound = {
|
|
25
|
-
externalId: string;
|
|
26
|
-
meta?: {
|
|
27
|
-
[k: string]: any;
|
|
28
|
-
} | undefined;
|
|
29
|
-
ratelimits?: Array<RatelimitResponse$Outbound> | undefined;
|
|
30
|
-
};
|
|
31
|
-
/** @internal */
|
|
32
|
-
export declare const V2IdentitiesGetIdentityResponseData$outboundSchema: z.ZodType<V2IdentitiesGetIdentityResponseData$Outbound, z.ZodTypeDef, V2IdentitiesGetIdentityResponseData>;
|
|
33
|
-
/**
|
|
34
|
-
* @internal
|
|
35
|
-
* @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
|
|
36
|
-
*/
|
|
37
|
-
export declare namespace V2IdentitiesGetIdentityResponseData$ {
|
|
38
|
-
/** @deprecated use `V2IdentitiesGetIdentityResponseData$inboundSchema` instead. */
|
|
39
|
-
const inboundSchema: z.ZodType<V2IdentitiesGetIdentityResponseData, z.ZodTypeDef, unknown>;
|
|
40
|
-
/** @deprecated use `V2IdentitiesGetIdentityResponseData$outboundSchema` instead. */
|
|
41
|
-
const outboundSchema: z.ZodType<V2IdentitiesGetIdentityResponseData$Outbound, z.ZodTypeDef, V2IdentitiesGetIdentityResponseData>;
|
|
42
|
-
/** @deprecated use `V2IdentitiesGetIdentityResponseData$Outbound` instead. */
|
|
43
|
-
type Outbound = V2IdentitiesGetIdentityResponseData$Outbound;
|
|
44
|
-
}
|
|
45
|
-
export declare function v2IdentitiesGetIdentityResponseDataToJSON(v2IdentitiesGetIdentityResponseData: V2IdentitiesGetIdentityResponseData): string;
|
|
46
|
-
export declare function v2IdentitiesGetIdentityResponseDataFromJSON(jsonString: string): SafeParseResult<V2IdentitiesGetIdentityResponseData, SDKValidationError>;
|
|
47
|
-
//# sourceMappingURL=v2identitiesgetidentityresponsedata.d.ts.map
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"v2identitiesgetidentityresponsedata.d.ts","sourceRoot":"","sources":["../../../../src/models/components/v2identitiesgetidentityresponsedata.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,CAAC,MAAM,KAAK,CAAC;AAEzB,OAAO,EAAE,MAAM,IAAI,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAC9D,OAAO,EAAE,kBAAkB,EAAE,MAAM,iCAAiC,CAAC;AACrE,OAAO,EACL,iBAAiB,EAEjB,0BAA0B,EAE3B,MAAM,wBAAwB,CAAC;AAEhC,MAAM,MAAM,mCAAmC,GAAG;IAChD;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IACnB;;OAEG;IACH,IAAI,CAAC,EAAE;QAAE,CAAC,CAAC,EAAE,MAAM,GAAG,GAAG,CAAA;KAAE,GAAG,SAAS,CAAC;IACxC;;OAEG;IACH,UAAU,CAAC,EAAE,KAAK,CAAC,iBAAiB,CAAC,GAAG,SAAS,CAAC;CACnD,CAAC;AAEF,gBAAgB;AAChB,eAAO,MAAM,iDAAiD,EAAE,CAAC,CAAC,OAAO,CACvE,mCAAmC,EACnC,CAAC,CAAC,UAAU,EACZ,OAAO,CAKP,CAAC;AAEH,gBAAgB;AAChB,MAAM,MAAM,4CAA4C,GAAG;IACzD,UAAU,EAAE,MAAM,CAAC;IACnB,IAAI,CAAC,EAAE;QAAE,CAAC,CAAC,EAAE,MAAM,GAAG,GAAG,CAAA;KAAE,GAAG,SAAS,CAAC;IACxC,UAAU,CAAC,EAAE,KAAK,CAAC,0BAA0B,CAAC,GAAG,SAAS,CAAC;CAC5D,CAAC;AAEF,gBAAgB;AAChB,eAAO,MAAM,kDAAkD,EAAE,CAAC,CAAC,OAAO,CACxE,4CAA4C,EAC5C,CAAC,CAAC,UAAU,EACZ,mCAAmC,CAKnC,CAAC;AAEH;;;GAGG;AACH,yBAAiB,oCAAoC,CAAC;IACpD,mFAAmF;IAC5E,MAAM,aAAa,uEACyB,CAAC;IACpD,oFAAoF;IAC7E,MAAM,cAAc,4GACyB,CAAC;IACrD,8EAA8E;IAC9E,KAAY,QAAQ,GAAG,4CAA4C,CAAC;CACrE;AAED,wBAAgB,yCAAyC,CACvD,mCAAmC,EAAE,mCAAmC,GACvE,MAAM,CAMR;AAED,wBAAgB,2CAA2C,CACzD,UAAU,EAAE,MAAM,GACjB,eAAe,CAAC,mCAAmC,EAAE,kBAAkB,CAAC,CAO1E"}
|
|
@@ -1,74 +0,0 @@
|
|
|
1
|
-
"use strict";
|
|
2
|
-
/*
|
|
3
|
-
* Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
|
|
4
|
-
*/
|
|
5
|
-
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
|
|
6
|
-
if (k2 === undefined) k2 = k;
|
|
7
|
-
var desc = Object.getOwnPropertyDescriptor(m, k);
|
|
8
|
-
if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
|
|
9
|
-
desc = { enumerable: true, get: function() { return m[k]; } };
|
|
10
|
-
}
|
|
11
|
-
Object.defineProperty(o, k2, desc);
|
|
12
|
-
}) : (function(o, m, k, k2) {
|
|
13
|
-
if (k2 === undefined) k2 = k;
|
|
14
|
-
o[k2] = m[k];
|
|
15
|
-
}));
|
|
16
|
-
var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
|
|
17
|
-
Object.defineProperty(o, "default", { enumerable: true, value: v });
|
|
18
|
-
}) : function(o, v) {
|
|
19
|
-
o["default"] = v;
|
|
20
|
-
});
|
|
21
|
-
var __importStar = (this && this.__importStar) || (function () {
|
|
22
|
-
var ownKeys = function(o) {
|
|
23
|
-
ownKeys = Object.getOwnPropertyNames || function (o) {
|
|
24
|
-
var ar = [];
|
|
25
|
-
for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
|
|
26
|
-
return ar;
|
|
27
|
-
};
|
|
28
|
-
return ownKeys(o);
|
|
29
|
-
};
|
|
30
|
-
return function (mod) {
|
|
31
|
-
if (mod && mod.__esModule) return mod;
|
|
32
|
-
var result = {};
|
|
33
|
-
if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
|
|
34
|
-
__setModuleDefault(result, mod);
|
|
35
|
-
return result;
|
|
36
|
-
};
|
|
37
|
-
})();
|
|
38
|
-
Object.defineProperty(exports, "__esModule", { value: true });
|
|
39
|
-
exports.V2IdentitiesGetIdentityResponseData$ = exports.V2IdentitiesGetIdentityResponseData$outboundSchema = exports.V2IdentitiesGetIdentityResponseData$inboundSchema = void 0;
|
|
40
|
-
exports.v2IdentitiesGetIdentityResponseDataToJSON = v2IdentitiesGetIdentityResponseDataToJSON;
|
|
41
|
-
exports.v2IdentitiesGetIdentityResponseDataFromJSON = v2IdentitiesGetIdentityResponseDataFromJSON;
|
|
42
|
-
const z = __importStar(require("zod"));
|
|
43
|
-
const schemas_js_1 = require("../../lib/schemas.js");
|
|
44
|
-
const ratelimitresponse_js_1 = require("./ratelimitresponse.js");
|
|
45
|
-
/** @internal */
|
|
46
|
-
exports.V2IdentitiesGetIdentityResponseData$inboundSchema = z.object({
|
|
47
|
-
externalId: z.string(),
|
|
48
|
-
meta: z.record(z.any()).optional(),
|
|
49
|
-
ratelimits: z.array(ratelimitresponse_js_1.RatelimitResponse$inboundSchema).optional(),
|
|
50
|
-
});
|
|
51
|
-
/** @internal */
|
|
52
|
-
exports.V2IdentitiesGetIdentityResponseData$outboundSchema = z.object({
|
|
53
|
-
externalId: z.string(),
|
|
54
|
-
meta: z.record(z.any()).optional(),
|
|
55
|
-
ratelimits: z.array(ratelimitresponse_js_1.RatelimitResponse$outboundSchema).optional(),
|
|
56
|
-
});
|
|
57
|
-
/**
|
|
58
|
-
* @internal
|
|
59
|
-
* @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
|
|
60
|
-
*/
|
|
61
|
-
var V2IdentitiesGetIdentityResponseData$;
|
|
62
|
-
(function (V2IdentitiesGetIdentityResponseData$) {
|
|
63
|
-
/** @deprecated use `V2IdentitiesGetIdentityResponseData$inboundSchema` instead. */
|
|
64
|
-
V2IdentitiesGetIdentityResponseData$.inboundSchema = exports.V2IdentitiesGetIdentityResponseData$inboundSchema;
|
|
65
|
-
/** @deprecated use `V2IdentitiesGetIdentityResponseData$outboundSchema` instead. */
|
|
66
|
-
V2IdentitiesGetIdentityResponseData$.outboundSchema = exports.V2IdentitiesGetIdentityResponseData$outboundSchema;
|
|
67
|
-
})(V2IdentitiesGetIdentityResponseData$ || (exports.V2IdentitiesGetIdentityResponseData$ = V2IdentitiesGetIdentityResponseData$ = {}));
|
|
68
|
-
function v2IdentitiesGetIdentityResponseDataToJSON(v2IdentitiesGetIdentityResponseData) {
|
|
69
|
-
return JSON.stringify(exports.V2IdentitiesGetIdentityResponseData$outboundSchema.parse(v2IdentitiesGetIdentityResponseData));
|
|
70
|
-
}
|
|
71
|
-
function v2IdentitiesGetIdentityResponseDataFromJSON(jsonString) {
|
|
72
|
-
return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.V2IdentitiesGetIdentityResponseData$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'V2IdentitiesGetIdentityResponseData' from JSON`);
|
|
73
|
-
}
|
|
74
|
-
//# sourceMappingURL=v2identitiesgetidentityresponsedata.js.map
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"v2identitiesgetidentityresponsedata.js","sourceRoot":"","sources":["../../../../src/models/components/v2identitiesgetidentityresponsedata.ts"],"names":[],"mappings":";AAAA;;GAEG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAwEH,8FAQC;AAED,kGASC;AAzFD,uCAAyB;AACzB,qDAAiD;AAGjD,iEAKgC;AAiBhC,gBAAgB;AACH,QAAA,iDAAiD,GAI1D,CAAC,CAAC,MAAM,CAAC;IACX,UAAU,EAAE,CAAC,CAAC,MAAM,EAAE;IACtB,IAAI,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,GAAG,EAAE,CAAC,CAAC,QAAQ,EAAE;IAClC,UAAU,EAAE,CAAC,CAAC,KAAK,CAAC,sDAA+B,CAAC,CAAC,QAAQ,EAAE;CAChE,CAAC,CAAC;AASH,gBAAgB;AACH,QAAA,kDAAkD,GAI3D,CAAC,CAAC,MAAM,CAAC;IACX,UAAU,EAAE,CAAC,CAAC,MAAM,EAAE;IACtB,IAAI,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,GAAG,EAAE,CAAC,CAAC,QAAQ,EAAE;IAClC,UAAU,EAAE,CAAC,CAAC,KAAK,CAAC,uDAAgC,CAAC,CAAC,QAAQ,EAAE;CACjE,CAAC,CAAC;AAEH;;;GAGG;AACH,IAAiB,oCAAoC,CASpD;AATD,WAAiB,oCAAoC;IACnD,mFAAmF;IACtE,kDAAa,GACxB,yDAAiD,CAAC;IACpD,oFAAoF;IACvE,mDAAc,GACzB,0DAAkD,CAAC;AAGvD,CAAC,EATgB,oCAAoC,oDAApC,oCAAoC,QASpD;AAED,SAAgB,yCAAyC,CACvD,mCAAwE;IAExE,OAAO,IAAI,CAAC,SAAS,CACnB,0DAAkD,CAAC,KAAK,CACtD,mCAAmC,CACpC,CACF,CAAC;AACJ,CAAC;AAED,SAAgB,2CAA2C,CACzD,UAAkB;IAElB,OAAO,IAAA,sBAAS,EACd,UAAU,EACV,CAAC,CAAC,EAAE,EAAE,CACJ,yDAAiD,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EACxE,iEAAiE,CAClE,CAAC;AACJ,CAAC"}
|