auth0 5.9.1 → 5.11.0
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/dist/cjs/management/BaseClient.d.ts +3 -0
- package/dist/cjs/management/BaseClient.js +15 -0
- package/dist/cjs/management/Client.d.ts +3 -0
- package/dist/cjs/management/Client.js +41 -36
- package/dist/cjs/management/api/requests/requests.d.ts +281 -3
- package/dist/cjs/management/api/resources/actions/client/Client.d.ts +1 -1
- package/dist/cjs/management/api/resources/actions/client/Client.js +1 -1
- package/dist/cjs/management/api/resources/branding/resources/templates/client/Client.d.ts +16 -16
- package/dist/cjs/management/api/resources/branding/resources/templates/client/Client.js +16 -16
- package/dist/cjs/management/api/resources/clients/client/Client.d.ts +12 -3
- package/dist/cjs/management/api/resources/clients/client/Client.js +12 -3
- package/dist/cjs/management/api/resources/connections/client/Client.d.ts +17 -19
- package/dist/cjs/management/api/resources/connections/client/Client.js +17 -19
- package/dist/cjs/management/api/resources/connections/resources/clients/client/Client.d.ts +2 -2
- package/dist/cjs/management/api/resources/connections/resources/clients/client/Client.js +2 -2
- package/dist/cjs/management/api/resources/connections/resources/scimConfiguration/client/Client.d.ts +4 -4
- package/dist/cjs/management/api/resources/connections/resources/scimConfiguration/client/Client.js +4 -4
- package/dist/cjs/management/api/resources/connections/resources/scimConfiguration/resources/tokens/client/Client.d.ts +2 -2
- package/dist/cjs/management/api/resources/connections/resources/scimConfiguration/resources/tokens/client/Client.js +2 -2
- package/dist/cjs/management/api/resources/customDomains/client/Client.d.ts +19 -12
- package/dist/cjs/management/api/resources/customDomains/client/Client.js +19 -12
- package/dist/cjs/management/api/resources/deviceCredentials/client/Client.d.ts +3 -3
- package/dist/cjs/management/api/resources/deviceCredentials/client/Client.js +3 -3
- package/dist/cjs/management/api/resources/groups/client/Client.d.ts +3 -0
- package/dist/cjs/management/api/resources/groups/client/Client.js +5 -0
- package/dist/cjs/management/api/resources/groups/resources/index.d.ts +1 -0
- package/dist/cjs/management/api/resources/groups/resources/index.js +2 -1
- package/dist/cjs/management/api/resources/groups/resources/roles/client/Client.d.ts +71 -0
- package/dist/cjs/management/api/resources/groups/resources/roles/client/Client.js +270 -0
- package/dist/cjs/management/api/resources/groups/resources/roles/client/index.d.ts +1 -0
- package/dist/cjs/management/api/resources/groups/resources/roles/client/index.js +2 -0
- package/dist/cjs/management/api/resources/groups/resources/roles/index.d.ts +1 -0
- package/dist/cjs/management/api/resources/groups/resources/roles/index.js +17 -0
- package/dist/cjs/management/api/resources/guardian/resources/enrollments/client/Client.d.ts +2 -5
- package/dist/cjs/management/api/resources/guardian/resources/enrollments/client/Client.js +2 -5
- package/dist/cjs/management/api/resources/guardian/resources/factors/resources/pushNotification/client/Client.d.ts +3 -3
- package/dist/cjs/management/api/resources/guardian/resources/factors/resources/pushNotification/client/Client.js +3 -3
- package/dist/cjs/management/api/resources/guardian/resources/policies/client/Client.d.ts +10 -12
- package/dist/cjs/management/api/resources/guardian/resources/policies/client/Client.js +10 -12
- package/dist/cjs/management/api/resources/hooks/client/Client.d.ts +2 -2
- package/dist/cjs/management/api/resources/hooks/client/Client.js +2 -2
- package/dist/cjs/management/api/resources/index.d.ts +1 -0
- package/dist/cjs/management/api/resources/index.js +2 -1
- package/dist/cjs/management/api/resources/jobs/resources/verificationEmail/client/Client.d.ts +1 -1
- package/dist/cjs/management/api/resources/jobs/resources/verificationEmail/client/Client.js +1 -1
- package/dist/cjs/management/api/resources/logs/client/Client.d.ts +17 -20
- package/dist/cjs/management/api/resources/logs/client/Client.js +17 -20
- package/dist/cjs/management/api/resources/organizations/client/Client.d.ts +14 -13
- package/dist/cjs/management/api/resources/organizations/client/Client.js +20 -17
- package/dist/cjs/management/api/resources/organizations/resources/discoveryDomains/client/Client.d.ts +1 -1
- package/dist/cjs/management/api/resources/organizations/resources/discoveryDomains/client/Client.js +1 -1
- package/dist/cjs/management/api/resources/organizations/resources/enabledConnections/client/Client.d.ts +2 -2
- package/dist/cjs/management/api/resources/organizations/resources/enabledConnections/client/Client.js +2 -2
- package/dist/cjs/management/api/resources/organizations/resources/groups/client/Client.d.ts +35 -0
- package/dist/cjs/management/api/resources/organizations/resources/groups/client/Client.js +146 -0
- package/dist/cjs/management/api/resources/organizations/resources/groups/client/index.d.ts +1 -0
- package/dist/cjs/management/api/resources/organizations/resources/groups/client/index.js +2 -0
- package/dist/cjs/management/api/resources/organizations/resources/groups/index.d.ts +2 -0
- package/dist/cjs/management/api/resources/organizations/resources/groups/index.js +18 -0
- package/dist/cjs/management/api/resources/organizations/resources/groups/resources/index.d.ts +1 -0
- package/dist/cjs/management/api/resources/organizations/resources/groups/resources/index.js +37 -0
- package/dist/cjs/management/api/resources/organizations/resources/groups/resources/roles/client/Client.d.ts +74 -0
- package/dist/cjs/management/api/resources/organizations/resources/groups/resources/roles/client/Client.js +273 -0
- package/dist/cjs/management/api/resources/organizations/resources/groups/resources/roles/client/index.d.ts +1 -0
- package/dist/cjs/management/api/resources/organizations/resources/groups/resources/roles/client/index.js +2 -0
- package/dist/cjs/management/api/resources/organizations/resources/groups/resources/roles/index.d.ts +1 -0
- package/dist/cjs/management/api/resources/organizations/resources/groups/resources/roles/index.js +17 -0
- package/dist/cjs/management/api/resources/organizations/resources/index.d.ts +1 -0
- package/dist/cjs/management/api/resources/organizations/resources/index.js +2 -1
- package/dist/cjs/management/api/resources/organizations/resources/invitations/client/Client.d.ts +2 -2
- package/dist/cjs/management/api/resources/organizations/resources/invitations/client/Client.js +2 -2
- package/dist/cjs/management/api/resources/organizations/resources/members/client/Client.d.ts +9 -12
- package/dist/cjs/management/api/resources/organizations/resources/members/client/Client.js +13 -14
- package/dist/cjs/management/api/resources/organizations/resources/members/resources/effectiveRoles/client/Client.d.ts +36 -0
- package/dist/cjs/management/api/resources/organizations/resources/members/resources/effectiveRoles/client/Client.js +147 -0
- package/dist/cjs/management/api/resources/organizations/resources/members/resources/effectiveRoles/client/index.d.ts +1 -0
- package/dist/cjs/management/api/resources/organizations/resources/members/resources/effectiveRoles/client/index.js +2 -0
- package/dist/cjs/management/api/resources/organizations/resources/members/resources/effectiveRoles/index.d.ts +2 -0
- package/dist/cjs/management/api/resources/organizations/resources/members/resources/effectiveRoles/index.js +18 -0
- package/dist/cjs/management/api/resources/organizations/resources/members/resources/effectiveRoles/resources/index.d.ts +1 -0
- package/dist/cjs/management/api/resources/organizations/resources/members/resources/effectiveRoles/resources/index.js +37 -0
- package/dist/cjs/management/api/resources/organizations/resources/members/resources/effectiveRoles/resources/sources/client/Client.d.ts +12 -0
- package/dist/cjs/management/api/resources/organizations/resources/members/resources/effectiveRoles/resources/sources/client/Client.js +16 -0
- package/dist/cjs/management/api/resources/organizations/resources/members/resources/effectiveRoles/resources/sources/client/index.d.ts +1 -0
- package/dist/cjs/management/api/resources/organizations/resources/members/resources/effectiveRoles/resources/sources/client/index.js +2 -0
- package/dist/cjs/management/api/resources/organizations/resources/members/resources/effectiveRoles/resources/sources/index.d.ts +2 -0
- package/dist/cjs/management/api/resources/organizations/resources/members/resources/effectiveRoles/resources/sources/index.js +18 -0
- package/dist/cjs/management/api/resources/organizations/resources/members/resources/effectiveRoles/resources/sources/resources/groups/client/Client.d.ts +34 -0
- package/dist/cjs/management/api/resources/organizations/resources/members/resources/effectiveRoles/resources/sources/resources/groups/client/Client.js +144 -0
- package/dist/cjs/management/api/resources/organizations/resources/members/resources/effectiveRoles/resources/sources/resources/groups/client/index.d.ts +1 -0
- package/dist/cjs/management/api/resources/organizations/resources/members/resources/effectiveRoles/resources/sources/resources/groups/client/index.js +2 -0
- package/dist/cjs/management/api/resources/organizations/resources/members/resources/effectiveRoles/resources/sources/resources/groups/index.d.ts +1 -0
- package/dist/cjs/management/api/resources/organizations/resources/members/resources/effectiveRoles/resources/sources/resources/groups/index.js +17 -0
- package/dist/cjs/management/api/resources/organizations/resources/members/resources/effectiveRoles/resources/sources/resources/index.d.ts +1 -0
- package/dist/cjs/management/api/resources/organizations/resources/members/resources/effectiveRoles/resources/sources/resources/index.js +37 -0
- package/dist/cjs/management/api/resources/organizations/resources/members/resources/index.d.ts +1 -0
- package/dist/cjs/management/api/resources/organizations/resources/members/resources/index.js +2 -1
- package/dist/cjs/management/api/resources/organizations/resources/members/resources/roles/client/Client.d.ts +2 -2
- package/dist/cjs/management/api/resources/organizations/resources/members/resources/roles/client/Client.js +2 -2
- package/dist/cjs/management/api/resources/prompts/resources/rendering/client/Client.d.ts +2 -2
- package/dist/cjs/management/api/resources/prompts/resources/rendering/client/Client.js +2 -2
- package/dist/cjs/management/api/resources/rateLimitPolicies/client/Client.d.ts +102 -0
- package/dist/cjs/management/api/resources/rateLimitPolicies/client/Client.js +397 -0
- package/dist/cjs/management/api/resources/rateLimitPolicies/client/index.d.ts +1 -0
- package/dist/cjs/management/api/resources/rateLimitPolicies/client/index.js +2 -0
- package/dist/cjs/management/api/resources/rateLimitPolicies/index.d.ts +1 -0
- package/dist/cjs/management/api/resources/rateLimitPolicies/index.js +17 -0
- package/dist/cjs/management/api/resources/roles/client/Client.d.ts +9 -6
- package/dist/cjs/management/api/resources/roles/client/Client.js +15 -10
- package/dist/cjs/management/api/resources/roles/resources/groups/client/Client.d.ts +71 -0
- package/dist/cjs/management/api/resources/roles/resources/groups/client/Client.js +270 -0
- package/dist/cjs/management/api/resources/roles/resources/groups/client/index.d.ts +1 -0
- package/dist/cjs/management/api/resources/roles/resources/groups/client/index.js +2 -0
- package/dist/cjs/management/api/resources/roles/resources/groups/index.d.ts +1 -0
- package/dist/cjs/management/api/resources/roles/resources/groups/index.js +17 -0
- package/dist/cjs/management/api/resources/roles/resources/index.d.ts +1 -0
- package/dist/cjs/management/api/resources/roles/resources/index.js +2 -1
- package/dist/cjs/management/api/resources/roles/resources/permissions/client/Client.d.ts +2 -2
- package/dist/cjs/management/api/resources/roles/resources/permissions/client/Client.js +2 -2
- package/dist/cjs/management/api/resources/roles/resources/users/client/Client.d.ts +11 -13
- package/dist/cjs/management/api/resources/roles/resources/users/client/Client.js +11 -13
- package/dist/cjs/management/api/resources/rules/client/Client.d.ts +4 -4
- package/dist/cjs/management/api/resources/rules/client/Client.js +4 -4
- package/dist/cjs/management/api/resources/userAttributeProfiles/client/Client.d.ts +1 -1
- package/dist/cjs/management/api/resources/userAttributeProfiles/client/Client.js +1 -1
- package/dist/cjs/management/api/resources/userBlocks/client/Client.d.ts +6 -6
- package/dist/cjs/management/api/resources/userBlocks/client/Client.js +6 -6
- package/dist/cjs/management/api/resources/users/client/Client.d.ts +82 -51
- package/dist/cjs/management/api/resources/users/client/Client.js +110 -75
- package/dist/cjs/management/api/resources/users/resources/authenticators/client/Client.d.ts +1 -1
- package/dist/cjs/management/api/resources/users/resources/authenticators/client/Client.js +1 -1
- package/dist/cjs/management/api/resources/users/resources/effectivePermissions/client/Client.d.ts +37 -0
- package/dist/cjs/management/api/resources/users/resources/effectivePermissions/client/Client.js +151 -0
- package/dist/cjs/management/api/resources/users/resources/effectivePermissions/client/index.d.ts +1 -0
- package/dist/cjs/management/api/resources/users/resources/effectivePermissions/client/index.js +2 -0
- package/dist/cjs/management/api/resources/users/resources/effectivePermissions/index.d.ts +2 -0
- package/dist/cjs/management/api/resources/users/resources/effectivePermissions/index.js +18 -0
- package/dist/cjs/management/api/resources/users/resources/effectivePermissions/resources/index.d.ts +1 -0
- package/dist/cjs/management/api/resources/users/resources/effectivePermissions/resources/index.js +37 -0
- package/dist/cjs/management/api/resources/users/resources/effectivePermissions/resources/sources/client/Client.d.ts +12 -0
- package/dist/cjs/management/api/resources/users/resources/effectivePermissions/resources/sources/client/Client.js +16 -0
- package/dist/cjs/management/api/resources/users/resources/effectivePermissions/resources/sources/client/index.d.ts +1 -0
- package/dist/cjs/management/api/resources/users/resources/effectivePermissions/resources/sources/client/index.js +2 -0
- package/dist/cjs/management/api/resources/users/resources/effectivePermissions/resources/sources/index.d.ts +2 -0
- package/dist/cjs/management/api/resources/users/resources/effectivePermissions/resources/sources/index.js +18 -0
- package/dist/cjs/management/api/resources/users/resources/effectivePermissions/resources/sources/resources/index.d.ts +1 -0
- package/dist/cjs/management/api/resources/users/resources/effectivePermissions/resources/sources/resources/index.js +37 -0
- package/dist/cjs/management/api/resources/users/resources/effectivePermissions/resources/sources/resources/roles/client/Client.d.ts +35 -0
- package/dist/cjs/management/api/resources/users/resources/effectivePermissions/resources/sources/resources/roles/client/Client.js +148 -0
- package/dist/cjs/management/api/resources/users/resources/effectivePermissions/resources/sources/resources/roles/client/index.d.ts +1 -0
- package/dist/cjs/management/api/resources/users/resources/effectivePermissions/resources/sources/resources/roles/client/index.js +2 -0
- package/dist/cjs/management/api/resources/users/resources/effectivePermissions/resources/sources/resources/roles/index.d.ts +1 -0
- package/dist/cjs/management/api/resources/users/resources/effectivePermissions/resources/sources/resources/roles/index.js +17 -0
- package/dist/cjs/management/api/resources/users/resources/effectiveRoles/client/Client.d.ts +35 -0
- package/dist/cjs/management/api/resources/users/resources/effectiveRoles/client/Client.js +146 -0
- package/dist/cjs/management/api/resources/users/resources/effectiveRoles/client/index.d.ts +1 -0
- package/dist/cjs/management/api/resources/users/resources/effectiveRoles/client/index.js +2 -0
- package/dist/cjs/management/api/resources/users/resources/effectiveRoles/index.d.ts +2 -0
- package/dist/cjs/management/api/resources/users/resources/effectiveRoles/index.js +18 -0
- package/dist/cjs/management/api/resources/users/resources/effectiveRoles/resources/index.d.ts +1 -0
- package/dist/cjs/management/api/resources/users/resources/effectiveRoles/resources/index.js +37 -0
- package/dist/cjs/management/api/resources/users/resources/effectiveRoles/resources/sources/client/Client.d.ts +12 -0
- package/dist/cjs/management/api/resources/users/resources/effectiveRoles/resources/sources/client/Client.js +16 -0
- package/dist/cjs/management/api/resources/users/resources/effectiveRoles/resources/sources/client/index.d.ts +1 -0
- package/dist/cjs/management/api/resources/users/resources/effectiveRoles/resources/sources/client/index.js +2 -0
- package/dist/cjs/management/api/resources/users/resources/effectiveRoles/resources/sources/index.d.ts +2 -0
- package/dist/cjs/management/api/resources/users/resources/effectiveRoles/resources/sources/index.js +18 -0
- package/dist/cjs/management/api/resources/users/resources/effectiveRoles/resources/sources/resources/groups/client/Client.d.ts +33 -0
- package/dist/cjs/management/api/resources/users/resources/effectiveRoles/resources/sources/resources/groups/client/Client.js +143 -0
- package/dist/cjs/management/api/resources/users/resources/effectiveRoles/resources/sources/resources/groups/client/index.d.ts +1 -0
- package/dist/cjs/management/api/resources/users/resources/effectiveRoles/resources/sources/resources/groups/client/index.js +2 -0
- package/dist/cjs/management/api/resources/users/resources/effectiveRoles/resources/sources/resources/groups/index.d.ts +1 -0
- package/dist/cjs/management/api/resources/users/resources/effectiveRoles/resources/sources/resources/groups/index.js +17 -0
- package/dist/cjs/management/api/resources/users/resources/effectiveRoles/resources/sources/resources/index.d.ts +1 -0
- package/dist/cjs/management/api/resources/users/resources/effectiveRoles/resources/sources/resources/index.js +37 -0
- package/dist/cjs/management/api/resources/users/resources/enrollments/client/Client.d.ts +1 -1
- package/dist/cjs/management/api/resources/users/resources/enrollments/client/Client.js +1 -1
- package/dist/cjs/management/api/resources/users/resources/identities/client/Client.d.ts +26 -25
- package/dist/cjs/management/api/resources/users/resources/identities/client/Client.js +26 -25
- package/dist/cjs/management/api/resources/users/resources/index.d.ts +2 -0
- package/dist/cjs/management/api/resources/users/resources/index.js +3 -1
- package/dist/cjs/management/api/resources/users/resources/multifactor/client/Client.d.ts +2 -2
- package/dist/cjs/management/api/resources/users/resources/multifactor/client/Client.js +2 -2
- package/dist/cjs/management/api/resources/users/resources/organizations/client/Client.d.ts +1 -1
- package/dist/cjs/management/api/resources/users/resources/organizations/client/Client.js +1 -1
- package/dist/cjs/management/api/resources/users/resources/roles/client/Client.d.ts +6 -4
- package/dist/cjs/management/api/resources/users/resources/roles/client/Client.js +10 -4
- package/dist/cjs/management/api/types/types.d.ts +503 -53
- package/dist/cjs/management/api/types/types.js +133 -14
- package/dist/cjs/management/core/auth/AuthProvider.d.ts +1 -0
- package/dist/cjs/management/core/auth/AuthProvider.js +7 -0
- package/dist/cjs/management/core/auth/index.d.ts +1 -1
- package/dist/cjs/management/core/auth/index.js +3 -1
- package/dist/cjs/management/core/fetcher/requestWithRetries.js +4 -1
- package/dist/cjs/management/version.d.ts +1 -1
- package/dist/cjs/management/version.js +1 -1
- package/dist/esm/management/BaseClient.d.mts +3 -0
- package/dist/esm/management/BaseClient.mjs +15 -0
- package/dist/esm/management/Client.d.mts +3 -0
- package/dist/esm/management/Client.mjs +5 -0
- package/dist/esm/management/api/requests/requests.d.mts +281 -3
- package/dist/esm/management/api/resources/actions/client/Client.d.mts +1 -1
- package/dist/esm/management/api/resources/actions/client/Client.mjs +1 -1
- package/dist/esm/management/api/resources/branding/resources/templates/client/Client.d.mts +16 -16
- package/dist/esm/management/api/resources/branding/resources/templates/client/Client.mjs +16 -16
- package/dist/esm/management/api/resources/clients/client/Client.d.mts +12 -3
- package/dist/esm/management/api/resources/clients/client/Client.mjs +12 -3
- package/dist/esm/management/api/resources/connections/client/Client.d.mts +17 -19
- package/dist/esm/management/api/resources/connections/client/Client.mjs +17 -19
- package/dist/esm/management/api/resources/connections/resources/clients/client/Client.d.mts +2 -2
- package/dist/esm/management/api/resources/connections/resources/clients/client/Client.mjs +2 -2
- package/dist/esm/management/api/resources/connections/resources/scimConfiguration/client/Client.d.mts +4 -4
- package/dist/esm/management/api/resources/connections/resources/scimConfiguration/client/Client.mjs +4 -4
- package/dist/esm/management/api/resources/connections/resources/scimConfiguration/resources/tokens/client/Client.d.mts +2 -2
- package/dist/esm/management/api/resources/connections/resources/scimConfiguration/resources/tokens/client/Client.mjs +2 -2
- package/dist/esm/management/api/resources/customDomains/client/Client.d.mts +19 -12
- package/dist/esm/management/api/resources/customDomains/client/Client.mjs +19 -12
- package/dist/esm/management/api/resources/deviceCredentials/client/Client.d.mts +3 -3
- package/dist/esm/management/api/resources/deviceCredentials/client/Client.mjs +3 -3
- package/dist/esm/management/api/resources/groups/client/Client.d.mts +3 -0
- package/dist/esm/management/api/resources/groups/client/Client.mjs +5 -0
- package/dist/esm/management/api/resources/groups/resources/index.d.mts +1 -0
- package/dist/esm/management/api/resources/groups/resources/index.mjs +1 -0
- package/dist/esm/management/api/resources/groups/resources/roles/client/Client.d.mts +71 -0
- package/dist/esm/management/api/resources/groups/resources/roles/client/Client.mjs +233 -0
- package/dist/esm/management/api/resources/groups/resources/roles/client/index.d.mts +1 -0
- package/dist/esm/management/api/resources/groups/resources/roles/client/index.mjs +1 -0
- package/dist/esm/management/api/resources/groups/resources/roles/index.d.mts +1 -0
- package/dist/esm/management/api/resources/groups/resources/roles/index.mjs +1 -0
- package/dist/esm/management/api/resources/guardian/resources/enrollments/client/Client.d.mts +2 -5
- package/dist/esm/management/api/resources/guardian/resources/enrollments/client/Client.mjs +2 -5
- package/dist/esm/management/api/resources/guardian/resources/factors/resources/pushNotification/client/Client.d.mts +3 -3
- package/dist/esm/management/api/resources/guardian/resources/factors/resources/pushNotification/client/Client.mjs +3 -3
- package/dist/esm/management/api/resources/guardian/resources/policies/client/Client.d.mts +10 -12
- package/dist/esm/management/api/resources/guardian/resources/policies/client/Client.mjs +10 -12
- package/dist/esm/management/api/resources/hooks/client/Client.d.mts +2 -2
- package/dist/esm/management/api/resources/hooks/client/Client.mjs +2 -2
- package/dist/esm/management/api/resources/index.d.mts +1 -0
- package/dist/esm/management/api/resources/index.mjs +1 -0
- package/dist/esm/management/api/resources/jobs/resources/verificationEmail/client/Client.d.mts +1 -1
- package/dist/esm/management/api/resources/jobs/resources/verificationEmail/client/Client.mjs +1 -1
- package/dist/esm/management/api/resources/logs/client/Client.d.mts +17 -20
- package/dist/esm/management/api/resources/logs/client/Client.mjs +17 -20
- package/dist/esm/management/api/resources/organizations/client/Client.d.mts +14 -13
- package/dist/esm/management/api/resources/organizations/client/Client.mjs +16 -13
- package/dist/esm/management/api/resources/organizations/resources/discoveryDomains/client/Client.d.mts +1 -1
- package/dist/esm/management/api/resources/organizations/resources/discoveryDomains/client/Client.mjs +1 -1
- package/dist/esm/management/api/resources/organizations/resources/enabledConnections/client/Client.d.mts +2 -2
- package/dist/esm/management/api/resources/organizations/resources/enabledConnections/client/Client.mjs +2 -2
- package/dist/esm/management/api/resources/organizations/resources/groups/client/Client.d.mts +35 -0
- package/dist/esm/management/api/resources/organizations/resources/groups/client/Client.mjs +109 -0
- package/dist/esm/management/api/resources/organizations/resources/groups/client/index.d.mts +1 -0
- package/dist/esm/management/api/resources/organizations/resources/groups/client/index.mjs +1 -0
- package/dist/esm/management/api/resources/organizations/resources/groups/index.d.mts +2 -0
- package/dist/esm/management/api/resources/organizations/resources/groups/index.mjs +2 -0
- package/dist/esm/management/api/resources/organizations/resources/groups/resources/index.d.mts +1 -0
- package/dist/esm/management/api/resources/organizations/resources/groups/resources/index.mjs +1 -0
- package/dist/esm/management/api/resources/organizations/resources/groups/resources/roles/client/Client.d.mts +74 -0
- package/dist/esm/management/api/resources/organizations/resources/groups/resources/roles/client/Client.mjs +236 -0
- package/dist/esm/management/api/resources/organizations/resources/groups/resources/roles/client/index.d.mts +1 -0
- package/dist/esm/management/api/resources/organizations/resources/groups/resources/roles/client/index.mjs +1 -0
- package/dist/esm/management/api/resources/organizations/resources/groups/resources/roles/index.d.mts +1 -0
- package/dist/esm/management/api/resources/organizations/resources/groups/resources/roles/index.mjs +1 -0
- package/dist/esm/management/api/resources/organizations/resources/index.d.mts +1 -0
- package/dist/esm/management/api/resources/organizations/resources/index.mjs +1 -0
- package/dist/esm/management/api/resources/organizations/resources/invitations/client/Client.d.mts +2 -2
- package/dist/esm/management/api/resources/organizations/resources/invitations/client/Client.mjs +2 -2
- package/dist/esm/management/api/resources/organizations/resources/members/client/Client.d.mts +9 -12
- package/dist/esm/management/api/resources/organizations/resources/members/client/Client.mjs +11 -12
- package/dist/esm/management/api/resources/organizations/resources/members/resources/effectiveRoles/client/Client.d.mts +36 -0
- package/dist/esm/management/api/resources/organizations/resources/members/resources/effectiveRoles/client/Client.mjs +110 -0
- package/dist/esm/management/api/resources/organizations/resources/members/resources/effectiveRoles/client/index.d.mts +1 -0
- package/dist/esm/management/api/resources/organizations/resources/members/resources/effectiveRoles/client/index.mjs +1 -0
- package/dist/esm/management/api/resources/organizations/resources/members/resources/effectiveRoles/index.d.mts +2 -0
- package/dist/esm/management/api/resources/organizations/resources/members/resources/effectiveRoles/index.mjs +2 -0
- package/dist/esm/management/api/resources/organizations/resources/members/resources/effectiveRoles/resources/index.d.mts +1 -0
- package/dist/esm/management/api/resources/organizations/resources/members/resources/effectiveRoles/resources/index.mjs +1 -0
- package/dist/esm/management/api/resources/organizations/resources/members/resources/effectiveRoles/resources/sources/client/Client.d.mts +12 -0
- package/dist/esm/management/api/resources/organizations/resources/members/resources/effectiveRoles/resources/sources/client/Client.mjs +12 -0
- package/dist/esm/management/api/resources/organizations/resources/members/resources/effectiveRoles/resources/sources/client/index.d.mts +1 -0
- package/dist/esm/management/api/resources/organizations/resources/members/resources/effectiveRoles/resources/sources/client/index.mjs +1 -0
- package/dist/esm/management/api/resources/organizations/resources/members/resources/effectiveRoles/resources/sources/index.d.mts +2 -0
- package/dist/esm/management/api/resources/organizations/resources/members/resources/effectiveRoles/resources/sources/index.mjs +2 -0
- package/dist/esm/management/api/resources/organizations/resources/members/resources/effectiveRoles/resources/sources/resources/groups/client/Client.d.mts +34 -0
- package/dist/esm/management/api/resources/organizations/resources/members/resources/effectiveRoles/resources/sources/resources/groups/client/Client.mjs +107 -0
- package/dist/esm/management/api/resources/organizations/resources/members/resources/effectiveRoles/resources/sources/resources/groups/client/index.d.mts +1 -0
- package/dist/esm/management/api/resources/organizations/resources/members/resources/effectiveRoles/resources/sources/resources/groups/client/index.mjs +1 -0
- package/dist/esm/management/api/resources/organizations/resources/members/resources/effectiveRoles/resources/sources/resources/groups/index.d.mts +1 -0
- package/dist/esm/management/api/resources/organizations/resources/members/resources/effectiveRoles/resources/sources/resources/groups/index.mjs +1 -0
- package/dist/esm/management/api/resources/organizations/resources/members/resources/effectiveRoles/resources/sources/resources/index.d.mts +1 -0
- package/dist/esm/management/api/resources/organizations/resources/members/resources/effectiveRoles/resources/sources/resources/index.mjs +1 -0
- package/dist/esm/management/api/resources/organizations/resources/members/resources/index.d.mts +1 -0
- package/dist/esm/management/api/resources/organizations/resources/members/resources/index.mjs +1 -0
- package/dist/esm/management/api/resources/organizations/resources/members/resources/roles/client/Client.d.mts +2 -2
- package/dist/esm/management/api/resources/organizations/resources/members/resources/roles/client/Client.mjs +2 -2
- package/dist/esm/management/api/resources/prompts/resources/rendering/client/Client.d.mts +2 -2
- package/dist/esm/management/api/resources/prompts/resources/rendering/client/Client.mjs +2 -2
- package/dist/esm/management/api/resources/rateLimitPolicies/client/Client.d.mts +102 -0
- package/dist/esm/management/api/resources/rateLimitPolicies/client/Client.mjs +360 -0
- package/dist/esm/management/api/resources/rateLimitPolicies/client/index.d.mts +1 -0
- package/dist/esm/management/api/resources/rateLimitPolicies/client/index.mjs +1 -0
- package/dist/esm/management/api/resources/rateLimitPolicies/index.d.mts +1 -0
- package/dist/esm/management/api/resources/rateLimitPolicies/index.mjs +1 -0
- package/dist/esm/management/api/resources/roles/client/Client.d.mts +9 -6
- package/dist/esm/management/api/resources/roles/client/Client.mjs +11 -6
- package/dist/esm/management/api/resources/roles/resources/groups/client/Client.d.mts +71 -0
- package/dist/esm/management/api/resources/roles/resources/groups/client/Client.mjs +233 -0
- package/dist/esm/management/api/resources/roles/resources/groups/client/index.d.mts +1 -0
- package/dist/esm/management/api/resources/roles/resources/groups/client/index.mjs +1 -0
- package/dist/esm/management/api/resources/roles/resources/groups/index.d.mts +1 -0
- package/dist/esm/management/api/resources/roles/resources/groups/index.mjs +1 -0
- package/dist/esm/management/api/resources/roles/resources/index.d.mts +1 -0
- package/dist/esm/management/api/resources/roles/resources/index.mjs +1 -0
- package/dist/esm/management/api/resources/roles/resources/permissions/client/Client.d.mts +2 -2
- package/dist/esm/management/api/resources/roles/resources/permissions/client/Client.mjs +2 -2
- package/dist/esm/management/api/resources/roles/resources/users/client/Client.d.mts +11 -13
- package/dist/esm/management/api/resources/roles/resources/users/client/Client.mjs +11 -13
- package/dist/esm/management/api/resources/rules/client/Client.d.mts +4 -4
- package/dist/esm/management/api/resources/rules/client/Client.mjs +4 -4
- package/dist/esm/management/api/resources/userAttributeProfiles/client/Client.d.mts +1 -1
- package/dist/esm/management/api/resources/userAttributeProfiles/client/Client.mjs +1 -1
- package/dist/esm/management/api/resources/userBlocks/client/Client.d.mts +6 -6
- package/dist/esm/management/api/resources/userBlocks/client/Client.mjs +6 -6
- package/dist/esm/management/api/resources/users/client/Client.d.mts +82 -51
- package/dist/esm/management/api/resources/users/client/Client.mjs +86 -51
- package/dist/esm/management/api/resources/users/resources/authenticators/client/Client.d.mts +1 -1
- package/dist/esm/management/api/resources/users/resources/authenticators/client/Client.mjs +1 -1
- package/dist/esm/management/api/resources/users/resources/effectivePermissions/client/Client.d.mts +37 -0
- package/dist/esm/management/api/resources/users/resources/effectivePermissions/client/Client.mjs +114 -0
- package/dist/esm/management/api/resources/users/resources/effectivePermissions/client/index.d.mts +1 -0
- package/dist/esm/management/api/resources/users/resources/effectivePermissions/client/index.mjs +1 -0
- package/dist/esm/management/api/resources/users/resources/effectivePermissions/index.d.mts +2 -0
- package/dist/esm/management/api/resources/users/resources/effectivePermissions/index.mjs +2 -0
- package/dist/esm/management/api/resources/users/resources/effectivePermissions/resources/index.d.mts +1 -0
- package/dist/esm/management/api/resources/users/resources/effectivePermissions/resources/index.mjs +1 -0
- package/dist/esm/management/api/resources/users/resources/effectivePermissions/resources/sources/client/Client.d.mts +12 -0
- package/dist/esm/management/api/resources/users/resources/effectivePermissions/resources/sources/client/Client.mjs +12 -0
- package/dist/esm/management/api/resources/users/resources/effectivePermissions/resources/sources/client/index.d.mts +1 -0
- package/dist/esm/management/api/resources/users/resources/effectivePermissions/resources/sources/client/index.mjs +1 -0
- package/dist/esm/management/api/resources/users/resources/effectivePermissions/resources/sources/index.d.mts +2 -0
- package/dist/esm/management/api/resources/users/resources/effectivePermissions/resources/sources/index.mjs +2 -0
- package/dist/esm/management/api/resources/users/resources/effectivePermissions/resources/sources/resources/index.d.mts +1 -0
- package/dist/esm/management/api/resources/users/resources/effectivePermissions/resources/sources/resources/index.mjs +1 -0
- package/dist/esm/management/api/resources/users/resources/effectivePermissions/resources/sources/resources/roles/client/Client.d.mts +35 -0
- package/dist/esm/management/api/resources/users/resources/effectivePermissions/resources/sources/resources/roles/client/Client.mjs +111 -0
- package/dist/esm/management/api/resources/users/resources/effectivePermissions/resources/sources/resources/roles/client/index.d.mts +1 -0
- package/dist/esm/management/api/resources/users/resources/effectivePermissions/resources/sources/resources/roles/client/index.mjs +1 -0
- package/dist/esm/management/api/resources/users/resources/effectivePermissions/resources/sources/resources/roles/index.d.mts +1 -0
- package/dist/esm/management/api/resources/users/resources/effectivePermissions/resources/sources/resources/roles/index.mjs +1 -0
- package/dist/esm/management/api/resources/users/resources/effectiveRoles/client/Client.d.mts +35 -0
- package/dist/esm/management/api/resources/users/resources/effectiveRoles/client/Client.mjs +109 -0
- package/dist/esm/management/api/resources/users/resources/effectiveRoles/client/index.d.mts +1 -0
- package/dist/esm/management/api/resources/users/resources/effectiveRoles/client/index.mjs +1 -0
- package/dist/esm/management/api/resources/users/resources/effectiveRoles/index.d.mts +2 -0
- package/dist/esm/management/api/resources/users/resources/effectiveRoles/index.mjs +2 -0
- package/dist/esm/management/api/resources/users/resources/effectiveRoles/resources/index.d.mts +1 -0
- package/dist/esm/management/api/resources/users/resources/effectiveRoles/resources/index.mjs +1 -0
- package/dist/esm/management/api/resources/users/resources/effectiveRoles/resources/sources/client/Client.d.mts +12 -0
- package/dist/esm/management/api/resources/users/resources/effectiveRoles/resources/sources/client/Client.mjs +12 -0
- package/dist/esm/management/api/resources/users/resources/effectiveRoles/resources/sources/client/index.d.mts +1 -0
- package/dist/esm/management/api/resources/users/resources/effectiveRoles/resources/sources/client/index.mjs +1 -0
- package/dist/esm/management/api/resources/users/resources/effectiveRoles/resources/sources/index.d.mts +2 -0
- package/dist/esm/management/api/resources/users/resources/effectiveRoles/resources/sources/index.mjs +2 -0
- package/dist/esm/management/api/resources/users/resources/effectiveRoles/resources/sources/resources/groups/client/Client.d.mts +33 -0
- package/dist/esm/management/api/resources/users/resources/effectiveRoles/resources/sources/resources/groups/client/Client.mjs +106 -0
- package/dist/esm/management/api/resources/users/resources/effectiveRoles/resources/sources/resources/groups/client/index.d.mts +1 -0
- package/dist/esm/management/api/resources/users/resources/effectiveRoles/resources/sources/resources/groups/client/index.mjs +1 -0
- package/dist/esm/management/api/resources/users/resources/effectiveRoles/resources/sources/resources/groups/index.d.mts +1 -0
- package/dist/esm/management/api/resources/users/resources/effectiveRoles/resources/sources/resources/groups/index.mjs +1 -0
- package/dist/esm/management/api/resources/users/resources/effectiveRoles/resources/sources/resources/index.d.mts +1 -0
- package/dist/esm/management/api/resources/users/resources/effectiveRoles/resources/sources/resources/index.mjs +1 -0
- package/dist/esm/management/api/resources/users/resources/enrollments/client/Client.d.mts +1 -1
- package/dist/esm/management/api/resources/users/resources/enrollments/client/Client.mjs +1 -1
- package/dist/esm/management/api/resources/users/resources/identities/client/Client.d.mts +26 -25
- package/dist/esm/management/api/resources/users/resources/identities/client/Client.mjs +26 -25
- package/dist/esm/management/api/resources/users/resources/index.d.mts +2 -0
- package/dist/esm/management/api/resources/users/resources/index.mjs +2 -0
- package/dist/esm/management/api/resources/users/resources/multifactor/client/Client.d.mts +2 -2
- package/dist/esm/management/api/resources/users/resources/multifactor/client/Client.mjs +2 -2
- package/dist/esm/management/api/resources/users/resources/organizations/client/Client.d.mts +1 -1
- package/dist/esm/management/api/resources/users/resources/organizations/client/Client.mjs +1 -1
- package/dist/esm/management/api/resources/users/resources/roles/client/Client.d.mts +6 -4
- package/dist/esm/management/api/resources/users/resources/roles/client/Client.mjs +10 -4
- package/dist/esm/management/api/types/types.d.mts +503 -53
- package/dist/esm/management/api/types/types.mjs +120 -1
- package/dist/esm/management/core/auth/AuthProvider.d.mts +1 -0
- package/dist/esm/management/core/auth/AuthProvider.mjs +6 -1
- package/dist/esm/management/core/auth/index.d.mts +1 -1
- package/dist/esm/management/core/auth/index.mjs +1 -0
- package/dist/esm/management/core/fetcher/requestWithRetries.mjs +4 -1
- package/dist/esm/management/version.d.mts +1 -1
- package/dist/esm/management/version.mjs +1 -1
- package/package.json +3 -3
- package/reference.md +3564 -1868
|
@@ -5,6 +5,8 @@ import * as Management from "../../../index.js";
|
|
|
5
5
|
import { AuthenticationMethodsClient } from "../resources/authenticationMethods/client/Client.js";
|
|
6
6
|
import { AuthenticatorsClient } from "../resources/authenticators/client/Client.js";
|
|
7
7
|
import { ConnectedAccountsClient } from "../resources/connectedAccounts/client/Client.js";
|
|
8
|
+
import { EffectivePermissionsClient } from "../resources/effectivePermissions/client/Client.js";
|
|
9
|
+
import { EffectiveRolesClient } from "../resources/effectiveRoles/client/Client.js";
|
|
8
10
|
import { EnrollmentsClient } from "../resources/enrollments/client/Client.js";
|
|
9
11
|
import { FederatedConnectionsTokensetsClient } from "../resources/federatedConnectionsTokensets/client/Client.js";
|
|
10
12
|
import { GroupsClient } from "../resources/groups/client/Client.js";
|
|
@@ -27,6 +29,8 @@ export declare class UsersClient {
|
|
|
27
29
|
protected _authenticationMethods: AuthenticationMethodsClient | undefined;
|
|
28
30
|
protected _authenticators: AuthenticatorsClient | undefined;
|
|
29
31
|
protected _connectedAccounts: ConnectedAccountsClient | undefined;
|
|
32
|
+
protected _effectivePermissions: EffectivePermissionsClient | undefined;
|
|
33
|
+
protected _effectiveRoles: EffectiveRolesClient | undefined;
|
|
30
34
|
protected _enrollments: EnrollmentsClient | undefined;
|
|
31
35
|
protected _federatedConnectionsTokensets: FederatedConnectionsTokensetsClient | undefined;
|
|
32
36
|
protected _groups: GroupsClient | undefined;
|
|
@@ -43,6 +47,8 @@ export declare class UsersClient {
|
|
|
43
47
|
get authenticationMethods(): AuthenticationMethodsClient;
|
|
44
48
|
get authenticators(): AuthenticatorsClient;
|
|
45
49
|
get connectedAccounts(): ConnectedAccountsClient;
|
|
50
|
+
get effectivePermissions(): EffectivePermissionsClient;
|
|
51
|
+
get effectiveRoles(): EffectiveRolesClient;
|
|
46
52
|
get enrollments(): EnrollmentsClient;
|
|
47
53
|
get federatedConnectionsTokensets(): FederatedConnectionsTokensetsClient;
|
|
48
54
|
get groups(): GroupsClient;
|
|
@@ -62,14 +68,18 @@ export declare class UsersClient {
|
|
|
62
68
|
* - Sort the users to be returned
|
|
63
69
|
* - Select the fields to be returned
|
|
64
70
|
* - Specify the number of users to retrieve per page and the page index
|
|
65
|
-
* <!-- only v3 is available -->
|
|
66
|
-
* The <code>q</code> query parameter can be used to get users that match the specified criteria <a href="https://auth0.com/docs/users/search/v3/query-syntax">using query string syntax.</a>
|
|
67
71
|
*
|
|
68
|
-
* <a href="https://auth0.com/docs/users/search/v3">Learn more about searching for users.</a>
|
|
69
72
|
*
|
|
70
|
-
* Read about <a href="https://auth0.com/docs/users/search/best-practices">best practices</a> when working with the API endpoints for retrieving users.
|
|
71
73
|
*
|
|
72
|
-
*
|
|
74
|
+
* The `q` query parameter can be used to get users that match the specified criteria [using query string syntax.](https://auth0.com/docs/users/search/v3/query-syntax)
|
|
75
|
+
*
|
|
76
|
+
* [Learn more about searching for users.](https://auth0.com/docs/users/search/v3)
|
|
77
|
+
*
|
|
78
|
+
* Read about [best practices](https://auth0.com/docs/users/search/best-practices) when working with the API endpoints for retrieving users.
|
|
79
|
+
*
|
|
80
|
+
*
|
|
81
|
+
*
|
|
82
|
+
* Auth0 limits the number of users you can return. If you exceed this threshold, please redefine your search, use the [export job](https://auth0.com/docs/api/management/v2#!/Jobs/post_users_exports), or the [User Import / Export](https://auth0.com/docs/extensions/user-import-export) extension.
|
|
73
83
|
*
|
|
74
84
|
* @param {Management.ListUsersRequestParameters} request
|
|
75
85
|
* @param {UsersClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -96,9 +106,9 @@ export declare class UsersClient {
|
|
|
96
106
|
*/
|
|
97
107
|
list(request?: Management.ListUsersRequestParameters, requestOptions?: UsersClient.RequestOptions): Promise<core.Page<Management.UserResponseSchema, Management.ListUsersOffsetPaginatedResponseContent>>;
|
|
98
108
|
/**
|
|
99
|
-
* Create a new user for a given
|
|
109
|
+
* Create a new user for a given [database](https://auth0.com/docs/connections/database) or [passwordless](https://auth0.com/docs/connections/passwordless) connection.
|
|
100
110
|
*
|
|
101
|
-
* Note:
|
|
111
|
+
* Note: `connection` is required but other parameters such as `email` and `password` are dependent upon the type of connection.
|
|
102
112
|
*
|
|
103
113
|
* @param {Management.CreateUserRequestContent} request
|
|
104
114
|
* @param {UsersClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -141,7 +151,7 @@ export declare class UsersClient {
|
|
|
141
151
|
listUsersByEmail(request: Management.ListUsersByEmailRequestParameters, requestOptions?: UsersClient.RequestOptions): core.HttpResponsePromise<Management.UserResponseSchema[]>;
|
|
142
152
|
private __listUsersByEmail;
|
|
143
153
|
/**
|
|
144
|
-
* Retrieve user details. A list of fields to include or exclude may also be specified. For more information, see
|
|
154
|
+
* Retrieve user details. A list of fields to include or exclude may also be specified. For more information, see [Retrieve Users with the Get Users Endpoint](https://auth0.com/docs/manage-users/user-search/retrieve-users-with-get-users-endpoint).
|
|
145
155
|
*
|
|
146
156
|
* @param {string} id - ID of the user to retrieve.
|
|
147
157
|
* @param {Management.GetUserRequestParameters} request
|
|
@@ -162,7 +172,7 @@ export declare class UsersClient {
|
|
|
162
172
|
get(id: string, request?: Management.GetUserRequestParameters, requestOptions?: UsersClient.RequestOptions): core.HttpResponsePromise<Management.GetUserResponseContent>;
|
|
163
173
|
private __get;
|
|
164
174
|
/**
|
|
165
|
-
* Delete a user by user ID. This action cannot be undone. For Auth0 Dashboard instructions, see
|
|
175
|
+
* Delete a user by user ID. This action cannot be undone. For Auth0 Dashboard instructions, see [Delete Users](https://auth0.com/docs/manage-users/user-accounts/delete-users).
|
|
166
176
|
*
|
|
167
177
|
* @param {string} id - ID of the user to delete.
|
|
168
178
|
* @param {UsersClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -182,64 +192,84 @@ export declare class UsersClient {
|
|
|
182
192
|
*
|
|
183
193
|
* These are the attributes that can be updated at the root level:
|
|
184
194
|
*
|
|
185
|
-
*
|
|
186
|
-
*
|
|
187
|
-
*
|
|
188
|
-
*
|
|
189
|
-
*
|
|
190
|
-
*
|
|
191
|
-
*
|
|
192
|
-
*
|
|
193
|
-
*
|
|
194
|
-
*
|
|
195
|
-
*
|
|
196
|
-
*
|
|
197
|
-
*
|
|
198
|
-
*
|
|
199
|
-
*
|
|
200
|
-
* <li>verify_email</li>
|
|
201
|
-
* </ul>
|
|
195
|
+
* - app_metadata
|
|
196
|
+
* - blocked
|
|
197
|
+
* - email
|
|
198
|
+
* - email_verified
|
|
199
|
+
* - family_name
|
|
200
|
+
* - given_name
|
|
201
|
+
* - name
|
|
202
|
+
* - nickname
|
|
203
|
+
* - password
|
|
204
|
+
* - phone_number
|
|
205
|
+
* - phone_verified
|
|
206
|
+
* - picture
|
|
207
|
+
* - username
|
|
208
|
+
* - user_metadata
|
|
209
|
+
* - verify_email
|
|
202
210
|
*
|
|
203
211
|
* Some considerations:
|
|
204
|
-
*
|
|
205
|
-
*
|
|
206
|
-
*
|
|
207
|
-
*
|
|
208
|
-
*
|
|
209
|
-
*
|
|
210
|
-
*
|
|
211
|
-
*
|
|
212
|
-
*
|
|
213
|
-
*
|
|
214
|
-
*
|
|
212
|
+
*
|
|
213
|
+
* - The properties of the new object will replace the old ones.
|
|
214
|
+
* - The metadata fields are an exception to this rule (`user_metadata` and `app_metadata`). These properties are merged instead of being replaced but be careful, the merge only occurs on the first level.
|
|
215
|
+
* - If you are updating `email`, `email_verified`, `phone_number`, `phone_verified`, `username` or `password` of a secondary identity, you need to specify the `connection` property too.
|
|
216
|
+
* - If you are updating `email` or `phone_number` you can specify, optionally, the `client_id` property.
|
|
217
|
+
* - Updating `email_verified` is not supported for enterprise and passwordless sms connections.
|
|
218
|
+
* - Updating the `blocked` to `false` does not affect the user's blocked state from an excessive amount of incorrectly provided credentials. Use the "Unblock a user" endpoint from the "User Blocks" API to change the user's state.
|
|
219
|
+
* - Supported attributes can be unset by supplying `null` as the value.
|
|
220
|
+
*
|
|
221
|
+
* **Updating a field (non-metadata property)**
|
|
222
|
+
*
|
|
215
223
|
* To mark the email address of a user as verified, the body to send should be:
|
|
216
|
-
* <pre><code>{ "email_verified": true }</code></pre>
|
|
217
224
|
*
|
|
218
|
-
*
|
|
219
|
-
*
|
|
225
|
+
* ```json
|
|
226
|
+
* { "email_verified": true }
|
|
227
|
+
* ```
|
|
220
228
|
*
|
|
221
|
-
*
|
|
222
|
-
* <pre><code>{ "user_metadata" : { "addresses": {"work_address": "100 Industrial Way"} }}</code></pre>
|
|
229
|
+
* **Updating a user metadata root property**
|
|
223
230
|
*
|
|
224
|
-
*
|
|
231
|
+
* Let's assume that our test user has the following `user_metadata`:
|
|
232
|
+
*
|
|
233
|
+
* ```json
|
|
234
|
+
* { "user_metadata" : { "profileCode": 1479 } }
|
|
235
|
+
* ```
|
|
236
|
+
*
|
|
237
|
+
* To add the field `addresses` the body to send should be:
|
|
238
|
+
*
|
|
239
|
+
* ```json
|
|
240
|
+
* { "user_metadata" : { "addresses": {"work_address": "100 Industrial Way"} }}
|
|
241
|
+
* ```
|
|
242
|
+
*
|
|
243
|
+
* The modified object ends up with the following `user_metadata` property:
|
|
244
|
+
*
|
|
245
|
+
* ```json
|
|
246
|
+
* {
|
|
225
247
|
* "user_metadata": {
|
|
226
248
|
* "profileCode": 1479,
|
|
227
249
|
* "addresses": { "work_address": "100 Industrial Way" }
|
|
228
250
|
* }
|
|
229
|
-
* }
|
|
251
|
+
* }
|
|
252
|
+
* ```
|
|
253
|
+
*
|
|
254
|
+
* **Updating an inner user metadata property**
|
|
230
255
|
*
|
|
231
|
-
*
|
|
232
|
-
*
|
|
256
|
+
* If there's existing user metadata to which we want to add `"home_address": "742 Evergreen Terrace"` (using the `addresses` property) we should send the whole `addresses` object. Since this is a first-level object, the object will be merged in, but its own properties will not be. The body to send should be:
|
|
257
|
+
*
|
|
258
|
+
* ```json
|
|
259
|
+
* {
|
|
233
260
|
* "user_metadata": {
|
|
234
261
|
* "addresses": {
|
|
235
262
|
* "work_address": "100 Industrial Way",
|
|
236
263
|
* "home_address": "742 Evergreen Terrace"
|
|
237
264
|
* }
|
|
238
265
|
* }
|
|
239
|
-
* }
|
|
266
|
+
* }
|
|
267
|
+
* ```
|
|
268
|
+
*
|
|
269
|
+
* The modified object ends up with the following `user_metadata` property:
|
|
240
270
|
*
|
|
241
|
-
*
|
|
242
|
-
*
|
|
271
|
+
* ```json
|
|
272
|
+
* {
|
|
243
273
|
* "user_metadata": {
|
|
244
274
|
* "profileCode": 1479,
|
|
245
275
|
* "addresses": {
|
|
@@ -247,7 +277,8 @@ export declare class UsersClient {
|
|
|
247
277
|
* "home_address": "742 Evergreen Terrace"
|
|
248
278
|
* }
|
|
249
279
|
* }
|
|
250
|
-
* }
|
|
280
|
+
* }
|
|
281
|
+
* ```
|
|
251
282
|
*
|
|
252
283
|
* @param {string} id - ID of the user to update.
|
|
253
284
|
* @param {Management.UpdateUserRequestContent} request
|
|
@@ -265,7 +296,7 @@ export declare class UsersClient {
|
|
|
265
296
|
update(id: string, request?: Management.UpdateUserRequestContent, requestOptions?: UsersClient.RequestOptions): core.HttpResponsePromise<Management.UpdateUserResponseContent>;
|
|
266
297
|
private __update;
|
|
267
298
|
/**
|
|
268
|
-
* Remove an existing multi-factor authentication (MFA)
|
|
299
|
+
* Remove an existing multi-factor authentication (MFA) [recovery code](https://auth0.com/docs/secure/multi-factor-authentication/reset-user-mfa) and generate a new one. If a user cannot access the original device or account used for MFA enrollment, they can use a recovery code to authenticate.
|
|
269
300
|
*
|
|
270
301
|
* @param {string} id - ID of the user to regenerate a multi-factor authentication recovery code for.
|
|
271
302
|
* @param {UsersClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -54,18 +54,20 @@ const Management = __importStar(require("../../../index.js"));
|
|
|
54
54
|
const Client_js_1 = require("../resources/authenticationMethods/client/Client.js");
|
|
55
55
|
const Client_js_2 = require("../resources/authenticators/client/Client.js");
|
|
56
56
|
const Client_js_3 = require("../resources/connectedAccounts/client/Client.js");
|
|
57
|
-
const Client_js_4 = require("../resources/
|
|
58
|
-
const Client_js_5 = require("../resources/
|
|
59
|
-
const Client_js_6 = require("../resources/
|
|
60
|
-
const Client_js_7 = require("../resources/
|
|
61
|
-
const Client_js_8 = require("../resources/
|
|
62
|
-
const Client_js_9 = require("../resources/
|
|
63
|
-
const Client_js_10 = require("../resources/
|
|
64
|
-
const Client_js_11 = require("../resources/
|
|
65
|
-
const Client_js_12 = require("../resources/
|
|
66
|
-
const Client_js_13 = require("../resources/
|
|
67
|
-
const Client_js_14 = require("../resources/
|
|
68
|
-
const Client_js_15 = require("../resources/
|
|
57
|
+
const Client_js_4 = require("../resources/effectivePermissions/client/Client.js");
|
|
58
|
+
const Client_js_5 = require("../resources/effectiveRoles/client/Client.js");
|
|
59
|
+
const Client_js_6 = require("../resources/enrollments/client/Client.js");
|
|
60
|
+
const Client_js_7 = require("../resources/federatedConnectionsTokensets/client/Client.js");
|
|
61
|
+
const Client_js_8 = require("../resources/groups/client/Client.js");
|
|
62
|
+
const Client_js_9 = require("../resources/identities/client/Client.js");
|
|
63
|
+
const Client_js_10 = require("../resources/logs/client/Client.js");
|
|
64
|
+
const Client_js_11 = require("../resources/multifactor/client/Client.js");
|
|
65
|
+
const Client_js_12 = require("../resources/organizations/client/Client.js");
|
|
66
|
+
const Client_js_13 = require("../resources/permissions/client/Client.js");
|
|
67
|
+
const Client_js_14 = require("../resources/refreshToken/client/Client.js");
|
|
68
|
+
const Client_js_15 = require("../resources/riskAssessments/client/Client.js");
|
|
69
|
+
const Client_js_16 = require("../resources/roles/client/Client.js");
|
|
70
|
+
const Client_js_17 = require("../resources/sessions/client/Client.js");
|
|
69
71
|
class UsersClient {
|
|
70
72
|
constructor(options) {
|
|
71
73
|
this._options = (0, BaseClient_js_1.normalizeClientOptionsWithAuth)(options);
|
|
@@ -82,53 +84,61 @@ class UsersClient {
|
|
|
82
84
|
var _a;
|
|
83
85
|
return ((_a = this._connectedAccounts) !== null && _a !== void 0 ? _a : (this._connectedAccounts = new Client_js_3.ConnectedAccountsClient(this._options)));
|
|
84
86
|
}
|
|
87
|
+
get effectivePermissions() {
|
|
88
|
+
var _a;
|
|
89
|
+
return ((_a = this._effectivePermissions) !== null && _a !== void 0 ? _a : (this._effectivePermissions = new Client_js_4.EffectivePermissionsClient(this._options)));
|
|
90
|
+
}
|
|
91
|
+
get effectiveRoles() {
|
|
92
|
+
var _a;
|
|
93
|
+
return ((_a = this._effectiveRoles) !== null && _a !== void 0 ? _a : (this._effectiveRoles = new Client_js_5.EffectiveRolesClient(this._options)));
|
|
94
|
+
}
|
|
85
95
|
get enrollments() {
|
|
86
96
|
var _a;
|
|
87
|
-
return ((_a = this._enrollments) !== null && _a !== void 0 ? _a : (this._enrollments = new
|
|
97
|
+
return ((_a = this._enrollments) !== null && _a !== void 0 ? _a : (this._enrollments = new Client_js_6.EnrollmentsClient(this._options)));
|
|
88
98
|
}
|
|
89
99
|
get federatedConnectionsTokensets() {
|
|
90
100
|
var _a;
|
|
91
|
-
return ((_a = this._federatedConnectionsTokensets) !== null && _a !== void 0 ? _a : (this._federatedConnectionsTokensets = new
|
|
101
|
+
return ((_a = this._federatedConnectionsTokensets) !== null && _a !== void 0 ? _a : (this._federatedConnectionsTokensets = new Client_js_7.FederatedConnectionsTokensetsClient(this._options)));
|
|
92
102
|
}
|
|
93
103
|
get groups() {
|
|
94
104
|
var _a;
|
|
95
|
-
return ((_a = this._groups) !== null && _a !== void 0 ? _a : (this._groups = new
|
|
105
|
+
return ((_a = this._groups) !== null && _a !== void 0 ? _a : (this._groups = new Client_js_8.GroupsClient(this._options)));
|
|
96
106
|
}
|
|
97
107
|
get identities() {
|
|
98
108
|
var _a;
|
|
99
|
-
return ((_a = this._identities) !== null && _a !== void 0 ? _a : (this._identities = new
|
|
109
|
+
return ((_a = this._identities) !== null && _a !== void 0 ? _a : (this._identities = new Client_js_9.IdentitiesClient(this._options)));
|
|
100
110
|
}
|
|
101
111
|
get logs() {
|
|
102
112
|
var _a;
|
|
103
|
-
return ((_a = this._logs) !== null && _a !== void 0 ? _a : (this._logs = new
|
|
113
|
+
return ((_a = this._logs) !== null && _a !== void 0 ? _a : (this._logs = new Client_js_10.LogsClient(this._options)));
|
|
104
114
|
}
|
|
105
115
|
get multifactor() {
|
|
106
116
|
var _a;
|
|
107
|
-
return ((_a = this._multifactor) !== null && _a !== void 0 ? _a : (this._multifactor = new
|
|
117
|
+
return ((_a = this._multifactor) !== null && _a !== void 0 ? _a : (this._multifactor = new Client_js_11.MultifactorClient(this._options)));
|
|
108
118
|
}
|
|
109
119
|
get organizations() {
|
|
110
120
|
var _a;
|
|
111
|
-
return ((_a = this._organizations) !== null && _a !== void 0 ? _a : (this._organizations = new
|
|
121
|
+
return ((_a = this._organizations) !== null && _a !== void 0 ? _a : (this._organizations = new Client_js_12.OrganizationsClient(this._options)));
|
|
112
122
|
}
|
|
113
123
|
get permissions() {
|
|
114
124
|
var _a;
|
|
115
|
-
return ((_a = this._permissions) !== null && _a !== void 0 ? _a : (this._permissions = new
|
|
125
|
+
return ((_a = this._permissions) !== null && _a !== void 0 ? _a : (this._permissions = new Client_js_13.PermissionsClient(this._options)));
|
|
116
126
|
}
|
|
117
127
|
get riskAssessments() {
|
|
118
128
|
var _a;
|
|
119
|
-
return ((_a = this._riskAssessments) !== null && _a !== void 0 ? _a : (this._riskAssessments = new
|
|
129
|
+
return ((_a = this._riskAssessments) !== null && _a !== void 0 ? _a : (this._riskAssessments = new Client_js_15.RiskAssessmentsClient(this._options)));
|
|
120
130
|
}
|
|
121
131
|
get roles() {
|
|
122
132
|
var _a;
|
|
123
|
-
return ((_a = this._roles) !== null && _a !== void 0 ? _a : (this._roles = new
|
|
133
|
+
return ((_a = this._roles) !== null && _a !== void 0 ? _a : (this._roles = new Client_js_16.RolesClient(this._options)));
|
|
124
134
|
}
|
|
125
135
|
get refreshToken() {
|
|
126
136
|
var _a;
|
|
127
|
-
return ((_a = this._refreshToken) !== null && _a !== void 0 ? _a : (this._refreshToken = new
|
|
137
|
+
return ((_a = this._refreshToken) !== null && _a !== void 0 ? _a : (this._refreshToken = new Client_js_14.RefreshTokenClient(this._options)));
|
|
128
138
|
}
|
|
129
139
|
get sessions() {
|
|
130
140
|
var _a;
|
|
131
|
-
return ((_a = this._sessions) !== null && _a !== void 0 ? _a : (this._sessions = new
|
|
141
|
+
return ((_a = this._sessions) !== null && _a !== void 0 ? _a : (this._sessions = new Client_js_17.SessionsClient(this._options)));
|
|
132
142
|
}
|
|
133
143
|
/**
|
|
134
144
|
* Retrieve details of users. It is possible to:
|
|
@@ -137,14 +147,18 @@ class UsersClient {
|
|
|
137
147
|
* - Sort the users to be returned
|
|
138
148
|
* - Select the fields to be returned
|
|
139
149
|
* - Specify the number of users to retrieve per page and the page index
|
|
140
|
-
* <!-- only v3 is available -->
|
|
141
|
-
* The <code>q</code> query parameter can be used to get users that match the specified criteria <a href="https://auth0.com/docs/users/search/v3/query-syntax">using query string syntax.</a>
|
|
142
150
|
*
|
|
143
|
-
* <a href="https://auth0.com/docs/users/search/v3">Learn more about searching for users.</a>
|
|
144
151
|
*
|
|
145
|
-
* Read about <a href="https://auth0.com/docs/users/search/best-practices">best practices</a> when working with the API endpoints for retrieving users.
|
|
146
152
|
*
|
|
147
|
-
*
|
|
153
|
+
* The `q` query parameter can be used to get users that match the specified criteria [using query string syntax.](https://auth0.com/docs/users/search/v3/query-syntax)
|
|
154
|
+
*
|
|
155
|
+
* [Learn more about searching for users.](https://auth0.com/docs/users/search/v3)
|
|
156
|
+
*
|
|
157
|
+
* Read about [best practices](https://auth0.com/docs/users/search/best-practices) when working with the API endpoints for retrieving users.
|
|
158
|
+
*
|
|
159
|
+
*
|
|
160
|
+
*
|
|
161
|
+
* Auth0 limits the number of users you can return. If you exceed this threshold, please redefine your search, use the [export job](https://auth0.com/docs/api/management/v2#!/Jobs/post_users_exports), or the [User Import / Export](https://auth0.com/docs/extensions/user-import-export) extension.
|
|
148
162
|
*
|
|
149
163
|
* @param {Management.ListUsersRequestParameters} request
|
|
150
164
|
* @param {UsersClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -246,9 +260,9 @@ class UsersClient {
|
|
|
246
260
|
});
|
|
247
261
|
}
|
|
248
262
|
/**
|
|
249
|
-
* Create a new user for a given
|
|
263
|
+
* Create a new user for a given [database](https://auth0.com/docs/connections/database) or [passwordless](https://auth0.com/docs/connections/passwordless) connection.
|
|
250
264
|
*
|
|
251
|
-
* Note:
|
|
265
|
+
* Note: `connection` is required but other parameters such as `email` and `password` are dependent upon the type of connection.
|
|
252
266
|
*
|
|
253
267
|
* @param {Management.CreateUserRequestContent} request
|
|
254
268
|
* @param {UsersClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -388,7 +402,7 @@ class UsersClient {
|
|
|
388
402
|
});
|
|
389
403
|
}
|
|
390
404
|
/**
|
|
391
|
-
* Retrieve user details. A list of fields to include or exclude may also be specified. For more information, see
|
|
405
|
+
* Retrieve user details. A list of fields to include or exclude may also be specified. For more information, see [Retrieve Users with the Get Users Endpoint](https://auth0.com/docs/manage-users/user-search/retrieve-users-with-get-users-endpoint).
|
|
392
406
|
*
|
|
393
407
|
* @param {string} id - ID of the user to retrieve.
|
|
394
408
|
* @param {Management.GetUserRequestParameters} request
|
|
@@ -461,7 +475,7 @@ class UsersClient {
|
|
|
461
475
|
});
|
|
462
476
|
}
|
|
463
477
|
/**
|
|
464
|
-
* Delete a user by user ID. This action cannot be undone. For Auth0 Dashboard instructions, see
|
|
478
|
+
* Delete a user by user ID. This action cannot be undone. For Auth0 Dashboard instructions, see [Delete Users](https://auth0.com/docs/manage-users/user-accounts/delete-users).
|
|
465
479
|
*
|
|
466
480
|
* @param {string} id - ID of the user to delete.
|
|
467
481
|
* @param {UsersClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -522,64 +536,84 @@ class UsersClient {
|
|
|
522
536
|
*
|
|
523
537
|
* These are the attributes that can be updated at the root level:
|
|
524
538
|
*
|
|
525
|
-
*
|
|
526
|
-
*
|
|
527
|
-
*
|
|
528
|
-
*
|
|
529
|
-
*
|
|
530
|
-
*
|
|
531
|
-
*
|
|
532
|
-
*
|
|
533
|
-
*
|
|
534
|
-
*
|
|
535
|
-
*
|
|
536
|
-
*
|
|
537
|
-
*
|
|
538
|
-
*
|
|
539
|
-
*
|
|
540
|
-
* <li>verify_email</li>
|
|
541
|
-
* </ul>
|
|
539
|
+
* - app_metadata
|
|
540
|
+
* - blocked
|
|
541
|
+
* - email
|
|
542
|
+
* - email_verified
|
|
543
|
+
* - family_name
|
|
544
|
+
* - given_name
|
|
545
|
+
* - name
|
|
546
|
+
* - nickname
|
|
547
|
+
* - password
|
|
548
|
+
* - phone_number
|
|
549
|
+
* - phone_verified
|
|
550
|
+
* - picture
|
|
551
|
+
* - username
|
|
552
|
+
* - user_metadata
|
|
553
|
+
* - verify_email
|
|
542
554
|
*
|
|
543
555
|
* Some considerations:
|
|
544
|
-
*
|
|
545
|
-
*
|
|
546
|
-
*
|
|
547
|
-
*
|
|
548
|
-
*
|
|
549
|
-
*
|
|
550
|
-
*
|
|
551
|
-
*
|
|
552
|
-
*
|
|
553
|
-
*
|
|
554
|
-
*
|
|
556
|
+
*
|
|
557
|
+
* - The properties of the new object will replace the old ones.
|
|
558
|
+
* - The metadata fields are an exception to this rule (`user_metadata` and `app_metadata`). These properties are merged instead of being replaced but be careful, the merge only occurs on the first level.
|
|
559
|
+
* - If you are updating `email`, `email_verified`, `phone_number`, `phone_verified`, `username` or `password` of a secondary identity, you need to specify the `connection` property too.
|
|
560
|
+
* - If you are updating `email` or `phone_number` you can specify, optionally, the `client_id` property.
|
|
561
|
+
* - Updating `email_verified` is not supported for enterprise and passwordless sms connections.
|
|
562
|
+
* - Updating the `blocked` to `false` does not affect the user's blocked state from an excessive amount of incorrectly provided credentials. Use the "Unblock a user" endpoint from the "User Blocks" API to change the user's state.
|
|
563
|
+
* - Supported attributes can be unset by supplying `null` as the value.
|
|
564
|
+
*
|
|
565
|
+
* **Updating a field (non-metadata property)**
|
|
566
|
+
*
|
|
555
567
|
* To mark the email address of a user as verified, the body to send should be:
|
|
556
|
-
* <pre><code>{ "email_verified": true }</code></pre>
|
|
557
568
|
*
|
|
558
|
-
*
|
|
559
|
-
*
|
|
569
|
+
* ```json
|
|
570
|
+
* { "email_verified": true }
|
|
571
|
+
* ```
|
|
572
|
+
*
|
|
573
|
+
* **Updating a user metadata root property**
|
|
574
|
+
*
|
|
575
|
+
* Let's assume that our test user has the following `user_metadata`:
|
|
576
|
+
*
|
|
577
|
+
* ```json
|
|
578
|
+
* { "user_metadata" : { "profileCode": 1479 } }
|
|
579
|
+
* ```
|
|
560
580
|
*
|
|
561
|
-
* To add the field
|
|
562
|
-
* <pre><code>{ "user_metadata" : { "addresses": {"work_address": "100 Industrial Way"} }}</code></pre>
|
|
581
|
+
* To add the field `addresses` the body to send should be:
|
|
563
582
|
*
|
|
564
|
-
*
|
|
583
|
+
* ```json
|
|
584
|
+
* { "user_metadata" : { "addresses": {"work_address": "100 Industrial Way"} }}
|
|
585
|
+
* ```
|
|
586
|
+
*
|
|
587
|
+
* The modified object ends up with the following `user_metadata` property:
|
|
588
|
+
*
|
|
589
|
+
* ```json
|
|
590
|
+
* {
|
|
565
591
|
* "user_metadata": {
|
|
566
592
|
* "profileCode": 1479,
|
|
567
593
|
* "addresses": { "work_address": "100 Industrial Way" }
|
|
568
594
|
* }
|
|
569
|
-
* }
|
|
595
|
+
* }
|
|
596
|
+
* ```
|
|
597
|
+
*
|
|
598
|
+
* **Updating an inner user metadata property**
|
|
570
599
|
*
|
|
571
|
-
*
|
|
572
|
-
*
|
|
600
|
+
* If there's existing user metadata to which we want to add `"home_address": "742 Evergreen Terrace"` (using the `addresses` property) we should send the whole `addresses` object. Since this is a first-level object, the object will be merged in, but its own properties will not be. The body to send should be:
|
|
601
|
+
*
|
|
602
|
+
* ```json
|
|
603
|
+
* {
|
|
573
604
|
* "user_metadata": {
|
|
574
605
|
* "addresses": {
|
|
575
606
|
* "work_address": "100 Industrial Way",
|
|
576
607
|
* "home_address": "742 Evergreen Terrace"
|
|
577
608
|
* }
|
|
578
609
|
* }
|
|
579
|
-
* }
|
|
610
|
+
* }
|
|
611
|
+
* ```
|
|
612
|
+
*
|
|
613
|
+
* The modified object ends up with the following `user_metadata` property:
|
|
580
614
|
*
|
|
581
|
-
*
|
|
582
|
-
*
|
|
615
|
+
* ```json
|
|
616
|
+
* {
|
|
583
617
|
* "user_metadata": {
|
|
584
618
|
* "profileCode": 1479,
|
|
585
619
|
* "addresses": {
|
|
@@ -587,7 +621,8 @@ class UsersClient {
|
|
|
587
621
|
* "home_address": "742 Evergreen Terrace"
|
|
588
622
|
* }
|
|
589
623
|
* }
|
|
590
|
-
* }
|
|
624
|
+
* }
|
|
625
|
+
* ```
|
|
591
626
|
*
|
|
592
627
|
* @param {string} id - ID of the user to update.
|
|
593
628
|
* @param {Management.UpdateUserRequestContent} request
|
|
@@ -651,7 +686,7 @@ class UsersClient {
|
|
|
651
686
|
});
|
|
652
687
|
}
|
|
653
688
|
/**
|
|
654
|
-
* Remove an existing multi-factor authentication (MFA)
|
|
689
|
+
* Remove an existing multi-factor authentication (MFA) [recovery code](https://auth0.com/docs/secure/multi-factor-authentication/reset-user-mfa) and generate a new one. If a user cannot access the original device or account used for MFA enrollment, they can use a recovery code to authenticate.
|
|
655
690
|
*
|
|
656
691
|
* @param {string} id - ID of the user to regenerate a multi-factor authentication recovery code for.
|
|
657
692
|
* @param {UsersClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -10,7 +10,7 @@ export declare class AuthenticatorsClient {
|
|
|
10
10
|
protected readonly _options: NormalizedClientOptionsWithAuth<AuthenticatorsClient.Options>;
|
|
11
11
|
constructor(options: AuthenticatorsClient.Options);
|
|
12
12
|
/**
|
|
13
|
-
* Remove all authenticators registered to a given user ID, such as OTP, email, phone, and push-notification. This action cannot be undone. For more information, review
|
|
13
|
+
* Remove all authenticators registered to a given user ID, such as OTP, email, phone, and push-notification. This action cannot be undone. For more information, review [Manage Authentication Methods with Management API](https://auth0.com/docs/secure/multi-factor-authentication/manage-mfa-auth0-apis/manage-authentication-methods-with-management-api).
|
|
14
14
|
*
|
|
15
15
|
* @param {string} id - ID of the user to delete.
|
|
16
16
|
* @param {AuthenticatorsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -56,7 +56,7 @@ class AuthenticatorsClient {
|
|
|
56
56
|
this._options = (0, BaseClient_js_1.normalizeClientOptionsWithAuth)(options);
|
|
57
57
|
}
|
|
58
58
|
/**
|
|
59
|
-
* Remove all authenticators registered to a given user ID, such as OTP, email, phone, and push-notification. This action cannot be undone. For more information, review
|
|
59
|
+
* Remove all authenticators registered to a given user ID, such as OTP, email, phone, and push-notification. This action cannot be undone. For more information, review [Manage Authentication Methods with Management API](https://auth0.com/docs/secure/multi-factor-authentication/manage-mfa-auth0-apis/manage-authentication-methods-with-management-api).
|
|
60
60
|
*
|
|
61
61
|
* @param {string} id - ID of the user to delete.
|
|
62
62
|
* @param {AuthenticatorsClient.RequestOptions} requestOptions - Request-specific configuration.
|
package/dist/cjs/management/api/resources/users/resources/effectivePermissions/client/Client.d.ts
ADDED
|
@@ -0,0 +1,37 @@
|
|
|
1
|
+
import type { BaseClientOptions, BaseRequestOptions } from "../../../../../../BaseClient.js";
|
|
2
|
+
import { type NormalizedClientOptionsWithAuth } from "../../../../../../BaseClient.js";
|
|
3
|
+
import * as core from "../../../../../../core/index.js";
|
|
4
|
+
import * as Management from "../../../../../index.js";
|
|
5
|
+
import { SourcesClient } from "../resources/sources/client/Client.js";
|
|
6
|
+
export declare namespace EffectivePermissionsClient {
|
|
7
|
+
type Options = BaseClientOptions;
|
|
8
|
+
interface RequestOptions extends BaseRequestOptions {
|
|
9
|
+
}
|
|
10
|
+
}
|
|
11
|
+
export declare class EffectivePermissionsClient {
|
|
12
|
+
protected readonly _options: NormalizedClientOptionsWithAuth<EffectivePermissionsClient.Options>;
|
|
13
|
+
protected _sources: SourcesClient | undefined;
|
|
14
|
+
constructor(options: EffectivePermissionsClient.Options);
|
|
15
|
+
get sources(): SourcesClient;
|
|
16
|
+
/**
|
|
17
|
+
* Returns the list of effective permissions for a user, taking into account permissions granted directly to the user, as well as those inherited through roles and group memberships.
|
|
18
|
+
*
|
|
19
|
+
* @param {string} id - ID of the user to retrieve the permissions for.
|
|
20
|
+
* @param {Management.ListUserEffectivePermissionsRequestParameters} request
|
|
21
|
+
* @param {EffectivePermissionsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
22
|
+
*
|
|
23
|
+
* @throws {@link Management.BadRequestError}
|
|
24
|
+
* @throws {@link Management.UnauthorizedError}
|
|
25
|
+
* @throws {@link Management.ForbiddenError}
|
|
26
|
+
* @throws {@link Management.NotFoundError}
|
|
27
|
+
* @throws {@link Management.TooManyRequestsError}
|
|
28
|
+
*
|
|
29
|
+
* @example
|
|
30
|
+
* await client.users.effectivePermissions.list("id", {
|
|
31
|
+
* from: "from",
|
|
32
|
+
* take: 1,
|
|
33
|
+
* resource_server_identifier: "resource_server_identifier"
|
|
34
|
+
* })
|
|
35
|
+
*/
|
|
36
|
+
list(id: string, request: Management.ListUserEffectivePermissionsRequestParameters, requestOptions?: EffectivePermissionsClient.RequestOptions): Promise<core.Page<Management.UserEffectivePermissionResponseContent, Management.ListUserEffectivePermissionsResponseContent>>;
|
|
37
|
+
}
|