auth0 5.10.0 → 5.12.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/lib/retry.d.ts +7 -2
- package/dist/cjs/lib/retry.js +35 -5
- 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 +271 -2
- 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/phone/resources/providers/client/Client.d.ts +6 -6
- package/dist/cjs/management/api/resources/branding/resources/phone/resources/providers/client/Client.js +6 -6
- 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/clientGrants/client/Client.d.ts +4 -4
- package/dist/cjs/management/api/resources/clientGrants/client/Client.js +4 -4
- package/dist/cjs/management/api/resources/clientGrants/resources/organizations/client/Client.d.ts +1 -0
- package/dist/cjs/management/api/resources/clientGrants/resources/organizations/client/Client.js +3 -0
- package/dist/cjs/management/api/resources/clients/client/Client.d.ts +72 -80
- package/dist/cjs/management/api/resources/clients/client/Client.js +72 -80
- package/dist/cjs/management/api/resources/clients/resources/connections/client/Client.d.ts +4 -9
- package/dist/cjs/management/api/resources/clients/resources/connections/client/Client.js +4 -9
- package/dist/cjs/management/api/resources/clients/resources/credentials/client/Client.d.ts +38 -14
- package/dist/cjs/management/api/resources/clients/resources/credentials/client/Client.js +38 -14
- package/dist/cjs/management/api/resources/connectionProfiles/client/Client.d.ts +1 -0
- package/dist/cjs/management/api/resources/connectionProfiles/client/Client.js +3 -0
- 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/connections/resources/users/client/Client.d.ts +1 -0
- package/dist/cjs/management/api/resources/connections/resources/users/client/Client.js +3 -0
- package/dist/cjs/management/api/resources/customDomains/client/Client.d.ts +20 -12
- package/dist/cjs/management/api/resources/customDomains/client/Client.js +22 -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/emails/resources/provider/client/Client.d.ts +50 -81
- package/dist/cjs/management/api/resources/emails/resources/provider/client/Client.js +50 -81
- 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/members/client/Client.d.ts +1 -0
- package/dist/cjs/management/api/resources/groups/resources/members/client/Client.js +3 -0
- package/dist/cjs/management/api/resources/groups/resources/roles/client/Client.d.ts +73 -0
- package/dist/cjs/management/api/resources/groups/resources/roles/client/Client.js +276 -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 +16 -13
- package/dist/cjs/management/api/resources/organizations/client/Client.js +26 -17
- package/dist/cjs/management/api/resources/organizations/resources/connections/client/Client.d.ts +1 -0
- package/dist/cjs/management/api/resources/organizations/resources/connections/client/Client.js +3 -0
- 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 +7 -2
- package/dist/cjs/management/api/resources/organizations/resources/enabledConnections/client/Client.js +17 -2
- package/dist/cjs/management/api/resources/organizations/resources/groups/client/Client.d.ts +36 -0
- package/dist/cjs/management/api/resources/organizations/resources/groups/client/Client.js +149 -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 +77 -0
- package/dist/cjs/management/api/resources/organizations/resources/groups/resources/roles/client/Client.js +282 -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 +10 -12
- package/dist/cjs/management/api/resources/organizations/resources/members/client/Client.js +16 -14
- package/dist/cjs/management/api/resources/organizations/resources/members/resources/effectiveRoles/client/Client.d.ts +37 -0
- package/dist/cjs/management/api/resources/organizations/resources/members/resources/effectiveRoles/client/Client.js +150 -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 +35 -0
- package/dist/cjs/management/api/resources/organizations/resources/members/resources/effectiveRoles/resources/sources/resources/groups/client/Client.js +147 -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 +3 -2
- package/dist/cjs/management/api/resources/organizations/resources/members/resources/roles/client/Client.js +5 -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/refreshTokens/client/Client.d.ts +1 -1
- package/dist/cjs/management/api/resources/refreshTokens/client/Client.js +1 -1
- 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 +73 -0
- package/dist/cjs/management/api/resources/roles/resources/groups/client/Client.js +276 -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 +3 -2
- package/dist/cjs/management/api/resources/roles/resources/permissions/client/Client.js +5 -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/selfServiceProfiles/resources/ssoTicket/client/Client.d.ts +1 -0
- package/dist/cjs/management/api/resources/selfServiceProfiles/resources/ssoTicket/client/Client.js +3 -0
- package/dist/cjs/management/api/resources/tokenExchangeProfiles/client/Client.d.ts +10 -12
- package/dist/cjs/management/api/resources/tokenExchangeProfiles/client/Client.js +12 -12
- package/dist/cjs/management/api/resources/userAttributeProfiles/client/Client.d.ts +2 -1
- package/dist/cjs/management/api/resources/userAttributeProfiles/client/Client.js +4 -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/userGrants/client/Client.d.ts +1 -1
- package/dist/cjs/management/api/resources/userGrants/client/Client.js +1 -1
- 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 +36 -0
- package/dist/cjs/management/api/resources/users/resources/effectiveRoles/client/Client.js +149 -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 +34 -0
- package/dist/cjs/management/api/resources/users/resources/effectiveRoles/resources/sources/resources/groups/client/Client.js +146 -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/groups/client/Client.d.ts +1 -0
- package/dist/cjs/management/api/resources/users/resources/groups/client/Client.js +3 -0
- 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 +2 -1
- package/dist/cjs/management/api/resources/users/resources/organizations/client/Client.js +4 -1
- package/dist/cjs/management/api/resources/users/resources/permissions/client/Client.d.ts +2 -0
- package/dist/cjs/management/api/resources/users/resources/permissions/client/Client.js +6 -0
- 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 +543 -128
- package/dist/cjs/management/api/types/types.js +120 -46
- 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/lib/retry.d.mts +7 -2
- package/dist/esm/lib/retry.mjs +35 -5
- 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 +271 -2
- 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/phone/resources/providers/client/Client.d.mts +6 -6
- package/dist/esm/management/api/resources/branding/resources/phone/resources/providers/client/Client.mjs +6 -6
- 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/clientGrants/client/Client.d.mts +4 -4
- package/dist/esm/management/api/resources/clientGrants/client/Client.mjs +4 -4
- package/dist/esm/management/api/resources/clientGrants/resources/organizations/client/Client.d.mts +1 -0
- package/dist/esm/management/api/resources/clientGrants/resources/organizations/client/Client.mjs +3 -0
- package/dist/esm/management/api/resources/clients/client/Client.d.mts +72 -80
- package/dist/esm/management/api/resources/clients/client/Client.mjs +72 -80
- package/dist/esm/management/api/resources/clients/resources/connections/client/Client.d.mts +4 -9
- package/dist/esm/management/api/resources/clients/resources/connections/client/Client.mjs +4 -9
- package/dist/esm/management/api/resources/clients/resources/credentials/client/Client.d.mts +38 -14
- package/dist/esm/management/api/resources/clients/resources/credentials/client/Client.mjs +38 -14
- package/dist/esm/management/api/resources/connectionProfiles/client/Client.d.mts +1 -0
- package/dist/esm/management/api/resources/connectionProfiles/client/Client.mjs +3 -0
- 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/connections/resources/users/client/Client.d.mts +1 -0
- package/dist/esm/management/api/resources/connections/resources/users/client/Client.mjs +3 -0
- package/dist/esm/management/api/resources/customDomains/client/Client.d.mts +20 -12
- package/dist/esm/management/api/resources/customDomains/client/Client.mjs +22 -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/emails/resources/provider/client/Client.d.mts +50 -81
- package/dist/esm/management/api/resources/emails/resources/provider/client/Client.mjs +50 -81
- 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/members/client/Client.d.mts +1 -0
- package/dist/esm/management/api/resources/groups/resources/members/client/Client.mjs +3 -0
- package/dist/esm/management/api/resources/groups/resources/roles/client/Client.d.mts +73 -0
- package/dist/esm/management/api/resources/groups/resources/roles/client/Client.mjs +239 -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 +16 -13
- package/dist/esm/management/api/resources/organizations/client/Client.mjs +22 -13
- package/dist/esm/management/api/resources/organizations/resources/connections/client/Client.d.mts +1 -0
- package/dist/esm/management/api/resources/organizations/resources/connections/client/Client.mjs +3 -0
- 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 +7 -2
- package/dist/esm/management/api/resources/organizations/resources/enabledConnections/client/Client.mjs +17 -2
- package/dist/esm/management/api/resources/organizations/resources/groups/client/Client.d.mts +36 -0
- package/dist/esm/management/api/resources/organizations/resources/groups/client/Client.mjs +112 -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 +77 -0
- package/dist/esm/management/api/resources/organizations/resources/groups/resources/roles/client/Client.mjs +245 -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 +10 -12
- package/dist/esm/management/api/resources/organizations/resources/members/client/Client.mjs +14 -12
- package/dist/esm/management/api/resources/organizations/resources/members/resources/effectiveRoles/client/Client.d.mts +37 -0
- package/dist/esm/management/api/resources/organizations/resources/members/resources/effectiveRoles/client/Client.mjs +113 -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 +35 -0
- package/dist/esm/management/api/resources/organizations/resources/members/resources/effectiveRoles/resources/sources/resources/groups/client/Client.mjs +110 -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 +3 -2
- package/dist/esm/management/api/resources/organizations/resources/members/resources/roles/client/Client.mjs +5 -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/refreshTokens/client/Client.d.mts +1 -1
- package/dist/esm/management/api/resources/refreshTokens/client/Client.mjs +1 -1
- 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 +73 -0
- package/dist/esm/management/api/resources/roles/resources/groups/client/Client.mjs +239 -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 +3 -2
- package/dist/esm/management/api/resources/roles/resources/permissions/client/Client.mjs +5 -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/selfServiceProfiles/resources/ssoTicket/client/Client.d.mts +1 -0
- package/dist/esm/management/api/resources/selfServiceProfiles/resources/ssoTicket/client/Client.mjs +3 -0
- package/dist/esm/management/api/resources/tokenExchangeProfiles/client/Client.d.mts +10 -12
- package/dist/esm/management/api/resources/tokenExchangeProfiles/client/Client.mjs +12 -12
- package/dist/esm/management/api/resources/userAttributeProfiles/client/Client.d.mts +2 -1
- package/dist/esm/management/api/resources/userAttributeProfiles/client/Client.mjs +4 -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/userGrants/client/Client.d.mts +1 -1
- package/dist/esm/management/api/resources/userGrants/client/Client.mjs +1 -1
- 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 +36 -0
- package/dist/esm/management/api/resources/users/resources/effectiveRoles/client/Client.mjs +112 -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 +34 -0
- package/dist/esm/management/api/resources/users/resources/effectiveRoles/resources/sources/resources/groups/client/Client.mjs +109 -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/groups/client/Client.d.mts +1 -0
- package/dist/esm/management/api/resources/users/resources/groups/client/Client.mjs +3 -0
- 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 +2 -1
- package/dist/esm/management/api/resources/users/resources/organizations/client/Client.mjs +4 -1
- package/dist/esm/management/api/resources/users/resources/permissions/client/Client.d.mts +2 -0
- package/dist/esm/management/api/resources/users/resources/permissions/client/Client.mjs +6 -0
- 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 +543 -128
- package/dist/esm/management/api/types/types.mjs +107 -33
- 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 +3500 -1842
|
@@ -13,15 +13,14 @@ export declare class TokenExchangeProfilesClient {
|
|
|
13
13
|
/**
|
|
14
14
|
* Retrieve a list of all Token Exchange Profiles available in your tenant.
|
|
15
15
|
*
|
|
16
|
-
* By using this feature, you agree to the applicable Free Trial terms in
|
|
16
|
+
* By using this feature, you agree to the applicable Free Trial terms in [Okta’s Master Subscription Agreement](https://www.okta.com/legal/). It is your responsibility to securely validate the user’s subject_token. See [User Guide](https://auth0.com/docs/authenticate/custom-token-exchange) for more details.
|
|
17
17
|
*
|
|
18
18
|
* This endpoint supports Checkpoint pagination. To search by checkpoint, use the following parameters:
|
|
19
|
-
* <ul>
|
|
20
|
-
* <li><code>from</code>: Optional id from which to start selection.</li>
|
|
21
|
-
* <li><code>take</code>: The total amount of entries to retrieve when using the from parameter. Defaults to 50.</li>
|
|
22
|
-
* </ul>
|
|
23
19
|
*
|
|
24
|
-
*
|
|
20
|
+
* - `from`: Optional id from which to start selection.
|
|
21
|
+
* - `take`: The total amount of entries to retrieve when using the from parameter. Defaults to 50.
|
|
22
|
+
*
|
|
23
|
+
* **Note**: The first time you call this endpoint using checkpoint pagination, omit the `from` parameter. If there are more results, a `next` value is included in the response. You can use this for subsequent API calls. When `next` is no longer included in the response, no pages are remaining.
|
|
25
24
|
*
|
|
26
25
|
* @param {Management.TokenExchangeProfilesListRequest} request
|
|
27
26
|
* @param {TokenExchangeProfilesClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -41,7 +40,7 @@ export declare class TokenExchangeProfilesClient {
|
|
|
41
40
|
/**
|
|
42
41
|
* Create a new Token Exchange Profile within your tenant.
|
|
43
42
|
*
|
|
44
|
-
* By using this feature, you agree to the applicable Free Trial terms in
|
|
43
|
+
* By using this feature, you agree to the applicable Free Trial terms in [Okta’s Master Subscription Agreement](https://www.okta.com/legal/). It is your responsibility to securely validate the user’s subject_token. See [User Guide](https://auth0.com/docs/authenticate/custom-token-exchange) for more details.
|
|
45
44
|
*
|
|
46
45
|
* @param {Management.CreateTokenExchangeProfileRequestContent} request
|
|
47
46
|
* @param {TokenExchangeProfilesClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -65,7 +64,7 @@ export declare class TokenExchangeProfilesClient {
|
|
|
65
64
|
/**
|
|
66
65
|
* Retrieve details about a single Token Exchange Profile specified by ID.
|
|
67
66
|
*
|
|
68
|
-
* By using this feature, you agree to the applicable Free Trial terms in
|
|
67
|
+
* By using this feature, you agree to the applicable Free Trial terms in [Okta’s Master Subscription Agreement](https://www.okta.com/legal/). It is your responsibility to securely validate the user’s subject_token. See [User Guide](https://auth0.com/docs/authenticate/custom-token-exchange) for more details.
|
|
69
68
|
*
|
|
70
69
|
* @param {string} id - ID of the Token Exchange Profile to retrieve.
|
|
71
70
|
* @param {TokenExchangeProfilesClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -84,8 +83,7 @@ export declare class TokenExchangeProfilesClient {
|
|
|
84
83
|
/**
|
|
85
84
|
* Delete a Token Exchange Profile within your tenant.
|
|
86
85
|
*
|
|
87
|
-
* By using this feature, you agree to the applicable Free Trial terms in
|
|
88
|
-
*
|
|
86
|
+
* By using this feature, you agree to the applicable Free Trial terms in [Okta's Master Subscription Agreement](https://www.okta.com/legal/). It is your responsibility to securely validate the user's subject_token. See [User Guide](https://auth0.com/docs/authenticate/custom-token-exchange) for more details.
|
|
89
87
|
*
|
|
90
88
|
* @param {string} id - ID of the Token Exchange Profile to delete.
|
|
91
89
|
* @param {TokenExchangeProfilesClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -102,8 +100,7 @@ export declare class TokenExchangeProfilesClient {
|
|
|
102
100
|
/**
|
|
103
101
|
* Update a Token Exchange Profile within your tenant.
|
|
104
102
|
*
|
|
105
|
-
* By using this feature, you agree to the applicable Free Trial terms in
|
|
106
|
-
*
|
|
103
|
+
* By using this feature, you agree to the applicable Free Trial terms in [Okta's Master Subscription Agreement](https://www.okta.com/legal/). It is your responsibility to securely validate the user's subject_token. See [User Guide](https://auth0.com/docs/authenticate/custom-token-exchange) for more details.
|
|
107
104
|
*
|
|
108
105
|
* @param {string} id - ID of the Token Exchange Profile to update.
|
|
109
106
|
* @param {Management.UpdateTokenExchangeProfileRequestContent} request
|
|
@@ -113,6 +110,7 @@ export declare class TokenExchangeProfilesClient {
|
|
|
113
110
|
* @throws {@link Management.UnauthorizedError}
|
|
114
111
|
* @throws {@link Management.ForbiddenError}
|
|
115
112
|
* @throws {@link Management.NotFoundError}
|
|
113
|
+
* @throws {@link Management.ConflictError}
|
|
116
114
|
* @throws {@link Management.TooManyRequestsError}
|
|
117
115
|
*
|
|
118
116
|
* @example
|
|
@@ -58,15 +58,14 @@ class TokenExchangeProfilesClient {
|
|
|
58
58
|
/**
|
|
59
59
|
* Retrieve a list of all Token Exchange Profiles available in your tenant.
|
|
60
60
|
*
|
|
61
|
-
* By using this feature, you agree to the applicable Free Trial terms in
|
|
61
|
+
* By using this feature, you agree to the applicable Free Trial terms in [Okta’s Master Subscription Agreement](https://www.okta.com/legal/). It is your responsibility to securely validate the user’s subject_token. See [User Guide](https://auth0.com/docs/authenticate/custom-token-exchange) for more details.
|
|
62
62
|
*
|
|
63
63
|
* This endpoint supports Checkpoint pagination. To search by checkpoint, use the following parameters:
|
|
64
|
-
* <ul>
|
|
65
|
-
* <li><code>from</code>: Optional id from which to start selection.</li>
|
|
66
|
-
* <li><code>take</code>: The total amount of entries to retrieve when using the from parameter. Defaults to 50.</li>
|
|
67
|
-
* </ul>
|
|
68
64
|
*
|
|
69
|
-
*
|
|
65
|
+
* - `from`: Optional id from which to start selection.
|
|
66
|
+
* - `take`: The total amount of entries to retrieve when using the from parameter. Defaults to 50.
|
|
67
|
+
*
|
|
68
|
+
* **Note**: The first time you call this endpoint using checkpoint pagination, omit the `from` parameter. If there are more results, a `next` value is included in the response. You can use this for subsequent API calls. When `next` is no longer included in the response, no pages are remaining.
|
|
70
69
|
*
|
|
71
70
|
* @param {Management.TokenExchangeProfilesListRequest} request
|
|
72
71
|
* @param {TokenExchangeProfilesClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -149,7 +148,7 @@ class TokenExchangeProfilesClient {
|
|
|
149
148
|
/**
|
|
150
149
|
* Create a new Token Exchange Profile within your tenant.
|
|
151
150
|
*
|
|
152
|
-
* By using this feature, you agree to the applicable Free Trial terms in
|
|
151
|
+
* By using this feature, you agree to the applicable Free Trial terms in [Okta’s Master Subscription Agreement](https://www.okta.com/legal/). It is your responsibility to securely validate the user’s subject_token. See [User Guide](https://auth0.com/docs/authenticate/custom-token-exchange) for more details.
|
|
153
152
|
*
|
|
154
153
|
* @param {Management.CreateTokenExchangeProfileRequestContent} request
|
|
155
154
|
* @param {TokenExchangeProfilesClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -222,7 +221,7 @@ class TokenExchangeProfilesClient {
|
|
|
222
221
|
/**
|
|
223
222
|
* Retrieve details about a single Token Exchange Profile specified by ID.
|
|
224
223
|
*
|
|
225
|
-
* By using this feature, you agree to the applicable Free Trial terms in
|
|
224
|
+
* By using this feature, you agree to the applicable Free Trial terms in [Okta’s Master Subscription Agreement](https://www.okta.com/legal/). It is your responsibility to securely validate the user’s subject_token. See [User Guide](https://auth0.com/docs/authenticate/custom-token-exchange) for more details.
|
|
226
225
|
*
|
|
227
226
|
* @param {string} id - ID of the Token Exchange Profile to retrieve.
|
|
228
227
|
* @param {TokenExchangeProfilesClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -287,8 +286,7 @@ class TokenExchangeProfilesClient {
|
|
|
287
286
|
/**
|
|
288
287
|
* Delete a Token Exchange Profile within your tenant.
|
|
289
288
|
*
|
|
290
|
-
* By using this feature, you agree to the applicable Free Trial terms in
|
|
291
|
-
*
|
|
289
|
+
* By using this feature, you agree to the applicable Free Trial terms in [Okta's Master Subscription Agreement](https://www.okta.com/legal/). It is your responsibility to securely validate the user's subject_token. See [User Guide](https://auth0.com/docs/authenticate/custom-token-exchange) for more details.
|
|
292
290
|
*
|
|
293
291
|
* @param {string} id - ID of the Token Exchange Profile to delete.
|
|
294
292
|
* @param {TokenExchangeProfilesClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -344,8 +342,7 @@ class TokenExchangeProfilesClient {
|
|
|
344
342
|
/**
|
|
345
343
|
* Update a Token Exchange Profile within your tenant.
|
|
346
344
|
*
|
|
347
|
-
* By using this feature, you agree to the applicable Free Trial terms in
|
|
348
|
-
*
|
|
345
|
+
* By using this feature, you agree to the applicable Free Trial terms in [Okta's Master Subscription Agreement](https://www.okta.com/legal/). It is your responsibility to securely validate the user's subject_token. See [User Guide](https://auth0.com/docs/authenticate/custom-token-exchange) for more details.
|
|
349
346
|
*
|
|
350
347
|
* @param {string} id - ID of the Token Exchange Profile to update.
|
|
351
348
|
* @param {Management.UpdateTokenExchangeProfileRequestContent} request
|
|
@@ -355,6 +352,7 @@ class TokenExchangeProfilesClient {
|
|
|
355
352
|
* @throws {@link Management.UnauthorizedError}
|
|
356
353
|
* @throws {@link Management.ForbiddenError}
|
|
357
354
|
* @throws {@link Management.NotFoundError}
|
|
355
|
+
* @throws {@link Management.ConflictError}
|
|
358
356
|
* @throws {@link Management.TooManyRequestsError}
|
|
359
357
|
*
|
|
360
358
|
* @example
|
|
@@ -395,6 +393,8 @@ class TokenExchangeProfilesClient {
|
|
|
395
393
|
throw new Management.ForbiddenError(_response.error.body, _response.rawResponse);
|
|
396
394
|
case 404:
|
|
397
395
|
throw new Management.NotFoundError(_response.error.body, _response.rawResponse);
|
|
396
|
+
case 409:
|
|
397
|
+
throw new Management.ConflictError(_response.error.body, _response.rawResponse);
|
|
398
398
|
case 429:
|
|
399
399
|
throw new Management.TooManyRequestsError(_response.error.body, _response.rawResponse);
|
|
400
400
|
default:
|
|
@@ -29,7 +29,7 @@ export declare class UserAttributeProfilesClient {
|
|
|
29
29
|
*/
|
|
30
30
|
list(request?: Management.ListUserAttributeProfileRequestParameters, requestOptions?: UserAttributeProfilesClient.RequestOptions): Promise<core.Page<Management.UserAttributeProfile, Management.ListUserAttributeProfilesPaginatedResponseContent>>;
|
|
31
31
|
/**
|
|
32
|
-
* Create a User Attribute Profile
|
|
32
|
+
* Create a User Attribute Profile.
|
|
33
33
|
*
|
|
34
34
|
* @param {Management.CreateUserAttributeProfileRequestContent} request
|
|
35
35
|
* @param {UserAttributeProfilesClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -126,6 +126,7 @@ export declare class UserAttributeProfilesClient {
|
|
|
126
126
|
* @throws {@link Management.BadRequestError}
|
|
127
127
|
* @throws {@link Management.UnauthorizedError}
|
|
128
128
|
* @throws {@link Management.ForbiddenError}
|
|
129
|
+
* @throws {@link Management.NotFoundError}
|
|
129
130
|
* @throws {@link Management.TooManyRequestsError}
|
|
130
131
|
*
|
|
131
132
|
* @example
|
|
@@ -137,7 +137,7 @@ class UserAttributeProfilesClient {
|
|
|
137
137
|
});
|
|
138
138
|
}
|
|
139
139
|
/**
|
|
140
|
-
* Create a User Attribute Profile
|
|
140
|
+
* Create a User Attribute Profile.
|
|
141
141
|
*
|
|
142
142
|
* @param {Management.CreateUserAttributeProfileRequestContent} request
|
|
143
143
|
* @param {UserAttributeProfilesClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -452,6 +452,7 @@ class UserAttributeProfilesClient {
|
|
|
452
452
|
* @throws {@link Management.BadRequestError}
|
|
453
453
|
* @throws {@link Management.UnauthorizedError}
|
|
454
454
|
* @throws {@link Management.ForbiddenError}
|
|
455
|
+
* @throws {@link Management.NotFoundError}
|
|
455
456
|
* @throws {@link Management.TooManyRequestsError}
|
|
456
457
|
*
|
|
457
458
|
* @example
|
|
@@ -493,6 +494,8 @@ class UserAttributeProfilesClient {
|
|
|
493
494
|
throw new Management.UnauthorizedError(_response.error.body, _response.rawResponse);
|
|
494
495
|
case 403:
|
|
495
496
|
throw new Management.ForbiddenError(_response.error.body, _response.rawResponse);
|
|
497
|
+
case 404:
|
|
498
|
+
throw new Management.NotFoundError(_response.error.body, _response.rawResponse);
|
|
496
499
|
case 429:
|
|
497
500
|
throw new Management.TooManyRequestsError(_response.error.body, _response.rawResponse);
|
|
498
501
|
default:
|
|
@@ -11,7 +11,7 @@ export declare class UserBlocksClient {
|
|
|
11
11
|
protected readonly _options: NormalizedClientOptionsWithAuth<UserBlocksClient.Options>;
|
|
12
12
|
constructor(options: UserBlocksClient.Options);
|
|
13
13
|
/**
|
|
14
|
-
* Retrieve details of all
|
|
14
|
+
* Retrieve details of all [Brute-force Protection](https://auth0.com/docs/secure/attack-protection/brute-force-protection) blocks for a user with the given identifier (username, phone number, or email).
|
|
15
15
|
*
|
|
16
16
|
* @param {Management.ListUserBlocksByIdentifierRequestParameters} request
|
|
17
17
|
* @param {UserBlocksClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -30,9 +30,9 @@ export declare class UserBlocksClient {
|
|
|
30
30
|
listByIdentifier(request: Management.ListUserBlocksByIdentifierRequestParameters, requestOptions?: UserBlocksClient.RequestOptions): core.HttpResponsePromise<Management.ListUserBlocksByIdentifierResponseContent>;
|
|
31
31
|
private __listByIdentifier;
|
|
32
32
|
/**
|
|
33
|
-
* Remove all
|
|
33
|
+
* Remove all [Brute-force Protection](https://auth0.com/docs/secure/attack-protection/brute-force-protection) blocks for the user with the given identifier (username, phone number, or email).
|
|
34
34
|
*
|
|
35
|
-
* Note: This endpoint does not unblock users that were
|
|
35
|
+
* Note: This endpoint does not unblock users that were [blocked by a tenant administrator](https://auth0.com/docs/user-profile#block-and-unblock-a-user).
|
|
36
36
|
*
|
|
37
37
|
* @param {Management.DeleteUserBlocksByIdentifierRequestParameters} request
|
|
38
38
|
* @param {UserBlocksClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -50,7 +50,7 @@ export declare class UserBlocksClient {
|
|
|
50
50
|
deleteByIdentifier(request: Management.DeleteUserBlocksByIdentifierRequestParameters, requestOptions?: UserBlocksClient.RequestOptions): core.HttpResponsePromise<void>;
|
|
51
51
|
private __deleteByIdentifier;
|
|
52
52
|
/**
|
|
53
|
-
* Retrieve details of all
|
|
53
|
+
* Retrieve details of all [Brute-force Protection](https://auth0.com/docs/secure/attack-protection/brute-force-protection) blocks for the user with the given ID.
|
|
54
54
|
*
|
|
55
55
|
* @param {string} id - user_id of the user blocks to retrieve.
|
|
56
56
|
* @param {Management.ListUserBlocksRequestParameters} request
|
|
@@ -70,9 +70,9 @@ export declare class UserBlocksClient {
|
|
|
70
70
|
list(id: string, request?: Management.ListUserBlocksRequestParameters, requestOptions?: UserBlocksClient.RequestOptions): core.HttpResponsePromise<Management.ListUserBlocksResponseContent>;
|
|
71
71
|
private __list;
|
|
72
72
|
/**
|
|
73
|
-
* Remove all
|
|
73
|
+
* Remove all [Brute-force Protection](https://auth0.com/docs/secure/attack-protection/brute-force-protection) blocks for the user with the given ID.
|
|
74
74
|
*
|
|
75
|
-
* Note: This endpoint does not unblock users that were
|
|
75
|
+
* Note: This endpoint does not unblock users that were [blocked by a tenant administrator](https://auth0.com/docs/user-profile#block-and-unblock-a-user).
|
|
76
76
|
*
|
|
77
77
|
* @param {string} id - The user_id of the user to update.
|
|
78
78
|
* @param {UserBlocksClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -56,7 +56,7 @@ class UserBlocksClient {
|
|
|
56
56
|
this._options = (0, BaseClient_js_1.normalizeClientOptionsWithAuth)(options);
|
|
57
57
|
}
|
|
58
58
|
/**
|
|
59
|
-
* Retrieve details of all
|
|
59
|
+
* Retrieve details of all [Brute-force Protection](https://auth0.com/docs/secure/attack-protection/brute-force-protection) blocks for a user with the given identifier (username, phone number, or email).
|
|
60
60
|
*
|
|
61
61
|
* @param {Management.ListUserBlocksByIdentifierRequestParameters} request
|
|
62
62
|
* @param {UserBlocksClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -128,9 +128,9 @@ class UserBlocksClient {
|
|
|
128
128
|
});
|
|
129
129
|
}
|
|
130
130
|
/**
|
|
131
|
-
* Remove all
|
|
131
|
+
* Remove all [Brute-force Protection](https://auth0.com/docs/secure/attack-protection/brute-force-protection) blocks for the user with the given identifier (username, phone number, or email).
|
|
132
132
|
*
|
|
133
|
-
* Note: This endpoint does not unblock users that were
|
|
133
|
+
* Note: This endpoint does not unblock users that were [blocked by a tenant administrator](https://auth0.com/docs/user-profile#block-and-unblock-a-user).
|
|
134
134
|
*
|
|
135
135
|
* @param {Management.DeleteUserBlocksByIdentifierRequestParameters} request
|
|
136
136
|
* @param {UserBlocksClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -197,7 +197,7 @@ class UserBlocksClient {
|
|
|
197
197
|
});
|
|
198
198
|
}
|
|
199
199
|
/**
|
|
200
|
-
* Retrieve details of all
|
|
200
|
+
* Retrieve details of all [Brute-force Protection](https://auth0.com/docs/secure/attack-protection/brute-force-protection) blocks for the user with the given ID.
|
|
201
201
|
*
|
|
202
202
|
* @param {string} id - user_id of the user blocks to retrieve.
|
|
203
203
|
* @param {Management.ListUserBlocksRequestParameters} request
|
|
@@ -271,9 +271,9 @@ class UserBlocksClient {
|
|
|
271
271
|
});
|
|
272
272
|
}
|
|
273
273
|
/**
|
|
274
|
-
* Remove all
|
|
274
|
+
* Remove all [Brute-force Protection](https://auth0.com/docs/secure/attack-protection/brute-force-protection) blocks for the user with the given ID.
|
|
275
275
|
*
|
|
276
|
-
* Note: This endpoint does not unblock users that were
|
|
276
|
+
* Note: This endpoint does not unblock users that were [blocked by a tenant administrator](https://auth0.com/docs/user-profile#block-and-unblock-a-user).
|
|
277
277
|
*
|
|
278
278
|
* @param {string} id - The user_id of the user to update.
|
|
279
279
|
* @param {UserBlocksClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -11,7 +11,7 @@ export declare class UserGrantsClient {
|
|
|
11
11
|
protected readonly _options: NormalizedClientOptionsWithAuth<UserGrantsClient.Options>;
|
|
12
12
|
constructor(options: UserGrantsClient.Options);
|
|
13
13
|
/**
|
|
14
|
-
* Retrieve the
|
|
14
|
+
* Retrieve the [grants](https://auth0.com/docs/api-auth/which-oauth-flow-to-use) associated with your account.
|
|
15
15
|
*
|
|
16
16
|
* @param {Management.ListUserGrantsRequestParameters} request
|
|
17
17
|
* @param {UserGrantsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -56,7 +56,7 @@ class UserGrantsClient {
|
|
|
56
56
|
this._options = (0, BaseClient_js_1.normalizeClientOptionsWithAuth)(options);
|
|
57
57
|
}
|
|
58
58
|
/**
|
|
59
|
-
* Retrieve the
|
|
59
|
+
* Retrieve the [grants](https://auth0.com/docs/api-auth/which-oauth-flow-to-use) associated with your account.
|
|
60
60
|
*
|
|
61
61
|
* @param {Management.ListUserGrantsRequestParameters} request
|
|
62
62
|
* @param {UserGrantsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -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.
|