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
|
@@ -11,7 +11,7 @@ export declare class CustomDomainsClient {
|
|
|
11
11
|
protected readonly _options: NormalizedClientOptionsWithAuth<CustomDomainsClient.Options>;
|
|
12
12
|
constructor(options: CustomDomainsClient.Options);
|
|
13
13
|
/**
|
|
14
|
-
* Retrieve details on
|
|
14
|
+
* Retrieve details on [custom domains](https://auth0.com/docs/custom-domains).
|
|
15
15
|
*
|
|
16
16
|
* @param {Management.ListCustomDomainsRequestParameters} request
|
|
17
17
|
* @param {CustomDomainsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -41,7 +41,6 @@ export declare class CustomDomainsClient {
|
|
|
41
41
|
* - custom_client_ip_header
|
|
42
42
|
* - tls_policy
|
|
43
43
|
*
|
|
44
|
-
*
|
|
45
44
|
* TLS Policies:
|
|
46
45
|
*
|
|
47
46
|
* - recommended - for modern usage this includes TLS 1.2 only
|
|
@@ -119,6 +118,7 @@ export declare class CustomDomainsClient {
|
|
|
119
118
|
* @throws {@link Management.BadRequestError}
|
|
120
119
|
* @throws {@link Management.UnauthorizedError}
|
|
121
120
|
* @throws {@link Management.ForbiddenError}
|
|
121
|
+
* @throws {@link Management.ConflictError}
|
|
122
122
|
* @throws {@link Management.TooManyRequestsError}
|
|
123
123
|
*
|
|
124
124
|
* @example
|
|
@@ -134,23 +134,31 @@ export declare class CustomDomainsClient {
|
|
|
134
134
|
* - custom_client_ip_header
|
|
135
135
|
* - tls_policy
|
|
136
136
|
*
|
|
137
|
-
*
|
|
137
|
+
* **Updating CUSTOM_CLIENT_IP_HEADER for a custom domain**
|
|
138
|
+
*
|
|
139
|
+
* To update the `custom_client_ip_header` for a domain, the body to
|
|
138
140
|
* send should be:
|
|
139
|
-
* <pre><code>{ "custom_client_ip_header": "cf-connecting-ip" }</code></pre>
|
|
140
141
|
*
|
|
141
|
-
*
|
|
142
|
-
*
|
|
142
|
+
* ```json
|
|
143
|
+
* { "custom_client_ip_header": "cf-connecting-ip" }
|
|
144
|
+
* ```
|
|
143
145
|
*
|
|
146
|
+
* **Updating TLS_POLICY for a custom domain**
|
|
147
|
+
*
|
|
148
|
+
* To update the `tls_policy` for a domain, the body to send should be:
|
|
149
|
+
*
|
|
150
|
+
* ```json
|
|
151
|
+
* { "tls_policy": "recommended" }
|
|
152
|
+
* ```
|
|
144
153
|
*
|
|
145
154
|
* TLS Policies:
|
|
146
155
|
*
|
|
147
156
|
* - recommended - for modern usage this includes TLS 1.2 only
|
|
148
157
|
*
|
|
149
|
-
*
|
|
150
158
|
* Some considerations:
|
|
151
159
|
*
|
|
152
160
|
* - The TLS ciphers and protocols available in each TLS policy follow industry recommendations, and may be updated occasionally.
|
|
153
|
-
* - The
|
|
161
|
+
* - The `compatible` TLS policy is no longer supported.
|
|
154
162
|
*
|
|
155
163
|
* @param {string} id - The id of the custom domain to update
|
|
156
164
|
* @param {Management.UpdateCustomDomainRequestContent} request
|
|
@@ -186,12 +194,12 @@ export declare class CustomDomainsClient {
|
|
|
186
194
|
/**
|
|
187
195
|
* Run the verification process on a custom domain.
|
|
188
196
|
*
|
|
189
|
-
* Note: Check the
|
|
197
|
+
* Note: Check the `status` field to see its verification status. Once verification is complete, it may take up to 10 minutes before the custom domain can start accepting requests.
|
|
190
198
|
*
|
|
191
|
-
* For
|
|
199
|
+
* For `self_managed_certs`, when the custom domain is verified for the first time, the response will also include the `cname_api_key` which you will need to configure your proxy. This key must be kept secret, and is used to validate the proxy requests.
|
|
192
200
|
*
|
|
193
|
-
*
|
|
194
|
-
*
|
|
201
|
+
* [Learn more](https://auth0.com/docs/custom-domains#step-2-verify-ownership) about verifying custom domains that use Auth0 Managed certificates.
|
|
202
|
+
* [Learn more](https://auth0.com/docs/custom-domains/self-managed-certificates#step-2-verify-ownership) about verifying custom domains that use Self Managed certificates.
|
|
195
203
|
*
|
|
196
204
|
* @param {string} id - ID of the custom domain to verify.
|
|
197
205
|
* @param {CustomDomainsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -20,7 +20,7 @@ export class CustomDomainsClient {
|
|
|
20
20
|
this._options = normalizeClientOptionsWithAuth(options);
|
|
21
21
|
}
|
|
22
22
|
/**
|
|
23
|
-
* Retrieve details on
|
|
23
|
+
* Retrieve details on [custom domains](https://auth0.com/docs/custom-domains).
|
|
24
24
|
*
|
|
25
25
|
* @param {Management.ListCustomDomainsRequestParameters} request
|
|
26
26
|
* @param {CustomDomainsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -103,7 +103,6 @@ export class CustomDomainsClient {
|
|
|
103
103
|
* - custom_client_ip_header
|
|
104
104
|
* - tls_policy
|
|
105
105
|
*
|
|
106
|
-
*
|
|
107
106
|
* TLS Policies:
|
|
108
107
|
*
|
|
109
108
|
* - recommended - for modern usage this includes TLS 1.2 only
|
|
@@ -361,6 +360,7 @@ export class CustomDomainsClient {
|
|
|
361
360
|
* @throws {@link Management.BadRequestError}
|
|
362
361
|
* @throws {@link Management.UnauthorizedError}
|
|
363
362
|
* @throws {@link Management.ForbiddenError}
|
|
363
|
+
* @throws {@link Management.ConflictError}
|
|
364
364
|
* @throws {@link Management.TooManyRequestsError}
|
|
365
365
|
*
|
|
366
366
|
* @example
|
|
@@ -396,6 +396,8 @@ export class CustomDomainsClient {
|
|
|
396
396
|
throw new Management.UnauthorizedError(_response.error.body, _response.rawResponse);
|
|
397
397
|
case 403:
|
|
398
398
|
throw new Management.ForbiddenError(_response.error.body, _response.rawResponse);
|
|
399
|
+
case 409:
|
|
400
|
+
throw new Management.ConflictError(_response.error.body, _response.rawResponse);
|
|
399
401
|
case 429:
|
|
400
402
|
throw new Management.TooManyRequestsError(_response.error.body, _response.rawResponse);
|
|
401
403
|
default:
|
|
@@ -417,23 +419,31 @@ export class CustomDomainsClient {
|
|
|
417
419
|
* - custom_client_ip_header
|
|
418
420
|
* - tls_policy
|
|
419
421
|
*
|
|
420
|
-
*
|
|
422
|
+
* **Updating CUSTOM_CLIENT_IP_HEADER for a custom domain**
|
|
423
|
+
*
|
|
424
|
+
* To update the `custom_client_ip_header` for a domain, the body to
|
|
421
425
|
* send should be:
|
|
422
|
-
* <pre><code>{ "custom_client_ip_header": "cf-connecting-ip" }</code></pre>
|
|
423
426
|
*
|
|
424
|
-
*
|
|
425
|
-
*
|
|
427
|
+
* ```json
|
|
428
|
+
* { "custom_client_ip_header": "cf-connecting-ip" }
|
|
429
|
+
* ```
|
|
430
|
+
*
|
|
431
|
+
* **Updating TLS_POLICY for a custom domain**
|
|
426
432
|
*
|
|
433
|
+
* To update the `tls_policy` for a domain, the body to send should be:
|
|
434
|
+
*
|
|
435
|
+
* ```json
|
|
436
|
+
* { "tls_policy": "recommended" }
|
|
437
|
+
* ```
|
|
427
438
|
*
|
|
428
439
|
* TLS Policies:
|
|
429
440
|
*
|
|
430
441
|
* - recommended - for modern usage this includes TLS 1.2 only
|
|
431
442
|
*
|
|
432
|
-
*
|
|
433
443
|
* Some considerations:
|
|
434
444
|
*
|
|
435
445
|
* - The TLS ciphers and protocols available in each TLS policy follow industry recommendations, and may be updated occasionally.
|
|
436
|
-
* - The
|
|
446
|
+
* - The `compatible` TLS policy is no longer supported.
|
|
437
447
|
*
|
|
438
448
|
* @param {string} id - The id of the custom domain to update
|
|
439
449
|
* @param {Management.UpdateCustomDomainRequestContent} request
|
|
@@ -562,12 +572,12 @@ export class CustomDomainsClient {
|
|
|
562
572
|
/**
|
|
563
573
|
* Run the verification process on a custom domain.
|
|
564
574
|
*
|
|
565
|
-
* Note: Check the
|
|
575
|
+
* Note: Check the `status` field to see its verification status. Once verification is complete, it may take up to 10 minutes before the custom domain can start accepting requests.
|
|
566
576
|
*
|
|
567
|
-
* For
|
|
577
|
+
* For `self_managed_certs`, when the custom domain is verified for the first time, the response will also include the `cname_api_key` which you will need to configure your proxy. This key must be kept secret, and is used to validate the proxy requests.
|
|
568
578
|
*
|
|
569
|
-
*
|
|
570
|
-
*
|
|
579
|
+
* [Learn more](https://auth0.com/docs/custom-domains#step-2-verify-ownership) about verifying custom domains that use Auth0 Managed certificates.
|
|
580
|
+
* [Learn more](https://auth0.com/docs/custom-domains/self-managed-certificates#step-2-verify-ownership) about verifying custom domains that use Self Managed certificates.
|
|
571
581
|
*
|
|
572
582
|
* @param {string} id - ID of the custom domain to verify.
|
|
573
583
|
* @param {CustomDomainsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -11,7 +11,7 @@ export declare class DeviceCredentialsClient {
|
|
|
11
11
|
protected readonly _options: NormalizedClientOptionsWithAuth<DeviceCredentialsClient.Options>;
|
|
12
12
|
constructor(options: DeviceCredentialsClient.Options);
|
|
13
13
|
/**
|
|
14
|
-
* Retrieve device credential information (
|
|
14
|
+
* Retrieve device credential information (`public_key`, `refresh_token`, or `rotating_refresh_token`) associated with a specific user.
|
|
15
15
|
*
|
|
16
16
|
* @param {Management.ListDeviceCredentialsRequestParameters} request
|
|
17
17
|
* @param {DeviceCredentialsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -35,9 +35,9 @@ export declare class DeviceCredentialsClient {
|
|
|
35
35
|
*/
|
|
36
36
|
list(request?: Management.ListDeviceCredentialsRequestParameters, requestOptions?: DeviceCredentialsClient.RequestOptions): Promise<core.Page<Management.DeviceCredential, Management.ListDeviceCredentialsOffsetPaginatedResponseContent>>;
|
|
37
37
|
/**
|
|
38
|
-
* Create a device credential public key to manage refresh token rotation for a given
|
|
38
|
+
* Create a device credential public key to manage refresh token rotation for a given `user_id`. Device Credentials APIs are designed for ad-hoc administrative use only and paging is by default enabled for GET requests.
|
|
39
39
|
*
|
|
40
|
-
* When refresh token rotation is enabled, the endpoint becomes consistent. For more information, read
|
|
40
|
+
* When refresh token rotation is enabled, the endpoint becomes consistent. For more information, read [Signing Keys](https://auth0.com/docs/get-started/tenant-settings/signing-keys).
|
|
41
41
|
*
|
|
42
42
|
* @param {Management.CreatePublicKeyDeviceCredentialRequestContent} request
|
|
43
43
|
* @param {DeviceCredentialsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -20,7 +20,7 @@ export class DeviceCredentialsClient {
|
|
|
20
20
|
this._options = normalizeClientOptionsWithAuth(options);
|
|
21
21
|
}
|
|
22
22
|
/**
|
|
23
|
-
* Retrieve device credential information (
|
|
23
|
+
* Retrieve device credential information (`public_key`, `refresh_token`, or `rotating_refresh_token`) associated with a specific user.
|
|
24
24
|
*
|
|
25
25
|
* @param {Management.ListDeviceCredentialsRequestParameters} request
|
|
26
26
|
* @param {DeviceCredentialsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -115,9 +115,9 @@ export class DeviceCredentialsClient {
|
|
|
115
115
|
});
|
|
116
116
|
}
|
|
117
117
|
/**
|
|
118
|
-
* Create a device credential public key to manage refresh token rotation for a given
|
|
118
|
+
* Create a device credential public key to manage refresh token rotation for a given `user_id`. Device Credentials APIs are designed for ad-hoc administrative use only and paging is by default enabled for GET requests.
|
|
119
119
|
*
|
|
120
|
-
* When refresh token rotation is enabled, the endpoint becomes consistent. For more information, read
|
|
120
|
+
* When refresh token rotation is enabled, the endpoint becomes consistent. For more information, read [Signing Keys](https://auth0.com/docs/get-started/tenant-settings/signing-keys).
|
|
121
121
|
*
|
|
122
122
|
* @param {Management.CreatePublicKeyDeviceCredentialRequestContent} request
|
|
123
123
|
* @param {DeviceCredentialsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -11,7 +11,7 @@ export declare class ProviderClient {
|
|
|
11
11
|
protected readonly _options: NormalizedClientOptionsWithAuth<ProviderClient.Options>;
|
|
12
12
|
constructor(options: ProviderClient.Options);
|
|
13
13
|
/**
|
|
14
|
-
* Retrieve details of the
|
|
14
|
+
* Retrieve details of the [email provider configuration](https://auth0.com/docs/customize/email/smtp-email-providers) in your tenant. A list of fields to include or exclude may also be specified.
|
|
15
15
|
*
|
|
16
16
|
* @param {Management.GetEmailProviderRequestParameters} request
|
|
17
17
|
* @param {ProviderClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -31,48 +31,31 @@ export declare class ProviderClient {
|
|
|
31
31
|
get(request?: Management.GetEmailProviderRequestParameters, requestOptions?: ProviderClient.RequestOptions): core.HttpResponsePromise<Management.GetEmailProviderResponseContent>;
|
|
32
32
|
private __get;
|
|
33
33
|
/**
|
|
34
|
-
* Create an
|
|
35
|
-
* requires different properties depending on the email provider (which is specified using the
|
|
36
|
-
*
|
|
37
|
-
*
|
|
38
|
-
*
|
|
39
|
-
*
|
|
40
|
-
*
|
|
41
|
-
*
|
|
42
|
-
*
|
|
43
|
-
*
|
|
44
|
-
*
|
|
45
|
-
*
|
|
46
|
-
*
|
|
47
|
-
*
|
|
48
|
-
*
|
|
49
|
-
*
|
|
50
|
-
* <li>
|
|
51
|
-
* <code>smtp</code> requires <code>smtp_host</code>, <code>smtp_port</code>, <code>smtp_user</code>, and
|
|
52
|
-
* <code>smtp_pass</code>
|
|
53
|
-
* </li>
|
|
54
|
-
* </ul>
|
|
55
|
-
* Depending on the type of provider it is possible to specify <code>settings</code> object with different configuration
|
|
34
|
+
* Create an [email provider](https://auth0.com/docs/email/providers). The `credentials` object
|
|
35
|
+
* requires different properties depending on the email provider (which is specified using the `name` property):
|
|
36
|
+
*
|
|
37
|
+
* - `mandrill` requires `api_key`
|
|
38
|
+
* - `sendgrid` requires `api_key`
|
|
39
|
+
* - `sparkpost` requires `api_key`. Optionally, set `region` to `eu` to use
|
|
40
|
+
* the SparkPost service hosted in Western Europe; set to `null` to use the SparkPost service hosted in
|
|
41
|
+
* North America. `eu` or `null` are the only valid values for `region`.
|
|
42
|
+
* - `mailgun` requires `api_key` and `domain`. Optionally, set `region` to
|
|
43
|
+
* `eu` to use the Mailgun service hosted in Europe; set to `null` otherwise. `eu` or
|
|
44
|
+
* `null` are the only valid values for `region`.
|
|
45
|
+
* - `ses` requires `accessKeyId`, `secretAccessKey`, and `region`
|
|
46
|
+
* - `smtp` requires `smtp_host`, `smtp_port`, `smtp_user`, and
|
|
47
|
+
* `smtp_pass`
|
|
48
|
+
*
|
|
49
|
+
* Depending on the type of provider it is possible to specify `settings` object with different configuration
|
|
56
50
|
* options, which will be used when sending an email:
|
|
57
|
-
*
|
|
58
|
-
*
|
|
59
|
-
*
|
|
60
|
-
*
|
|
61
|
-
*
|
|
62
|
-
*
|
|
63
|
-
*
|
|
64
|
-
*
|
|
65
|
-
* <li>
|
|
66
|
-
* When using Sparkpost host, you may provide value for
|
|
67
|
-
* <code>X-MSYS_API</code> header. Value must be an object.
|
|
68
|
-
* </li>
|
|
69
|
-
* </ul>
|
|
70
|
-
* </li>
|
|
71
|
-
* <li>
|
|
72
|
-
* for <code>ses</code> provider, <code>settings</code> may contain <code>message</code> object, where you can provide
|
|
73
|
-
* a name of configuration set in <code>configuration_set_name</code> property. Value must be a string.
|
|
74
|
-
* </li>
|
|
75
|
-
* </ul>
|
|
51
|
+
*
|
|
52
|
+
* - `smtp` provider, `settings` may contain `headers` object.
|
|
53
|
+
* - When using AWS SES SMTP host, you may provide a name of configuration set in
|
|
54
|
+
* `X-SES-Configuration-Set` header. Value must be a string.
|
|
55
|
+
* - When using Sparkpost host, you may provide value for
|
|
56
|
+
* `X-MSYS_API` header. Value must be an object.
|
|
57
|
+
* - For `ses` provider, `settings` may contain `message` object, where you can provide
|
|
58
|
+
* a name of configuration set in `configuration_set_name` property. Value must be a string.
|
|
76
59
|
*
|
|
77
60
|
* @param {Management.CreateEmailProviderRequestContent} request
|
|
78
61
|
* @param {ProviderClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -110,46 +93,32 @@ export declare class ProviderClient {
|
|
|
110
93
|
delete(requestOptions?: ProviderClient.RequestOptions): core.HttpResponsePromise<void>;
|
|
111
94
|
private __delete;
|
|
112
95
|
/**
|
|
113
|
-
* Update an
|
|
114
|
-
* requires different properties depending on the email provider (which is specified using the
|
|
115
|
-
*
|
|
116
|
-
*
|
|
117
|
-
*
|
|
118
|
-
*
|
|
119
|
-
*
|
|
120
|
-
*
|
|
121
|
-
*
|
|
122
|
-
*
|
|
123
|
-
*
|
|
124
|
-
*
|
|
125
|
-
*
|
|
126
|
-
*
|
|
127
|
-
*
|
|
128
|
-
*
|
|
129
|
-
* <li>
|
|
130
|
-
* <code>smtp</code> requires <code>smtp_host</code>, <code>smtp_port</code>, <code>smtp_user</code>, and
|
|
131
|
-
* <code>smtp_pass</code>
|
|
132
|
-
* </li>
|
|
133
|
-
* </ul>
|
|
134
|
-
* Depending on the type of provider it is possible to specify <code>settings</code> object with different configuration
|
|
96
|
+
* Update an [email provider](https://auth0.com/docs/email/providers). The `credentials` object
|
|
97
|
+
* requires different properties depending on the email provider (which is specified using the `name` property):
|
|
98
|
+
*
|
|
99
|
+
* - `mandrill` requires `api_key`
|
|
100
|
+
* - `sendgrid` requires `api_key`
|
|
101
|
+
* - `sparkpost` requires `api_key`. Optionally, set `region` to `eu` to use
|
|
102
|
+
* the SparkPost service hosted in Western Europe; set to `null` to use the SparkPost service hosted in
|
|
103
|
+
* North America. `eu` or `null` are the only valid values for `region`.
|
|
104
|
+
* - `mailgun` requires `api_key` and `domain`. Optionally, set `region` to
|
|
105
|
+
* `eu` to use the Mailgun service hosted in Europe; set to `null` otherwise. `eu` or
|
|
106
|
+
* `null` are the only valid values for `region`.
|
|
107
|
+
* - `ses` requires `accessKeyId`, `secretAccessKey`, and `region`
|
|
108
|
+
* - `smtp` requires `smtp_host`, `smtp_port`, `smtp_user`, and
|
|
109
|
+
* `smtp_pass`
|
|
110
|
+
*
|
|
111
|
+
* Depending on the type of provider it is possible to specify `settings` object with different configuration
|
|
135
112
|
* options, which will be used when sending an email:
|
|
136
|
-
*
|
|
137
|
-
*
|
|
138
|
-
*
|
|
139
|
-
*
|
|
140
|
-
*
|
|
141
|
-
*
|
|
142
|
-
*
|
|
143
|
-
*
|
|
144
|
-
*
|
|
145
|
-
* When using Sparkpost host, you may provide value for
|
|
146
|
-
* <code>X-MSYS_API</code> header. Value must be an object.
|
|
147
|
-
* </li>
|
|
148
|
-
* </ul>
|
|
149
|
-
* for <code>ses</code> provider, <code>settings</code> may contain <code>message</code> object, where you can provide
|
|
150
|
-
* a name of configuration set in <code>configuration_set_name</code> property. Value must be a string.
|
|
151
|
-
* </li>
|
|
152
|
-
* </ul>
|
|
113
|
+
*
|
|
114
|
+
* - `smtp` provider, `settings` may contain `headers` object.
|
|
115
|
+
* - When using AWS SES SMTP host, you may provide a name of configuration set in
|
|
116
|
+
* `X-SES-Configuration-Set` header. Value must be a string.
|
|
117
|
+
* - When using Sparkpost host, you may provide value for
|
|
118
|
+
* `X-MSYS_API` header. Value must be an object.
|
|
119
|
+
*
|
|
120
|
+
* For `ses` provider, `settings` may contain `message` object, where you can provide
|
|
121
|
+
* a name of configuration set in `configuration_set_name` property. Value must be a string.
|
|
153
122
|
*
|
|
154
123
|
* @param {Management.UpdateEmailProviderRequestContent} request
|
|
155
124
|
* @param {ProviderClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -20,7 +20,7 @@ export class ProviderClient {
|
|
|
20
20
|
this._options = normalizeClientOptionsWithAuth(options);
|
|
21
21
|
}
|
|
22
22
|
/**
|
|
23
|
-
* Retrieve details of the
|
|
23
|
+
* Retrieve details of the [email provider configuration](https://auth0.com/docs/customize/email/smtp-email-providers) in your tenant. A list of fields to include or exclude may also be specified.
|
|
24
24
|
*
|
|
25
25
|
* @param {Management.GetEmailProviderRequestParameters} request
|
|
26
26
|
* @param {ProviderClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -95,48 +95,31 @@ export class ProviderClient {
|
|
|
95
95
|
});
|
|
96
96
|
}
|
|
97
97
|
/**
|
|
98
|
-
* Create an
|
|
99
|
-
* requires different properties depending on the email provider (which is specified using the
|
|
100
|
-
*
|
|
101
|
-
*
|
|
102
|
-
*
|
|
103
|
-
*
|
|
104
|
-
*
|
|
105
|
-
*
|
|
106
|
-
*
|
|
107
|
-
*
|
|
108
|
-
*
|
|
109
|
-
*
|
|
110
|
-
*
|
|
111
|
-
*
|
|
112
|
-
*
|
|
113
|
-
*
|
|
114
|
-
* <li>
|
|
115
|
-
* <code>smtp</code> requires <code>smtp_host</code>, <code>smtp_port</code>, <code>smtp_user</code>, and
|
|
116
|
-
* <code>smtp_pass</code>
|
|
117
|
-
* </li>
|
|
118
|
-
* </ul>
|
|
119
|
-
* Depending on the type of provider it is possible to specify <code>settings</code> object with different configuration
|
|
98
|
+
* Create an [email provider](https://auth0.com/docs/email/providers). The `credentials` object
|
|
99
|
+
* requires different properties depending on the email provider (which is specified using the `name` property):
|
|
100
|
+
*
|
|
101
|
+
* - `mandrill` requires `api_key`
|
|
102
|
+
* - `sendgrid` requires `api_key`
|
|
103
|
+
* - `sparkpost` requires `api_key`. Optionally, set `region` to `eu` to use
|
|
104
|
+
* the SparkPost service hosted in Western Europe; set to `null` to use the SparkPost service hosted in
|
|
105
|
+
* North America. `eu` or `null` are the only valid values for `region`.
|
|
106
|
+
* - `mailgun` requires `api_key` and `domain`. Optionally, set `region` to
|
|
107
|
+
* `eu` to use the Mailgun service hosted in Europe; set to `null` otherwise. `eu` or
|
|
108
|
+
* `null` are the only valid values for `region`.
|
|
109
|
+
* - `ses` requires `accessKeyId`, `secretAccessKey`, and `region`
|
|
110
|
+
* - `smtp` requires `smtp_host`, `smtp_port`, `smtp_user`, and
|
|
111
|
+
* `smtp_pass`
|
|
112
|
+
*
|
|
113
|
+
* Depending on the type of provider it is possible to specify `settings` object with different configuration
|
|
120
114
|
* options, which will be used when sending an email:
|
|
121
|
-
*
|
|
122
|
-
*
|
|
123
|
-
*
|
|
124
|
-
*
|
|
125
|
-
*
|
|
126
|
-
*
|
|
127
|
-
*
|
|
128
|
-
*
|
|
129
|
-
* <li>
|
|
130
|
-
* When using Sparkpost host, you may provide value for
|
|
131
|
-
* <code>X-MSYS_API</code> header. Value must be an object.
|
|
132
|
-
* </li>
|
|
133
|
-
* </ul>
|
|
134
|
-
* </li>
|
|
135
|
-
* <li>
|
|
136
|
-
* for <code>ses</code> provider, <code>settings</code> may contain <code>message</code> object, where you can provide
|
|
137
|
-
* a name of configuration set in <code>configuration_set_name</code> property. Value must be a string.
|
|
138
|
-
* </li>
|
|
139
|
-
* </ul>
|
|
115
|
+
*
|
|
116
|
+
* - `smtp` provider, `settings` may contain `headers` object.
|
|
117
|
+
* - When using AWS SES SMTP host, you may provide a name of configuration set in
|
|
118
|
+
* `X-SES-Configuration-Set` header. Value must be a string.
|
|
119
|
+
* - When using Sparkpost host, you may provide value for
|
|
120
|
+
* `X-MSYS_API` header. Value must be an object.
|
|
121
|
+
* - For `ses` provider, `settings` may contain `message` object, where you can provide
|
|
122
|
+
* a name of configuration set in `configuration_set_name` property. Value must be a string.
|
|
140
123
|
*
|
|
141
124
|
* @param {Management.CreateEmailProviderRequestContent} request
|
|
142
125
|
* @param {ProviderClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -266,46 +249,32 @@ export class ProviderClient {
|
|
|
266
249
|
});
|
|
267
250
|
}
|
|
268
251
|
/**
|
|
269
|
-
* Update an
|
|
270
|
-
* requires different properties depending on the email provider (which is specified using the
|
|
271
|
-
*
|
|
272
|
-
*
|
|
273
|
-
*
|
|
274
|
-
*
|
|
275
|
-
*
|
|
276
|
-
*
|
|
277
|
-
*
|
|
278
|
-
*
|
|
279
|
-
*
|
|
280
|
-
*
|
|
281
|
-
*
|
|
282
|
-
*
|
|
283
|
-
*
|
|
284
|
-
*
|
|
285
|
-
* <li>
|
|
286
|
-
* <code>smtp</code> requires <code>smtp_host</code>, <code>smtp_port</code>, <code>smtp_user</code>, and
|
|
287
|
-
* <code>smtp_pass</code>
|
|
288
|
-
* </li>
|
|
289
|
-
* </ul>
|
|
290
|
-
* Depending on the type of provider it is possible to specify <code>settings</code> object with different configuration
|
|
252
|
+
* Update an [email provider](https://auth0.com/docs/email/providers). The `credentials` object
|
|
253
|
+
* requires different properties depending on the email provider (which is specified using the `name` property):
|
|
254
|
+
*
|
|
255
|
+
* - `mandrill` requires `api_key`
|
|
256
|
+
* - `sendgrid` requires `api_key`
|
|
257
|
+
* - `sparkpost` requires `api_key`. Optionally, set `region` to `eu` to use
|
|
258
|
+
* the SparkPost service hosted in Western Europe; set to `null` to use the SparkPost service hosted in
|
|
259
|
+
* North America. `eu` or `null` are the only valid values for `region`.
|
|
260
|
+
* - `mailgun` requires `api_key` and `domain`. Optionally, set `region` to
|
|
261
|
+
* `eu` to use the Mailgun service hosted in Europe; set to `null` otherwise. `eu` or
|
|
262
|
+
* `null` are the only valid values for `region`.
|
|
263
|
+
* - `ses` requires `accessKeyId`, `secretAccessKey`, and `region`
|
|
264
|
+
* - `smtp` requires `smtp_host`, `smtp_port`, `smtp_user`, and
|
|
265
|
+
* `smtp_pass`
|
|
266
|
+
*
|
|
267
|
+
* Depending on the type of provider it is possible to specify `settings` object with different configuration
|
|
291
268
|
* options, which will be used when sending an email:
|
|
292
|
-
*
|
|
293
|
-
*
|
|
294
|
-
*
|
|
295
|
-
*
|
|
296
|
-
*
|
|
297
|
-
*
|
|
298
|
-
*
|
|
299
|
-
*
|
|
300
|
-
*
|
|
301
|
-
* When using Sparkpost host, you may provide value for
|
|
302
|
-
* <code>X-MSYS_API</code> header. Value must be an object.
|
|
303
|
-
* </li>
|
|
304
|
-
* </ul>
|
|
305
|
-
* for <code>ses</code> provider, <code>settings</code> may contain <code>message</code> object, where you can provide
|
|
306
|
-
* a name of configuration set in <code>configuration_set_name</code> property. Value must be a string.
|
|
307
|
-
* </li>
|
|
308
|
-
* </ul>
|
|
269
|
+
*
|
|
270
|
+
* - `smtp` provider, `settings` may contain `headers` object.
|
|
271
|
+
* - When using AWS SES SMTP host, you may provide a name of configuration set in
|
|
272
|
+
* `X-SES-Configuration-Set` header. Value must be a string.
|
|
273
|
+
* - When using Sparkpost host, you may provide value for
|
|
274
|
+
* `X-MSYS_API` header. Value must be an object.
|
|
275
|
+
*
|
|
276
|
+
* For `ses` provider, `settings` may contain `message` object, where you can provide
|
|
277
|
+
* a name of configuration set in `configuration_set_name` property. Value must be a string.
|
|
309
278
|
*
|
|
310
279
|
* @param {Management.UpdateEmailProviderRequestContent} request
|
|
311
280
|
* @param {ProviderClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -3,6 +3,7 @@ import { type NormalizedClientOptionsWithAuth } from "../../../../BaseClient.mjs
|
|
|
3
3
|
import * as core from "../../../../core/index.mjs";
|
|
4
4
|
import * as Management from "../../../index.mjs";
|
|
5
5
|
import { MembersClient } from "../resources/members/client/Client.mjs";
|
|
6
|
+
import { RolesClient } from "../resources/roles/client/Client.mjs";
|
|
6
7
|
export declare namespace GroupsClient {
|
|
7
8
|
type Options = BaseClientOptions;
|
|
8
9
|
interface RequestOptions extends BaseRequestOptions {
|
|
@@ -11,8 +12,10 @@ export declare namespace GroupsClient {
|
|
|
11
12
|
export declare class GroupsClient {
|
|
12
13
|
protected readonly _options: NormalizedClientOptionsWithAuth<GroupsClient.Options>;
|
|
13
14
|
protected _members: MembersClient | undefined;
|
|
15
|
+
protected _roles: RolesClient | undefined;
|
|
14
16
|
constructor(options: GroupsClient.Options);
|
|
15
17
|
get members(): MembersClient;
|
|
18
|
+
get roles(): RolesClient;
|
|
16
19
|
/**
|
|
17
20
|
* List all groups in your tenant.
|
|
18
21
|
*
|
|
@@ -16,6 +16,7 @@ import { handleNonStatusCodeError } from "../../../../errors/handleNonStatusCode
|
|
|
16
16
|
import * as errors from "../../../../errors/index.mjs";
|
|
17
17
|
import * as Management from "../../../index.mjs";
|
|
18
18
|
import { MembersClient } from "../resources/members/client/Client.mjs";
|
|
19
|
+
import { RolesClient } from "../resources/roles/client/Client.mjs";
|
|
19
20
|
export class GroupsClient {
|
|
20
21
|
constructor(options) {
|
|
21
22
|
this._options = normalizeClientOptionsWithAuth(options);
|
|
@@ -24,6 +25,10 @@ export class GroupsClient {
|
|
|
24
25
|
var _a;
|
|
25
26
|
return ((_a = this._members) !== null && _a !== void 0 ? _a : (this._members = new MembersClient(this._options)));
|
|
26
27
|
}
|
|
28
|
+
get roles() {
|
|
29
|
+
var _a;
|
|
30
|
+
return ((_a = this._roles) !== null && _a !== void 0 ? _a : (this._roles = new RolesClient(this._options)));
|
|
31
|
+
}
|
|
27
32
|
/**
|
|
28
33
|
* List all groups in your tenant.
|
|
29
34
|
*
|
|
@@ -20,6 +20,7 @@ export declare class MembersClient {
|
|
|
20
20
|
* @throws {@link Management.BadRequestError}
|
|
21
21
|
* @throws {@link Management.UnauthorizedError}
|
|
22
22
|
* @throws {@link Management.ForbiddenError}
|
|
23
|
+
* @throws {@link Management.NotFoundError}
|
|
23
24
|
* @throws {@link Management.TooManyRequestsError}
|
|
24
25
|
*
|
|
25
26
|
* @example
|
|
@@ -29,6 +29,7 @@ export class MembersClient {
|
|
|
29
29
|
* @throws {@link Management.BadRequestError}
|
|
30
30
|
* @throws {@link Management.UnauthorizedError}
|
|
31
31
|
* @throws {@link Management.ForbiddenError}
|
|
32
|
+
* @throws {@link Management.NotFoundError}
|
|
32
33
|
* @throws {@link Management.TooManyRequestsError}
|
|
33
34
|
*
|
|
34
35
|
* @example
|
|
@@ -81,6 +82,8 @@ export class MembersClient {
|
|
|
81
82
|
throw new Management.UnauthorizedError(_response.error.body, _response.rawResponse);
|
|
82
83
|
case 403:
|
|
83
84
|
throw new Management.ForbiddenError(_response.error.body, _response.rawResponse);
|
|
85
|
+
case 404:
|
|
86
|
+
throw new Management.NotFoundError(_response.error.body, _response.rawResponse);
|
|
84
87
|
case 429:
|
|
85
88
|
throw new Management.TooManyRequestsError(_response.error.body, _response.rawResponse);
|
|
86
89
|
default:
|