Breaking changes
- Project management renames: We've renamed project data to 'snapshot' - and made the related functions clearer this way:
projectExport
>projectExportSnapshot
projectImport
>projectImportSnapshot
projectImportValidate
>projectValidateSnapshot
- managementcli's new home: We opened a dedicated repo for management CLI - https://github.com/descope/descopecli - so we removed any leftovers from this SDK. Check it out, and don't forget to star it! ⭐
Enhancements
- Update User's OAuth login ID: With the
OAuth.UpdateUser
function, you can mimic the existing flow action step to update your user's login IDs with their authenticated OAuth account. - Custom claims for access keys: You can define custom claims that will be added upon creation or exchange of access key tokens. See our example on how to use it in the exchange process in our README.
- Search over roles: We've added a new
Search
function roles, to allow easy searching over them. This function works both for project level roles as well as tenant level roles (depending on the used filter). - Importing secrets as part of project import: Project import now allows providing missing secrets out of band to allow importing new entities such as connectors' or OAuth providers' credentials into a project.
- Project import validations: Using the
ValidateSnapshot
function, you can project data by performing an import dry run and reporting any validation failures or missing data. It's recommended to perform this check right before actually importing a project to minimize failures. - Template options: In case you need to pass an external value from your systems to Descope, so that it appears in an email or SMS template - use the
TemplateOptions
object to specify those. Read more on this feature in our documentation. - OTP via voice: In addition to sending OTP via SMS or email - we now support a third delivery method - voice call, with the
MethodVoice
const. - ReBAC relationship checker: We added a new function
WhatCanTargetAccessWithRelation
to check what resources a user has access, per the application's ReBAC schema. Search is recursive.
Bug fixes
- Tenant param in passwords should be optional: We changed password management related functions to have the
tenantID
param optional and not required.