auth0 5.7.0 → 5.9.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/cjs/management/Client.d.ts +3 -0
- package/dist/cjs/management/Client.js +67 -62
- package/dist/cjs/management/api/errors/GoneError.d.ts +5 -0
- package/dist/cjs/management/api/errors/GoneError.js +54 -0
- package/dist/cjs/management/api/errors/index.d.ts +1 -0
- package/dist/cjs/management/api/errors/index.js +1 -0
- package/dist/cjs/management/api/requests/requests.d.ts +56 -10
- package/dist/cjs/management/api/resources/actions/client/Client.js +15 -7
- package/dist/cjs/management/api/resources/actions/resources/executions/client/Client.js +1 -1
- package/dist/cjs/management/api/resources/actions/resources/modules/client/Client.js +15 -7
- package/dist/cjs/management/api/resources/actions/resources/modules/resources/versions/client/Client.js +7 -3
- package/dist/cjs/management/api/resources/actions/resources/triggers/client/Client.js +1 -1
- package/dist/cjs/management/api/resources/actions/resources/triggers/resources/bindings/client/Client.js +6 -2
- package/dist/cjs/management/api/resources/actions/resources/versions/client/Client.js +7 -3
- package/dist/cjs/management/api/resources/anomaly/resources/blocks/client/Client.js +2 -2
- package/dist/cjs/management/api/resources/attackProtection/resources/botDetection/client/Client.js +2 -2
- package/dist/cjs/management/api/resources/attackProtection/resources/breachedPasswordDetection/client/Client.js +2 -2
- package/dist/cjs/management/api/resources/attackProtection/resources/bruteForceProtection/client/Client.js +2 -2
- package/dist/cjs/management/api/resources/attackProtection/resources/captcha/client/Client.js +2 -2
- package/dist/cjs/management/api/resources/attackProtection/resources/suspiciousIpThrottling/client/Client.js +2 -2
- package/dist/cjs/management/api/resources/branding/client/Client.js +2 -2
- package/dist/cjs/management/api/resources/branding/resources/phone/resources/providers/client/Client.js +10 -6
- package/dist/cjs/management/api/resources/branding/resources/phone/resources/templates/client/Client.js +11 -7
- package/dist/cjs/management/api/resources/branding/resources/templates/client/Client.js +3 -3
- package/dist/cjs/management/api/resources/branding/resources/themes/client/Client.js +5 -5
- package/dist/cjs/management/api/resources/clientGrants/client/Client.js +9 -5
- package/dist/cjs/management/api/resources/clientGrants/resources/organizations/client/Client.js +5 -1
- package/dist/cjs/management/api/resources/clients/client/Client.js +16 -8
- package/dist/cjs/management/api/resources/clients/resources/connections/client/Client.d.ts +1 -0
- package/dist/cjs/management/api/resources/clients/resources/connections/client/Client.js +6 -1
- package/dist/cjs/management/api/resources/clients/resources/credentials/client/Client.js +5 -5
- package/dist/cjs/management/api/resources/connectionProfiles/client/Client.js +11 -7
- package/dist/cjs/management/api/resources/connections/client/Client.d.ts +1 -0
- package/dist/cjs/management/api/resources/connections/client/Client.js +15 -6
- package/dist/cjs/management/api/resources/connections/resources/clients/client/Client.js +6 -2
- package/dist/cjs/management/api/resources/connections/resources/directoryProvisioning/client/Client.js +16 -8
- package/dist/cjs/management/api/resources/connections/resources/directoryProvisioning/resources/synchronizations/client/Client.js +1 -1
- package/dist/cjs/management/api/resources/connections/resources/keys/client/Client.js +3 -3
- package/dist/cjs/management/api/resources/connections/resources/scimConfiguration/client/Client.js +10 -6
- package/dist/cjs/management/api/resources/connections/resources/scimConfiguration/resources/tokens/client/Client.js +3 -3
- package/dist/cjs/management/api/resources/connections/resources/users/client/Client.js +5 -1
- package/dist/cjs/management/api/resources/customDomains/client/Client.js +13 -9
- package/dist/cjs/management/api/resources/deviceCredentials/client/Client.js +7 -3
- package/dist/cjs/management/api/resources/emailTemplates/client/Client.js +4 -4
- package/dist/cjs/management/api/resources/emails/resources/provider/client/Client.js +8 -4
- package/dist/cjs/management/api/resources/eventStreams/client/Client.js +10 -6
- package/dist/cjs/management/api/resources/eventStreams/resources/deliveries/client/Client.js +6 -2
- package/dist/cjs/management/api/resources/eventStreams/resources/redeliveries/client/Client.js +2 -2
- package/dist/cjs/management/api/resources/events/client/Client.d.ts +18 -0
- package/dist/cjs/management/api/resources/events/client/Client.js +135 -0
- package/dist/cjs/management/api/resources/events/client/index.d.ts +1 -0
- package/dist/cjs/management/api/resources/events/client/index.js +2 -0
- package/dist/cjs/management/api/resources/events/index.d.ts +1 -0
- package/dist/cjs/management/api/resources/events/index.js +17 -0
- package/dist/cjs/management/api/resources/flows/client/Client.d.ts +4 -1
- package/dist/cjs/management/api/resources/flows/client/Client.js +17 -6
- package/dist/cjs/management/api/resources/flows/resources/executions/client/Client.d.ts +3 -1
- package/dist/cjs/management/api/resources/flows/resources/executions/client/Client.js +14 -4
- package/dist/cjs/management/api/resources/flows/resources/vault/resources/connections/client/Client.js +9 -5
- package/dist/cjs/management/api/resources/forms/client/Client.d.ts +5 -2
- package/dist/cjs/management/api/resources/forms/client/Client.js +18 -7
- package/dist/cjs/management/api/resources/groups/client/Client.d.ts +1 -0
- package/dist/cjs/management/api/resources/groups/client/Client.js +10 -4
- package/dist/cjs/management/api/resources/groups/resources/members/client/Client.js +5 -1
- package/dist/cjs/management/api/resources/guardian/resources/enrollments/client/Client.js +3 -3
- package/dist/cjs/management/api/resources/guardian/resources/factors/client/Client.js +2 -2
- package/dist/cjs/management/api/resources/guardian/resources/factors/resources/duo/resources/settings/client/Client.js +3 -3
- package/dist/cjs/management/api/resources/guardian/resources/factors/resources/phone/client/Client.js +8 -8
- package/dist/cjs/management/api/resources/guardian/resources/factors/resources/pushNotification/client/Client.js +12 -12
- package/dist/cjs/management/api/resources/guardian/resources/factors/resources/sms/client/Client.js +6 -6
- package/dist/cjs/management/api/resources/guardian/resources/policies/client/Client.js +2 -2
- package/dist/cjs/management/api/resources/hooks/client/Client.js +13 -5
- package/dist/cjs/management/api/resources/hooks/resources/secrets/client/Client.js +4 -4
- 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/client/Client.js +1 -1
- package/dist/cjs/management/api/resources/jobs/resources/errors/client/Client.js +1 -1
- package/dist/cjs/management/api/resources/jobs/resources/usersExports/client/Client.js +1 -1
- package/dist/cjs/management/api/resources/jobs/resources/usersImports/client/Client.js +1 -1
- package/dist/cjs/management/api/resources/jobs/resources/verificationEmail/client/Client.js +1 -1
- package/dist/cjs/management/api/resources/keys/resources/customSigning/client/Client.js +3 -3
- package/dist/cjs/management/api/resources/keys/resources/encryption/client/Client.js +11 -7
- package/dist/cjs/management/api/resources/keys/resources/signing/client/Client.js +4 -4
- package/dist/cjs/management/api/resources/logStreams/client/Client.d.ts +465 -300
- package/dist/cjs/management/api/resources/logStreams/client/Client.js +470 -305
- package/dist/cjs/management/api/resources/logs/client/Client.js +6 -2
- package/dist/cjs/management/api/resources/networkAcls/client/Client.js +10 -6
- package/dist/cjs/management/api/resources/organizations/client/Client.js +10 -6
- package/dist/cjs/management/api/resources/organizations/resources/clientGrants/client/Client.d.ts +1 -0
- package/dist/cjs/management/api/resources/organizations/resources/clientGrants/client/Client.js +8 -3
- package/dist/cjs/management/api/resources/organizations/resources/connections/client/Client.js +9 -5
- package/dist/cjs/management/api/resources/organizations/resources/discoveryDomains/client/Client.js +10 -6
- package/dist/cjs/management/api/resources/organizations/resources/enabledConnections/client/Client.js +9 -5
- package/dist/cjs/management/api/resources/organizations/resources/invitations/client/Client.js +12 -4
- package/dist/cjs/management/api/resources/organizations/resources/members/client/Client.js +7 -3
- package/dist/cjs/management/api/resources/organizations/resources/members/resources/roles/client/Client.js +7 -3
- package/dist/cjs/management/api/resources/prompts/client/Client.js +2 -2
- package/dist/cjs/management/api/resources/prompts/resources/customText/client/Client.js +2 -2
- package/dist/cjs/management/api/resources/prompts/resources/partials/client/Client.js +2 -2
- package/dist/cjs/management/api/resources/prompts/resources/rendering/client/Client.js +8 -4
- package/dist/cjs/management/api/resources/refreshTokens/client/Client.d.ts +17 -0
- package/dist/cjs/management/api/resources/refreshTokens/client/Client.js +71 -4
- package/dist/cjs/management/api/resources/resourceServers/client/Client.d.ts +1 -0
- package/dist/cjs/management/api/resources/resourceServers/client/Client.js +14 -5
- package/dist/cjs/management/api/resources/riskAssessments/resources/settings/client/Client.js +2 -2
- package/dist/cjs/management/api/resources/riskAssessments/resources/settings/resources/newDevice/client/Client.js +2 -2
- package/dist/cjs/management/api/resources/roles/client/Client.js +9 -5
- package/dist/cjs/management/api/resources/roles/resources/permissions/client/Client.js +7 -3
- package/dist/cjs/management/api/resources/roles/resources/users/client/Client.js +6 -2
- package/dist/cjs/management/api/resources/rules/client/Client.js +13 -5
- package/dist/cjs/management/api/resources/rulesConfigs/client/Client.js +3 -3
- package/dist/cjs/management/api/resources/selfServiceProfiles/client/Client.js +9 -5
- package/dist/cjs/management/api/resources/selfServiceProfiles/resources/customText/client/Client.d.ts +2 -2
- package/dist/cjs/management/api/resources/selfServiceProfiles/resources/customText/client/Client.js +4 -4
- package/dist/cjs/management/api/resources/selfServiceProfiles/resources/ssoTicket/client/Client.d.ts +2 -2
- package/dist/cjs/management/api/resources/selfServiceProfiles/resources/ssoTicket/client/Client.js +4 -4
- package/dist/cjs/management/api/resources/sessions/client/Client.js +4 -4
- package/dist/cjs/management/api/resources/stats/client/Client.js +6 -2
- package/dist/cjs/management/api/resources/supplementalSignals/client/Client.js +2 -2
- package/dist/cjs/management/api/resources/tenants/resources/settings/client/Client.js +6 -2
- package/dist/cjs/management/api/resources/tickets/client/Client.js +2 -2
- package/dist/cjs/management/api/resources/tokenExchangeProfiles/client/Client.js +9 -5
- package/dist/cjs/management/api/resources/userAttributeProfiles/client/Client.d.ts +1 -1
- package/dist/cjs/management/api/resources/userAttributeProfiles/client/Client.js +12 -8
- package/dist/cjs/management/api/resources/userBlocks/client/Client.js +16 -4
- package/dist/cjs/management/api/resources/userGrants/client/Client.js +11 -3
- package/dist/cjs/management/api/resources/users/client/Client.js +20 -8
- package/dist/cjs/management/api/resources/users/resources/authenticationMethods/client/Client.js +11 -7
- package/dist/cjs/management/api/resources/users/resources/authenticators/client/Client.js +1 -1
- package/dist/cjs/management/api/resources/users/resources/connectedAccounts/client/Client.js +5 -1
- package/dist/cjs/management/api/resources/users/resources/enrollments/client/Client.js +1 -1
- package/dist/cjs/management/api/resources/users/resources/federatedConnectionsTokensets/client/Client.js +2 -2
- package/dist/cjs/management/api/resources/users/resources/groups/client/Client.js +5 -1
- package/dist/cjs/management/api/resources/users/resources/identities/client/Client.js +2 -2
- package/dist/cjs/management/api/resources/users/resources/logs/client/Client.js +5 -1
- 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.js +5 -1
- package/dist/cjs/management/api/resources/users/resources/permissions/client/Client.js +7 -3
- package/dist/cjs/management/api/resources/users/resources/refreshToken/client/Client.js +6 -2
- package/dist/cjs/management/api/resources/users/resources/riskAssessments/client/Client.js +1 -1
- package/dist/cjs/management/api/resources/users/resources/roles/client/Client.js +7 -3
- package/dist/cjs/management/api/resources/users/resources/sessions/client/Client.js +6 -2
- package/dist/cjs/management/api/resources/verifiableCredentials/resources/verification/resources/templates/client/Client.d.ts +1 -1
- package/dist/cjs/management/api/resources/verifiableCredentials/resources/verification/resources/templates/client/Client.js +10 -6
- package/dist/cjs/management/api/types/types.d.ts +3481 -148
- package/dist/cjs/management/api/types/types.js +623 -15
- package/dist/cjs/management/core/fetcher/Fetcher.d.ts +6 -0
- package/dist/cjs/management/core/fetcher/Fetcher.js +9 -8
- package/dist/cjs/management/core/index.d.ts +1 -0
- package/dist/cjs/management/core/index.js +1 -0
- package/dist/cjs/management/core/stream/Stream.d.ts +56 -0
- package/dist/cjs/management/core/stream/Stream.js +267 -0
- package/dist/cjs/management/core/stream/index.d.ts +1 -0
- package/dist/cjs/management/core/stream/index.js +5 -0
- package/dist/cjs/management/core/url/QueryStringBuilder.d.ts +47 -0
- package/dist/cjs/management/core/url/QueryStringBuilder.js +83 -0
- package/dist/cjs/management/core/url/index.d.ts +1 -0
- package/dist/cjs/management/core/url/index.js +3 -1
- package/dist/cjs/management/core/url/qs.d.ts +2 -1
- package/dist/cjs/management/core/url/qs.js +24 -12
- package/dist/cjs/management/version.d.ts +1 -1
- package/dist/cjs/management/version.js +1 -1
- package/dist/esm/management/Client.d.mts +3 -0
- package/dist/esm/management/Client.mjs +5 -0
- package/dist/esm/management/api/errors/GoneError.d.mts +5 -0
- package/dist/esm/management/api/errors/GoneError.mjs +17 -0
- package/dist/esm/management/api/errors/index.d.mts +1 -0
- package/dist/esm/management/api/errors/index.mjs +1 -0
- package/dist/esm/management/api/requests/requests.d.mts +56 -10
- package/dist/esm/management/api/resources/actions/client/Client.mjs +15 -7
- package/dist/esm/management/api/resources/actions/resources/executions/client/Client.mjs +1 -1
- package/dist/esm/management/api/resources/actions/resources/modules/client/Client.mjs +15 -7
- package/dist/esm/management/api/resources/actions/resources/modules/resources/versions/client/Client.mjs +7 -3
- package/dist/esm/management/api/resources/actions/resources/triggers/client/Client.mjs +1 -1
- package/dist/esm/management/api/resources/actions/resources/triggers/resources/bindings/client/Client.mjs +6 -2
- package/dist/esm/management/api/resources/actions/resources/versions/client/Client.mjs +7 -3
- package/dist/esm/management/api/resources/anomaly/resources/blocks/client/Client.mjs +2 -2
- package/dist/esm/management/api/resources/attackProtection/resources/botDetection/client/Client.mjs +2 -2
- package/dist/esm/management/api/resources/attackProtection/resources/breachedPasswordDetection/client/Client.mjs +2 -2
- package/dist/esm/management/api/resources/attackProtection/resources/bruteForceProtection/client/Client.mjs +2 -2
- package/dist/esm/management/api/resources/attackProtection/resources/captcha/client/Client.mjs +2 -2
- package/dist/esm/management/api/resources/attackProtection/resources/suspiciousIpThrottling/client/Client.mjs +2 -2
- package/dist/esm/management/api/resources/branding/client/Client.mjs +2 -2
- package/dist/esm/management/api/resources/branding/resources/phone/resources/providers/client/Client.mjs +10 -6
- package/dist/esm/management/api/resources/branding/resources/phone/resources/templates/client/Client.mjs +11 -7
- package/dist/esm/management/api/resources/branding/resources/templates/client/Client.mjs +3 -3
- package/dist/esm/management/api/resources/branding/resources/themes/client/Client.mjs +5 -5
- package/dist/esm/management/api/resources/clientGrants/client/Client.mjs +9 -5
- package/dist/esm/management/api/resources/clientGrants/resources/organizations/client/Client.mjs +5 -1
- package/dist/esm/management/api/resources/clients/client/Client.mjs +16 -8
- package/dist/esm/management/api/resources/clients/resources/connections/client/Client.d.mts +1 -0
- package/dist/esm/management/api/resources/clients/resources/connections/client/Client.mjs +6 -1
- package/dist/esm/management/api/resources/clients/resources/credentials/client/Client.mjs +5 -5
- package/dist/esm/management/api/resources/connectionProfiles/client/Client.mjs +11 -7
- package/dist/esm/management/api/resources/connections/client/Client.d.mts +1 -0
- package/dist/esm/management/api/resources/connections/client/Client.mjs +15 -6
- package/dist/esm/management/api/resources/connections/resources/clients/client/Client.mjs +6 -2
- package/dist/esm/management/api/resources/connections/resources/directoryProvisioning/client/Client.mjs +16 -8
- package/dist/esm/management/api/resources/connections/resources/directoryProvisioning/resources/synchronizations/client/Client.mjs +1 -1
- package/dist/esm/management/api/resources/connections/resources/keys/client/Client.mjs +3 -3
- package/dist/esm/management/api/resources/connections/resources/scimConfiguration/client/Client.mjs +10 -6
- package/dist/esm/management/api/resources/connections/resources/scimConfiguration/resources/tokens/client/Client.mjs +3 -3
- package/dist/esm/management/api/resources/connections/resources/users/client/Client.mjs +5 -1
- package/dist/esm/management/api/resources/customDomains/client/Client.mjs +13 -9
- package/dist/esm/management/api/resources/deviceCredentials/client/Client.mjs +7 -3
- package/dist/esm/management/api/resources/emailTemplates/client/Client.mjs +4 -4
- package/dist/esm/management/api/resources/emails/resources/provider/client/Client.mjs +8 -4
- package/dist/esm/management/api/resources/eventStreams/client/Client.mjs +10 -6
- package/dist/esm/management/api/resources/eventStreams/resources/deliveries/client/Client.mjs +6 -2
- package/dist/esm/management/api/resources/eventStreams/resources/redeliveries/client/Client.mjs +2 -2
- package/dist/esm/management/api/resources/events/client/Client.d.mts +18 -0
- package/dist/esm/management/api/resources/events/client/Client.mjs +98 -0
- package/dist/esm/management/api/resources/events/client/index.d.mts +1 -0
- package/dist/esm/management/api/resources/events/client/index.mjs +1 -0
- package/dist/esm/management/api/resources/events/index.d.mts +1 -0
- package/dist/esm/management/api/resources/events/index.mjs +1 -0
- package/dist/esm/management/api/resources/flows/client/Client.d.mts +4 -1
- package/dist/esm/management/api/resources/flows/client/Client.mjs +17 -6
- package/dist/esm/management/api/resources/flows/resources/executions/client/Client.d.mts +3 -1
- package/dist/esm/management/api/resources/flows/resources/executions/client/Client.mjs +14 -4
- package/dist/esm/management/api/resources/flows/resources/vault/resources/connections/client/Client.mjs +9 -5
- package/dist/esm/management/api/resources/forms/client/Client.d.mts +5 -2
- package/dist/esm/management/api/resources/forms/client/Client.mjs +18 -7
- package/dist/esm/management/api/resources/groups/client/Client.d.mts +1 -0
- package/dist/esm/management/api/resources/groups/client/Client.mjs +10 -4
- package/dist/esm/management/api/resources/groups/resources/members/client/Client.mjs +5 -1
- package/dist/esm/management/api/resources/guardian/resources/enrollments/client/Client.mjs +3 -3
- package/dist/esm/management/api/resources/guardian/resources/factors/client/Client.mjs +2 -2
- package/dist/esm/management/api/resources/guardian/resources/factors/resources/duo/resources/settings/client/Client.mjs +3 -3
- package/dist/esm/management/api/resources/guardian/resources/factors/resources/phone/client/Client.mjs +8 -8
- package/dist/esm/management/api/resources/guardian/resources/factors/resources/pushNotification/client/Client.mjs +12 -12
- package/dist/esm/management/api/resources/guardian/resources/factors/resources/sms/client/Client.mjs +6 -6
- package/dist/esm/management/api/resources/guardian/resources/policies/client/Client.mjs +2 -2
- package/dist/esm/management/api/resources/hooks/client/Client.mjs +13 -5
- package/dist/esm/management/api/resources/hooks/resources/secrets/client/Client.mjs +4 -4
- 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/client/Client.mjs +1 -1
- package/dist/esm/management/api/resources/jobs/resources/errors/client/Client.mjs +1 -1
- package/dist/esm/management/api/resources/jobs/resources/usersExports/client/Client.mjs +1 -1
- package/dist/esm/management/api/resources/jobs/resources/usersImports/client/Client.mjs +1 -1
- package/dist/esm/management/api/resources/jobs/resources/verificationEmail/client/Client.mjs +1 -1
- package/dist/esm/management/api/resources/keys/resources/customSigning/client/Client.mjs +3 -3
- package/dist/esm/management/api/resources/keys/resources/encryption/client/Client.mjs +11 -7
- package/dist/esm/management/api/resources/keys/resources/signing/client/Client.mjs +4 -4
- package/dist/esm/management/api/resources/logStreams/client/Client.d.mts +465 -300
- package/dist/esm/management/api/resources/logStreams/client/Client.mjs +470 -305
- package/dist/esm/management/api/resources/logs/client/Client.mjs +6 -2
- package/dist/esm/management/api/resources/networkAcls/client/Client.mjs +10 -6
- package/dist/esm/management/api/resources/organizations/client/Client.mjs +10 -6
- package/dist/esm/management/api/resources/organizations/resources/clientGrants/client/Client.d.mts +1 -0
- package/dist/esm/management/api/resources/organizations/resources/clientGrants/client/Client.mjs +8 -3
- package/dist/esm/management/api/resources/organizations/resources/connections/client/Client.mjs +9 -5
- package/dist/esm/management/api/resources/organizations/resources/discoveryDomains/client/Client.mjs +10 -6
- package/dist/esm/management/api/resources/organizations/resources/enabledConnections/client/Client.mjs +9 -5
- package/dist/esm/management/api/resources/organizations/resources/invitations/client/Client.mjs +12 -4
- package/dist/esm/management/api/resources/organizations/resources/members/client/Client.mjs +7 -3
- package/dist/esm/management/api/resources/organizations/resources/members/resources/roles/client/Client.mjs +7 -3
- package/dist/esm/management/api/resources/prompts/client/Client.mjs +2 -2
- package/dist/esm/management/api/resources/prompts/resources/customText/client/Client.mjs +2 -2
- package/dist/esm/management/api/resources/prompts/resources/partials/client/Client.mjs +2 -2
- package/dist/esm/management/api/resources/prompts/resources/rendering/client/Client.mjs +8 -4
- package/dist/esm/management/api/resources/refreshTokens/client/Client.d.mts +17 -0
- package/dist/esm/management/api/resources/refreshTokens/client/Client.mjs +71 -4
- package/dist/esm/management/api/resources/resourceServers/client/Client.d.mts +1 -0
- package/dist/esm/management/api/resources/resourceServers/client/Client.mjs +14 -5
- package/dist/esm/management/api/resources/riskAssessments/resources/settings/client/Client.mjs +2 -2
- package/dist/esm/management/api/resources/riskAssessments/resources/settings/resources/newDevice/client/Client.mjs +2 -2
- package/dist/esm/management/api/resources/roles/client/Client.mjs +9 -5
- package/dist/esm/management/api/resources/roles/resources/permissions/client/Client.mjs +7 -3
- package/dist/esm/management/api/resources/roles/resources/users/client/Client.mjs +6 -2
- package/dist/esm/management/api/resources/rules/client/Client.mjs +13 -5
- package/dist/esm/management/api/resources/rulesConfigs/client/Client.mjs +3 -3
- package/dist/esm/management/api/resources/selfServiceProfiles/client/Client.mjs +9 -5
- package/dist/esm/management/api/resources/selfServiceProfiles/resources/customText/client/Client.d.mts +2 -2
- package/dist/esm/management/api/resources/selfServiceProfiles/resources/customText/client/Client.mjs +4 -4
- package/dist/esm/management/api/resources/selfServiceProfiles/resources/ssoTicket/client/Client.d.mts +2 -2
- package/dist/esm/management/api/resources/selfServiceProfiles/resources/ssoTicket/client/Client.mjs +4 -4
- package/dist/esm/management/api/resources/sessions/client/Client.mjs +4 -4
- package/dist/esm/management/api/resources/stats/client/Client.mjs +6 -2
- package/dist/esm/management/api/resources/supplementalSignals/client/Client.mjs +2 -2
- package/dist/esm/management/api/resources/tenants/resources/settings/client/Client.mjs +6 -2
- package/dist/esm/management/api/resources/tickets/client/Client.mjs +2 -2
- package/dist/esm/management/api/resources/tokenExchangeProfiles/client/Client.mjs +9 -5
- package/dist/esm/management/api/resources/userAttributeProfiles/client/Client.d.mts +1 -1
- package/dist/esm/management/api/resources/userAttributeProfiles/client/Client.mjs +12 -8
- package/dist/esm/management/api/resources/userBlocks/client/Client.mjs +16 -4
- package/dist/esm/management/api/resources/userGrants/client/Client.mjs +11 -3
- package/dist/esm/management/api/resources/users/client/Client.mjs +20 -8
- package/dist/esm/management/api/resources/users/resources/authenticationMethods/client/Client.mjs +11 -7
- package/dist/esm/management/api/resources/users/resources/authenticators/client/Client.mjs +1 -1
- package/dist/esm/management/api/resources/users/resources/connectedAccounts/client/Client.mjs +5 -1
- package/dist/esm/management/api/resources/users/resources/enrollments/client/Client.mjs +1 -1
- package/dist/esm/management/api/resources/users/resources/federatedConnectionsTokensets/client/Client.mjs +2 -2
- package/dist/esm/management/api/resources/users/resources/groups/client/Client.mjs +5 -1
- package/dist/esm/management/api/resources/users/resources/identities/client/Client.mjs +2 -2
- package/dist/esm/management/api/resources/users/resources/logs/client/Client.mjs +5 -1
- 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.mjs +5 -1
- package/dist/esm/management/api/resources/users/resources/permissions/client/Client.mjs +7 -3
- package/dist/esm/management/api/resources/users/resources/refreshToken/client/Client.mjs +6 -2
- package/dist/esm/management/api/resources/users/resources/riskAssessments/client/Client.mjs +1 -1
- package/dist/esm/management/api/resources/users/resources/roles/client/Client.mjs +7 -3
- package/dist/esm/management/api/resources/users/resources/sessions/client/Client.mjs +6 -2
- package/dist/esm/management/api/resources/verifiableCredentials/resources/verification/resources/templates/client/Client.d.mts +1 -1
- package/dist/esm/management/api/resources/verifiableCredentials/resources/verification/resources/templates/client/Client.mjs +10 -6
- package/dist/esm/management/api/types/types.d.mts +3481 -148
- package/dist/esm/management/api/types/types.mjs +610 -5
- package/dist/esm/management/core/fetcher/Fetcher.d.mts +6 -0
- package/dist/esm/management/core/fetcher/Fetcher.mjs +9 -8
- package/dist/esm/management/core/index.d.mts +1 -0
- package/dist/esm/management/core/index.mjs +1 -0
- package/dist/esm/management/core/stream/Stream.d.mts +56 -0
- package/dist/esm/management/core/stream/Stream.mjs +262 -0
- package/dist/esm/management/core/stream/index.d.mts +1 -0
- package/dist/esm/management/core/stream/index.mjs +1 -0
- package/dist/esm/management/core/url/QueryStringBuilder.d.mts +47 -0
- package/dist/esm/management/core/url/QueryStringBuilder.mjs +80 -0
- package/dist/esm/management/core/url/index.d.mts +1 -0
- package/dist/esm/management/core/url/index.mjs +1 -0
- package/dist/esm/management/core/url/qs.d.mts +2 -1
- package/dist/esm/management/core/url/qs.mjs +24 -12
- package/dist/esm/management/version.d.mts +1 -1
- package/dist/esm/management/version.mjs +1 -1
- package/package.json +1 -1
- package/reference.md +668 -331
package/reference.md
CHANGED
|
@@ -2153,6 +2153,7 @@ To search by checkpoint, use the following parameters:
|
|
|
2153
2153
|
const pageableResponse = await client.connections.list({
|
|
2154
2154
|
from: "from",
|
|
2155
2155
|
take: 1,
|
|
2156
|
+
strategy: ["ad"],
|
|
2156
2157
|
name: "name",
|
|
2157
2158
|
fields: "fields",
|
|
2158
2159
|
include_fields: true,
|
|
@@ -2165,6 +2166,7 @@ for await (const item of pageableResponse) {
|
|
|
2165
2166
|
let page = await client.connections.list({
|
|
2166
2167
|
from: "from",
|
|
2167
2168
|
take: 1,
|
|
2169
|
+
strategy: ["ad"],
|
|
2168
2170
|
name: "name",
|
|
2169
2171
|
fields: "fields",
|
|
2170
2172
|
include_fields: true,
|
|
@@ -4008,6 +4010,78 @@ await client.eventStreams.test("id", {
|
|
|
4008
4010
|
</dl>
|
|
4009
4011
|
</details>
|
|
4010
4012
|
|
|
4013
|
+
## Events
|
|
4014
|
+
|
|
4015
|
+
<details><summary><code>client.events.<a href="/src/management/api/resources/events/client/Client.ts">subscribe</a>({ ...params }) -> core.Stream<Management.EventStreamSubscribeEventsResponseContent></code></summary>
|
|
4016
|
+
<dl>
|
|
4017
|
+
<dd>
|
|
4018
|
+
|
|
4019
|
+
#### 📝 Description
|
|
4020
|
+
|
|
4021
|
+
<dl>
|
|
4022
|
+
<dd>
|
|
4023
|
+
|
|
4024
|
+
<dl>
|
|
4025
|
+
<dd>
|
|
4026
|
+
|
|
4027
|
+
Subscribe to events via Server-Sent Events (SSE)
|
|
4028
|
+
|
|
4029
|
+
</dd>
|
|
4030
|
+
</dl>
|
|
4031
|
+
</dd>
|
|
4032
|
+
</dl>
|
|
4033
|
+
|
|
4034
|
+
#### 🔌 Usage
|
|
4035
|
+
|
|
4036
|
+
<dl>
|
|
4037
|
+
<dd>
|
|
4038
|
+
|
|
4039
|
+
<dl>
|
|
4040
|
+
<dd>
|
|
4041
|
+
|
|
4042
|
+
```typescript
|
|
4043
|
+
const response = await client.events.subscribe({
|
|
4044
|
+
from: "from",
|
|
4045
|
+
from_timestamp: "from_timestamp",
|
|
4046
|
+
event_type: ["group.created"],
|
|
4047
|
+
});
|
|
4048
|
+
for await (const item of response) {
|
|
4049
|
+
console.log(item);
|
|
4050
|
+
}
|
|
4051
|
+
```
|
|
4052
|
+
|
|
4053
|
+
</dd>
|
|
4054
|
+
</dl>
|
|
4055
|
+
</dd>
|
|
4056
|
+
</dl>
|
|
4057
|
+
|
|
4058
|
+
#### ⚙️ Parameters
|
|
4059
|
+
|
|
4060
|
+
<dl>
|
|
4061
|
+
<dd>
|
|
4062
|
+
|
|
4063
|
+
<dl>
|
|
4064
|
+
<dd>
|
|
4065
|
+
|
|
4066
|
+
**request:** `Management.SubscribeEventsRequestParameters`
|
|
4067
|
+
|
|
4068
|
+
</dd>
|
|
4069
|
+
</dl>
|
|
4070
|
+
|
|
4071
|
+
<dl>
|
|
4072
|
+
<dd>
|
|
4073
|
+
|
|
4074
|
+
**requestOptions:** `EventsClient.RequestOptions`
|
|
4075
|
+
|
|
4076
|
+
</dd>
|
|
4077
|
+
</dl>
|
|
4078
|
+
</dd>
|
|
4079
|
+
</dl>
|
|
4080
|
+
|
|
4081
|
+
</dd>
|
|
4082
|
+
</dl>
|
|
4083
|
+
</details>
|
|
4084
|
+
|
|
4011
4085
|
## Flows
|
|
4012
4086
|
|
|
4013
4087
|
<details><summary><code>client.flows.<a href="/src/management/api/resources/flows/client/Client.ts">list</a>({ ...params }) -> core.Page<Management.FlowSummary, Management.ListFlowsOffsetPaginatedResponseContent></code></summary>
|
|
@@ -4027,6 +4101,7 @@ const pageableResponse = await client.flows.list({
|
|
|
4027
4101
|
page: 1,
|
|
4028
4102
|
per_page: 1,
|
|
4029
4103
|
include_totals: true,
|
|
4104
|
+
hydrate: ["form_count"],
|
|
4030
4105
|
synchronous: true,
|
|
4031
4106
|
});
|
|
4032
4107
|
for await (const item of pageableResponse) {
|
|
@@ -4038,6 +4113,7 @@ let page = await client.flows.list({
|
|
|
4038
4113
|
page: 1,
|
|
4039
4114
|
per_page: 1,
|
|
4040
4115
|
include_totals: true,
|
|
4116
|
+
hydrate: ["form_count"],
|
|
4041
4117
|
synchronous: true,
|
|
4042
4118
|
});
|
|
4043
4119
|
while (page.hasNextPage()) {
|
|
@@ -4143,7 +4219,9 @@ await client.flows.create({
|
|
|
4143
4219
|
<dd>
|
|
4144
4220
|
|
|
4145
4221
|
```typescript
|
|
4146
|
-
await client.flows.get("id"
|
|
4222
|
+
await client.flows.get("id", {
|
|
4223
|
+
hydrate: ["form_count"],
|
|
4224
|
+
});
|
|
4147
4225
|
```
|
|
4148
4226
|
|
|
4149
4227
|
</dd>
|
|
@@ -4309,6 +4387,7 @@ const pageableResponse = await client.forms.list({
|
|
|
4309
4387
|
page: 1,
|
|
4310
4388
|
per_page: 1,
|
|
4311
4389
|
include_totals: true,
|
|
4390
|
+
hydrate: ["flow_count"],
|
|
4312
4391
|
});
|
|
4313
4392
|
for await (const item of pageableResponse) {
|
|
4314
4393
|
console.log(item);
|
|
@@ -4319,6 +4398,7 @@ let page = await client.forms.list({
|
|
|
4319
4398
|
page: 1,
|
|
4320
4399
|
per_page: 1,
|
|
4321
4400
|
include_totals: true,
|
|
4401
|
+
hydrate: ["flow_count"],
|
|
4322
4402
|
});
|
|
4323
4403
|
while (page.hasNextPage()) {
|
|
4324
4404
|
page = page.getNextPage();
|
|
@@ -4423,7 +4503,9 @@ await client.forms.create({
|
|
|
4423
4503
|
<dd>
|
|
4424
4504
|
|
|
4425
4505
|
```typescript
|
|
4426
|
-
await client.forms.get("id"
|
|
4506
|
+
await client.forms.get("id", {
|
|
4507
|
+
hydrate: ["flow_count"],
|
|
4508
|
+
});
|
|
4427
4509
|
```
|
|
4428
4510
|
|
|
4429
4511
|
</dd>
|
|
@@ -4823,6 +4905,7 @@ const pageableResponse = await client.groups.list({
|
|
|
4823
4905
|
connection_id: "connection_id",
|
|
4824
4906
|
name: "name",
|
|
4825
4907
|
external_id: "external_id",
|
|
4908
|
+
search: "search",
|
|
4826
4909
|
fields: "fields",
|
|
4827
4910
|
include_fields: true,
|
|
4828
4911
|
from: "from",
|
|
@@ -4837,6 +4920,7 @@ let page = await client.groups.list({
|
|
|
4837
4920
|
connection_id: "connection_id",
|
|
4838
4921
|
name: "name",
|
|
4839
4922
|
external_id: "external_id",
|
|
4923
|
+
search: "search",
|
|
4840
4924
|
fields: "fields",
|
|
4841
4925
|
include_fields: true,
|
|
4842
4926
|
from: "from",
|
|
@@ -5452,73 +5536,81 @@ await client.jobs.get("id");
|
|
|
5452
5536
|
<dl>
|
|
5453
5537
|
<dd>
|
|
5454
5538
|
|
|
5455
|
-
Retrieve details on
|
|
5539
|
+
Retrieve details on [log streams](https://auth0.com/docs/logs/streams).
|
|
5540
|
+
|
|
5541
|
+
**Sample Response**
|
|
5542
|
+
|
|
5543
|
+
```json
|
|
5544
|
+
[
|
|
5545
|
+
{
|
|
5546
|
+
"id": "string",
|
|
5547
|
+
"name": "string",
|
|
5548
|
+
"type": "eventbridge",
|
|
5549
|
+
"status": "active|paused|suspended",
|
|
5550
|
+
"sink": {
|
|
5551
|
+
"awsAccountId": "string",
|
|
5552
|
+
"awsRegion": "string",
|
|
5553
|
+
"awsPartnerEventSource": "string"
|
|
5554
|
+
}
|
|
5555
|
+
},
|
|
5556
|
+
{
|
|
5557
|
+
"id": "string",
|
|
5558
|
+
"name": "string",
|
|
5559
|
+
"type": "http",
|
|
5560
|
+
"status": "active|paused|suspended",
|
|
5561
|
+
"sink": {
|
|
5562
|
+
"httpContentFormat": "JSONLINES|JSONARRAY",
|
|
5563
|
+
"httpContentType": "string",
|
|
5564
|
+
"httpEndpoint": "string",
|
|
5565
|
+
"httpAuthorization": "string"
|
|
5566
|
+
}
|
|
5567
|
+
},
|
|
5568
|
+
{
|
|
5569
|
+
"id": "string",
|
|
5570
|
+
"name": "string",
|
|
5571
|
+
"type": "eventgrid",
|
|
5572
|
+
"status": "active|paused|suspended",
|
|
5573
|
+
"sink": {
|
|
5574
|
+
"azureSubscriptionId": "string",
|
|
5575
|
+
"azureResourceGroup": "string",
|
|
5576
|
+
"azureRegion": "string",
|
|
5577
|
+
"azurePartnerTopic": "string"
|
|
5578
|
+
}
|
|
5579
|
+
},
|
|
5580
|
+
{
|
|
5581
|
+
"id": "string",
|
|
5582
|
+
"name": "string",
|
|
5583
|
+
"type": "splunk",
|
|
5584
|
+
"status": "active|paused|suspended",
|
|
5585
|
+
"sink": {
|
|
5586
|
+
"splunkDomain": "string",
|
|
5587
|
+
"splunkToken": "string",
|
|
5588
|
+
"splunkPort": "string",
|
|
5589
|
+
"splunkSecure": "boolean"
|
|
5590
|
+
}
|
|
5591
|
+
},
|
|
5592
|
+
{
|
|
5593
|
+
"id": "string",
|
|
5594
|
+
"name": "string",
|
|
5595
|
+
"type": "sumo",
|
|
5596
|
+
"status": "active|paused|suspended",
|
|
5597
|
+
"sink": {
|
|
5598
|
+
"sumoSourceAddress": "string"
|
|
5599
|
+
}
|
|
5600
|
+
},
|
|
5601
|
+
{
|
|
5602
|
+
"id": "string",
|
|
5603
|
+
"name": "string",
|
|
5604
|
+
"type": "datadog",
|
|
5605
|
+
"status": "active|paused|suspended",
|
|
5606
|
+
"sink": {
|
|
5607
|
+
"datadogRegion": "string",
|
|
5608
|
+
"datadogApiKey": "string"
|
|
5609
|
+
}
|
|
5610
|
+
}
|
|
5611
|
+
]
|
|
5612
|
+
```
|
|
5456
5613
|
|
|
5457
|
-
<h5>Sample Response</h5><pre><code>[{
|
|
5458
|
-
"id": "string",
|
|
5459
|
-
"name": "string",
|
|
5460
|
-
"type": "eventbridge",
|
|
5461
|
-
"status": "active|paused|suspended",
|
|
5462
|
-
"sink": {
|
|
5463
|
-
"awsAccountId": "string",
|
|
5464
|
-
"awsRegion": "string",
|
|
5465
|
-
"awsPartnerEventSource": "string"
|
|
5466
|
-
}
|
|
5467
|
-
}, {
|
|
5468
|
-
"id": "string",
|
|
5469
|
-
"name": "string",
|
|
5470
|
-
"type": "http",
|
|
5471
|
-
"status": "active|paused|suspended",
|
|
5472
|
-
"sink": {
|
|
5473
|
-
"httpContentFormat": "JSONLINES|JSONARRAY",
|
|
5474
|
-
"httpContentType": "string",
|
|
5475
|
-
"httpEndpoint": "string",
|
|
5476
|
-
"httpAuthorization": "string"
|
|
5477
|
-
}
|
|
5478
|
-
},
|
|
5479
|
-
{
|
|
5480
|
-
"id": "string",
|
|
5481
|
-
"name": "string",
|
|
5482
|
-
"type": "eventgrid",
|
|
5483
|
-
"status": "active|paused|suspended",
|
|
5484
|
-
"sink": {
|
|
5485
|
-
"azureSubscriptionId": "string",
|
|
5486
|
-
"azureResourceGroup": "string",
|
|
5487
|
-
"azureRegion": "string",
|
|
5488
|
-
"azurePartnerTopic": "string"
|
|
5489
|
-
}
|
|
5490
|
-
},
|
|
5491
|
-
{
|
|
5492
|
-
"id": "string",
|
|
5493
|
-
"name": "string",
|
|
5494
|
-
"type": "splunk",
|
|
5495
|
-
"status": "active|paused|suspended",
|
|
5496
|
-
"sink": {
|
|
5497
|
-
"splunkDomain": "string",
|
|
5498
|
-
"splunkToken": "string",
|
|
5499
|
-
"splunkPort": "string",
|
|
5500
|
-
"splunkSecure": "boolean"
|
|
5501
|
-
}
|
|
5502
|
-
},
|
|
5503
|
-
{
|
|
5504
|
-
"id": "string",
|
|
5505
|
-
"name": "string",
|
|
5506
|
-
"type": "sumo",
|
|
5507
|
-
"status": "active|paused|suspended",
|
|
5508
|
-
"sink": {
|
|
5509
|
-
"sumoSourceAddress": "string",
|
|
5510
|
-
}
|
|
5511
|
-
},
|
|
5512
|
-
{
|
|
5513
|
-
"id": "string",
|
|
5514
|
-
"name": "string",
|
|
5515
|
-
"type": "datadog",
|
|
5516
|
-
"status": "active|paused|suspended",
|
|
5517
|
-
"sink": {
|
|
5518
|
-
"datadogRegion": "string",
|
|
5519
|
-
"datadogApiKey": "string"
|
|
5520
|
-
}
|
|
5521
|
-
}]</code></pre>
|
|
5522
5614
|
</dd>
|
|
5523
5615
|
</dl>
|
|
5524
5616
|
</dd>
|
|
@@ -5574,131 +5666,214 @@ await client.logStreams.list();
|
|
|
5574
5666
|
|
|
5575
5667
|
Create a log stream.
|
|
5576
5668
|
|
|
5577
|
-
|
|
5578
|
-
|
|
5579
|
-
|
|
5580
|
-
|
|
5581
|
-
|
|
5582
|
-
|
|
5583
|
-
|
|
5584
|
-
|
|
5585
|
-
|
|
5586
|
-
|
|
5587
|
-
|
|
5588
|
-
|
|
5589
|
-
|
|
5590
|
-
|
|
5591
|
-
|
|
5592
|
-
|
|
5593
|
-
|
|
5594
|
-
|
|
5595
|
-
|
|
5596
|
-
|
|
5597
|
-
|
|
5598
|
-
|
|
5599
|
-
|
|
5600
|
-
|
|
5601
|
-
|
|
5602
|
-
|
|
5603
|
-
|
|
5604
|
-
|
|
5605
|
-
|
|
5606
|
-
|
|
5607
|
-
|
|
5608
|
-
|
|
5609
|
-
|
|
5610
|
-
|
|
5611
|
-
|
|
5612
|
-
|
|
5613
|
-
|
|
5614
|
-
|
|
5615
|
-
|
|
5616
|
-
|
|
5617
|
-
|
|
5618
|
-
|
|
5619
|
-
|
|
5620
|
-
|
|
5621
|
-
|
|
5622
|
-
|
|
5623
|
-
|
|
5624
|
-
|
|
5625
|
-
|
|
5626
|
-
|
|
5627
|
-
|
|
5628
|
-
|
|
5629
|
-
|
|
5630
|
-
}
|
|
5631
|
-
|
|
5632
|
-
|
|
5633
|
-
|
|
5634
|
-
|
|
5635
|
-
|
|
5636
|
-
|
|
5637
|
-
|
|
5638
|
-
|
|
5639
|
-
|
|
5640
|
-
|
|
5641
|
-
|
|
5642
|
-
|
|
5643
|
-
|
|
5644
|
-
|
|
5645
|
-
|
|
5646
|
-
|
|
5647
|
-
|
|
5648
|
-
|
|
5649
|
-
|
|
5650
|
-
|
|
5651
|
-
|
|
5652
|
-
|
|
5653
|
-
|
|
5654
|
-
|
|
5655
|
-
|
|
5656
|
-
|
|
5657
|
-
|
|
5658
|
-
|
|
5659
|
-
|
|
5660
|
-
|
|
5661
|
-
|
|
5662
|
-
|
|
5663
|
-
|
|
5664
|
-
|
|
5665
|
-
|
|
5666
|
-
|
|
5667
|
-
|
|
5668
|
-
|
|
5669
|
-
|
|
5670
|
-
|
|
5671
|
-
|
|
5672
|
-
|
|
5673
|
-
|
|
5674
|
-
|
|
5675
|
-
|
|
5676
|
-
|
|
5677
|
-
|
|
5678
|
-
|
|
5679
|
-
|
|
5680
|
-
|
|
5681
|
-
|
|
5682
|
-
|
|
5683
|
-
|
|
5684
|
-
}
|
|
5685
|
-
|
|
5686
|
-
|
|
5687
|
-
|
|
5688
|
-
|
|
5689
|
-
|
|
5690
|
-
|
|
5691
|
-
|
|
5692
|
-
|
|
5693
|
-
|
|
5694
|
-
|
|
5695
|
-
|
|
5696
|
-
|
|
5697
|
-
|
|
5698
|
-
|
|
5699
|
-
|
|
5700
|
-
|
|
5701
|
-
}
|
|
5669
|
+
**Log Stream Types**
|
|
5670
|
+
|
|
5671
|
+
The `type` of log stream being created determines the properties required in the `sink` payload.
|
|
5672
|
+
|
|
5673
|
+
**HTTP Stream**
|
|
5674
|
+
|
|
5675
|
+
For an `http` Stream, the `sink` properties are listed in the payload below.
|
|
5676
|
+
|
|
5677
|
+
**Request:**
|
|
5678
|
+
|
|
5679
|
+
```json
|
|
5680
|
+
{
|
|
5681
|
+
"name": "string",
|
|
5682
|
+
"type": "http",
|
|
5683
|
+
"sink": {
|
|
5684
|
+
"httpEndpoint": "string",
|
|
5685
|
+
"httpContentType": "string",
|
|
5686
|
+
"httpContentFormat": "JSONLINES|JSONARRAY",
|
|
5687
|
+
"httpAuthorization": "string"
|
|
5688
|
+
}
|
|
5689
|
+
}
|
|
5690
|
+
```
|
|
5691
|
+
|
|
5692
|
+
**Response:**
|
|
5693
|
+
|
|
5694
|
+
```json
|
|
5695
|
+
{
|
|
5696
|
+
"id": "string",
|
|
5697
|
+
"name": "string",
|
|
5698
|
+
"type": "http",
|
|
5699
|
+
"status": "active",
|
|
5700
|
+
"sink": {
|
|
5701
|
+
"httpEndpoint": "string",
|
|
5702
|
+
"httpContentType": "string",
|
|
5703
|
+
"httpContentFormat": "JSONLINES|JSONARRAY",
|
|
5704
|
+
"httpAuthorization": "string"
|
|
5705
|
+
}
|
|
5706
|
+
}
|
|
5707
|
+
```
|
|
5708
|
+
|
|
5709
|
+
**Amazon EventBridge Stream**
|
|
5710
|
+
|
|
5711
|
+
For an `eventbridge` Stream, the `sink` properties are listed in the payload below.
|
|
5712
|
+
|
|
5713
|
+
**Request:**
|
|
5714
|
+
|
|
5715
|
+
```json
|
|
5716
|
+
{
|
|
5717
|
+
"name": "string",
|
|
5718
|
+
"type": "eventbridge",
|
|
5719
|
+
"sink": {
|
|
5720
|
+
"awsRegion": "string",
|
|
5721
|
+
"awsAccountId": "string"
|
|
5722
|
+
}
|
|
5723
|
+
}
|
|
5724
|
+
```
|
|
5725
|
+
|
|
5726
|
+
The response will include an additional field `awsPartnerEventSource` in the `sink`:
|
|
5727
|
+
|
|
5728
|
+
**Response:**
|
|
5729
|
+
|
|
5730
|
+
```json
|
|
5731
|
+
{
|
|
5732
|
+
"id": "string",
|
|
5733
|
+
"name": "string",
|
|
5734
|
+
"type": "eventbridge",
|
|
5735
|
+
"status": "active",
|
|
5736
|
+
"sink": {
|
|
5737
|
+
"awsAccountId": "string",
|
|
5738
|
+
"awsRegion": "string",
|
|
5739
|
+
"awsPartnerEventSource": "string"
|
|
5740
|
+
}
|
|
5741
|
+
}
|
|
5742
|
+
```
|
|
5743
|
+
|
|
5744
|
+
**Azure Event Grid Stream**
|
|
5745
|
+
|
|
5746
|
+
For an `Azure Event Grid` Stream, the `sink` properties are listed in the payload below.
|
|
5747
|
+
|
|
5748
|
+
**Request:**
|
|
5749
|
+
|
|
5750
|
+
```json
|
|
5751
|
+
{
|
|
5752
|
+
"name": "string",
|
|
5753
|
+
"type": "eventgrid",
|
|
5754
|
+
"sink": {
|
|
5755
|
+
"azureSubscriptionId": "string",
|
|
5756
|
+
"azureResourceGroup": "string",
|
|
5757
|
+
"azureRegion": "string"
|
|
5758
|
+
}
|
|
5759
|
+
}
|
|
5760
|
+
```
|
|
5761
|
+
|
|
5762
|
+
**Response:**
|
|
5763
|
+
|
|
5764
|
+
```json
|
|
5765
|
+
{
|
|
5766
|
+
"id": "string",
|
|
5767
|
+
"name": "string",
|
|
5768
|
+
"type": "http",
|
|
5769
|
+
"status": "active",
|
|
5770
|
+
"sink": {
|
|
5771
|
+
"azureSubscriptionId": "string",
|
|
5772
|
+
"azureResourceGroup": "string",
|
|
5773
|
+
"azureRegion": "string",
|
|
5774
|
+
"azurePartnerTopic": "string"
|
|
5775
|
+
}
|
|
5776
|
+
}
|
|
5777
|
+
```
|
|
5778
|
+
|
|
5779
|
+
**Datadog Stream**
|
|
5780
|
+
|
|
5781
|
+
For a `Datadog` Stream, the `sink` properties are listed in the payload below.
|
|
5782
|
+
|
|
5783
|
+
**Request:**
|
|
5784
|
+
|
|
5785
|
+
```json
|
|
5786
|
+
{
|
|
5787
|
+
"name": "string",
|
|
5788
|
+
"type": "datadog",
|
|
5789
|
+
"sink": {
|
|
5790
|
+
"datadogRegion": "string",
|
|
5791
|
+
"datadogApiKey": "string"
|
|
5792
|
+
}
|
|
5793
|
+
}
|
|
5794
|
+
```
|
|
5795
|
+
|
|
5796
|
+
**Response:**
|
|
5797
|
+
|
|
5798
|
+
```json
|
|
5799
|
+
{
|
|
5800
|
+
"id": "string",
|
|
5801
|
+
"name": "string",
|
|
5802
|
+
"type": "datadog",
|
|
5803
|
+
"status": "active",
|
|
5804
|
+
"sink": {
|
|
5805
|
+
"datadogRegion": "string",
|
|
5806
|
+
"datadogApiKey": "string"
|
|
5807
|
+
}
|
|
5808
|
+
}
|
|
5809
|
+
```
|
|
5810
|
+
|
|
5811
|
+
**Splunk Stream**
|
|
5812
|
+
|
|
5813
|
+
For a `Splunk` Stream, the `sink` properties are listed in the payload below.
|
|
5814
|
+
|
|
5815
|
+
**Request:**
|
|
5816
|
+
|
|
5817
|
+
```json
|
|
5818
|
+
{
|
|
5819
|
+
"name": "string",
|
|
5820
|
+
"type": "splunk",
|
|
5821
|
+
"sink": {
|
|
5822
|
+
"splunkDomain": "string",
|
|
5823
|
+
"splunkToken": "string",
|
|
5824
|
+
"splunkPort": "string",
|
|
5825
|
+
"splunkSecure": "boolean"
|
|
5826
|
+
}
|
|
5827
|
+
}
|
|
5828
|
+
```
|
|
5829
|
+
|
|
5830
|
+
**Response:**
|
|
5831
|
+
|
|
5832
|
+
```json
|
|
5833
|
+
{
|
|
5834
|
+
"id": "string",
|
|
5835
|
+
"name": "string",
|
|
5836
|
+
"type": "splunk",
|
|
5837
|
+
"status": "active",
|
|
5838
|
+
"sink": {
|
|
5839
|
+
"splunkDomain": "string",
|
|
5840
|
+
"splunkToken": "string",
|
|
5841
|
+
"splunkPort": "string",
|
|
5842
|
+
"splunkSecure": "boolean"
|
|
5843
|
+
}
|
|
5844
|
+
}
|
|
5845
|
+
```
|
|
5846
|
+
|
|
5847
|
+
**Sumo Logic Stream**
|
|
5848
|
+
|
|
5849
|
+
For a `Sumo Logic` Stream, the `sink` properties are listed in the payload below.
|
|
5850
|
+
|
|
5851
|
+
**Request:**
|
|
5852
|
+
|
|
5853
|
+
```json
|
|
5854
|
+
{
|
|
5855
|
+
"name": "string",
|
|
5856
|
+
"type": "sumo",
|
|
5857
|
+
"sink": {
|
|
5858
|
+
"sumoSourceAddress": "string"
|
|
5859
|
+
}
|
|
5860
|
+
}
|
|
5861
|
+
```
|
|
5862
|
+
|
|
5863
|
+
**Response:**
|
|
5864
|
+
|
|
5865
|
+
```json
|
|
5866
|
+
{
|
|
5867
|
+
"id": "string",
|
|
5868
|
+
"name": "string",
|
|
5869
|
+
"type": "sumo",
|
|
5870
|
+
"status": "active",
|
|
5871
|
+
"sink": {
|
|
5872
|
+
"sumoSourceAddress": "string"
|
|
5873
|
+
}
|
|
5874
|
+
}
|
|
5875
|
+
```
|
|
5876
|
+
|
|
5702
5877
|
</dd>
|
|
5703
5878
|
</dl>
|
|
5704
5879
|
</dd>
|
|
@@ -5767,108 +5942,160 @@ await client.logStreams.create({
|
|
|
5767
5942
|
|
|
5768
5943
|
Retrieve a log stream configuration and status.
|
|
5769
5944
|
|
|
5770
|
-
|
|
5771
|
-
|
|
5772
|
-
|
|
5773
|
-
|
|
5774
|
-
|
|
5775
|
-
|
|
5776
|
-
|
|
5777
|
-
|
|
5778
|
-
|
|
5779
|
-
|
|
5780
|
-
|
|
5781
|
-
|
|
5782
|
-
|
|
5783
|
-
|
|
5784
|
-
|
|
5785
|
-
"sink": {
|
|
5786
|
-
"httpContentFormat": "JSONLINES|JSONARRAY",
|
|
5787
|
-
"httpContentType": "string",
|
|
5788
|
-
"httpEndpoint": "string",
|
|
5789
|
-
"httpAuthorization": "string"
|
|
5790
|
-
}
|
|
5791
|
-
}</code></pre> <h5>Datadog Log Stream</h5><pre><code>{
|
|
5792
|
-
"id": "string",
|
|
5793
|
-
"name": "string",
|
|
5794
|
-
"type": "datadog",
|
|
5795
|
-
"status": "active|paused|suspended",
|
|
5796
|
-
"sink": {
|
|
5797
|
-
"datadogRegion": "string",
|
|
5798
|
-
"datadogApiKey": "string"
|
|
5799
|
-
}
|
|
5800
|
-
|
|
5801
|
-
}</code></pre><h5>Mixpanel</h5>
|
|
5802
|
-
Request: <pre><code>{
|
|
5803
|
-
"name": "string",
|
|
5804
|
-
"type": "mixpanel",
|
|
5805
|
-
"sink": {
|
|
5806
|
-
"mixpanelRegion": "string", // "us" | "eu",
|
|
5807
|
-
"mixpanelProjectId": "string",
|
|
5808
|
-
"mixpanelServiceAccountUsername": "string",
|
|
5809
|
-
"mixpanelServiceAccountPassword": "string"
|
|
5945
|
+
**Sample responses**
|
|
5946
|
+
|
|
5947
|
+
**Amazon EventBridge Log Stream**
|
|
5948
|
+
|
|
5949
|
+
```json
|
|
5950
|
+
{
|
|
5951
|
+
"id": "string",
|
|
5952
|
+
"name": "string",
|
|
5953
|
+
"type": "eventbridge",
|
|
5954
|
+
"status": "active|paused|suspended",
|
|
5955
|
+
"sink": {
|
|
5956
|
+
"awsAccountId": "string",
|
|
5957
|
+
"awsRegion": "string",
|
|
5958
|
+
"awsPartnerEventSource": "string"
|
|
5959
|
+
}
|
|
5810
5960
|
}
|
|
5811
|
-
|
|
5812
|
-
|
|
5813
|
-
|
|
5814
|
-
|
|
5815
|
-
|
|
5816
|
-
|
|
5817
|
-
"
|
|
5818
|
-
"
|
|
5819
|
-
"
|
|
5820
|
-
"
|
|
5821
|
-
"
|
|
5961
|
+
```
|
|
5962
|
+
|
|
5963
|
+
**HTTP Log Stream**
|
|
5964
|
+
|
|
5965
|
+
```json
|
|
5966
|
+
{
|
|
5967
|
+
"id": "string",
|
|
5968
|
+
"name": "string",
|
|
5969
|
+
"type": "http",
|
|
5970
|
+
"status": "active|paused|suspended",
|
|
5971
|
+
"sink": {
|
|
5972
|
+
"httpContentFormat": "JSONLINES|JSONARRAY",
|
|
5973
|
+
"httpContentType": "string",
|
|
5974
|
+
"httpEndpoint": "string",
|
|
5975
|
+
"httpAuthorization": "string"
|
|
5976
|
+
}
|
|
5822
5977
|
}
|
|
5823
|
-
|
|
5978
|
+
```
|
|
5824
5979
|
|
|
5825
|
-
|
|
5980
|
+
**Datadog Log Stream**
|
|
5826
5981
|
|
|
5827
|
-
|
|
5828
|
-
|
|
5829
|
-
|
|
5830
|
-
|
|
5831
|
-
|
|
5832
|
-
|
|
5833
|
-
|
|
5834
|
-
|
|
5835
|
-
|
|
5836
|
-
|
|
5837
|
-
|
|
5838
|
-
|
|
5839
|
-
"status": "active",
|
|
5840
|
-
"sink": {
|
|
5841
|
-
"segmentWriteKey": "string"
|
|
5842
|
-
}
|
|
5843
|
-
} </code></pre>
|
|
5982
|
+
```json
|
|
5983
|
+
{
|
|
5984
|
+
"id": "string",
|
|
5985
|
+
"name": "string",
|
|
5986
|
+
"type": "datadog",
|
|
5987
|
+
"status": "active|paused|suspended",
|
|
5988
|
+
"sink": {
|
|
5989
|
+
"datadogRegion": "string",
|
|
5990
|
+
"datadogApiKey": "string"
|
|
5991
|
+
}
|
|
5992
|
+
}
|
|
5993
|
+
```
|
|
5844
5994
|
|
|
5845
|
-
|
|
5846
|
-
|
|
5847
|
-
|
|
5848
|
-
|
|
5849
|
-
|
|
5850
|
-
|
|
5851
|
-
|
|
5852
|
-
|
|
5853
|
-
|
|
5854
|
-
|
|
5855
|
-
|
|
5856
|
-
|
|
5857
|
-
|
|
5858
|
-
|
|
5859
|
-
|
|
5860
|
-
|
|
5861
|
-
|
|
5862
|
-
|
|
5863
|
-
|
|
5864
|
-
|
|
5865
|
-
|
|
5866
|
-
|
|
5867
|
-
|
|
5868
|
-
|
|
5869
|
-
|
|
5870
|
-
|
|
5871
|
-
|
|
5995
|
+
**Mixpanel**
|
|
5996
|
+
|
|
5997
|
+
**Request:**
|
|
5998
|
+
|
|
5999
|
+
```json
|
|
6000
|
+
{
|
|
6001
|
+
"name": "string",
|
|
6002
|
+
"type": "mixpanel",
|
|
6003
|
+
"sink": {
|
|
6004
|
+
"mixpanelRegion": "string",
|
|
6005
|
+
"mixpanelProjectId": "string",
|
|
6006
|
+
"mixpanelServiceAccountUsername": "string",
|
|
6007
|
+
"mixpanelServiceAccountPassword": "string"
|
|
6008
|
+
}
|
|
6009
|
+
}
|
|
6010
|
+
```
|
|
6011
|
+
|
|
6012
|
+
**Response:**
|
|
6013
|
+
|
|
6014
|
+
```json
|
|
6015
|
+
{
|
|
6016
|
+
"id": "string",
|
|
6017
|
+
"name": "string",
|
|
6018
|
+
"type": "mixpanel",
|
|
6019
|
+
"status": "active",
|
|
6020
|
+
"sink": {
|
|
6021
|
+
"mixpanelRegion": "string",
|
|
6022
|
+
"mixpanelProjectId": "string",
|
|
6023
|
+
"mixpanelServiceAccountUsername": "string",
|
|
6024
|
+
"mixpanelServiceAccountPassword": "string"
|
|
6025
|
+
}
|
|
6026
|
+
}
|
|
6027
|
+
```
|
|
6028
|
+
|
|
6029
|
+
**Segment**
|
|
6030
|
+
|
|
6031
|
+
**Request:**
|
|
6032
|
+
|
|
6033
|
+
```json
|
|
6034
|
+
{
|
|
6035
|
+
"name": "string",
|
|
6036
|
+
"type": "segment",
|
|
6037
|
+
"sink": {
|
|
6038
|
+
"segmentWriteKey": "string"
|
|
6039
|
+
}
|
|
6040
|
+
}
|
|
6041
|
+
```
|
|
6042
|
+
|
|
6043
|
+
**Response:**
|
|
6044
|
+
|
|
6045
|
+
```json
|
|
6046
|
+
{
|
|
6047
|
+
"id": "string",
|
|
6048
|
+
"name": "string",
|
|
6049
|
+
"type": "segment",
|
|
6050
|
+
"status": "active",
|
|
6051
|
+
"sink": {
|
|
6052
|
+
"segmentWriteKey": "string"
|
|
6053
|
+
}
|
|
6054
|
+
}
|
|
6055
|
+
```
|
|
6056
|
+
|
|
6057
|
+
**Splunk Log Stream**
|
|
6058
|
+
|
|
6059
|
+
```json
|
|
6060
|
+
{
|
|
6061
|
+
"id": "string",
|
|
6062
|
+
"name": "string",
|
|
6063
|
+
"type": "splunk",
|
|
6064
|
+
"status": "active|paused|suspended",
|
|
6065
|
+
"sink": {
|
|
6066
|
+
"splunkDomain": "string",
|
|
6067
|
+
"splunkToken": "string",
|
|
6068
|
+
"splunkPort": "string",
|
|
6069
|
+
"splunkSecure": "boolean"
|
|
6070
|
+
}
|
|
6071
|
+
}
|
|
6072
|
+
```
|
|
6073
|
+
|
|
6074
|
+
**Sumo Logic Log Stream**
|
|
6075
|
+
|
|
6076
|
+
```json
|
|
6077
|
+
{
|
|
6078
|
+
"id": "string",
|
|
6079
|
+
"name": "string",
|
|
6080
|
+
"type": "sumo",
|
|
6081
|
+
"status": "active|paused|suspended",
|
|
6082
|
+
"sink": {
|
|
6083
|
+
"sumoSourceAddress": "string"
|
|
6084
|
+
}
|
|
6085
|
+
}
|
|
6086
|
+
```
|
|
6087
|
+
|
|
6088
|
+
**Status**
|
|
6089
|
+
|
|
6090
|
+
The `status` of a log stream maybe any of the following:
|
|
6091
|
+
|
|
6092
|
+
1. `active` - Stream is currently enabled.
|
|
6093
|
+
2. `paused` - Stream is currently user disabled and will not attempt log delivery.
|
|
6094
|
+
3. `suspended` - Stream is currently disabled because of errors and will not attempt log delivery.
|
|
6095
|
+
</dd>
|
|
6096
|
+
</dl>
|
|
6097
|
+
</dd>
|
|
6098
|
+
</dl>
|
|
5872
6099
|
|
|
5873
6100
|
#### 🔌 Usage
|
|
5874
6101
|
|
|
@@ -5991,40 +6218,79 @@ await client.logStreams.delete("id");
|
|
|
5991
6218
|
|
|
5992
6219
|
Update a log stream.
|
|
5993
6220
|
|
|
5994
|
-
|
|
5995
|
-
|
|
5996
|
-
|
|
5997
|
-
|
|
5998
|
-
|
|
5999
|
-
|
|
6000
|
-
|
|
6001
|
-
|
|
6002
|
-
|
|
6003
|
-
|
|
6004
|
-
|
|
6005
|
-
|
|
6006
|
-
|
|
6007
|
-
|
|
6008
|
-
|
|
6009
|
-
|
|
6010
|
-
|
|
6011
|
-
|
|
6012
|
-
|
|
6013
|
-
|
|
6014
|
-
|
|
6015
|
-
|
|
6016
|
-
|
|
6017
|
-
|
|
6018
|
-
|
|
6019
|
-
|
|
6020
|
-
|
|
6021
|
-
|
|
6022
|
-
|
|
6023
|
-
|
|
6024
|
-
|
|
6025
|
-
|
|
6026
|
-
|
|
6027
|
-
|
|
6221
|
+
**Examples of how to use the PATCH endpoint.**
|
|
6222
|
+
|
|
6223
|
+
The following fields may be updated in a PATCH operation:
|
|
6224
|
+
|
|
6225
|
+
- name
|
|
6226
|
+
- status
|
|
6227
|
+
- sink
|
|
6228
|
+
|
|
6229
|
+
Note: For log streams of type `eventbridge` and `eventgrid`, updating the `sink` is not permitted.
|
|
6230
|
+
|
|
6231
|
+
**Update the status of a log stream**
|
|
6232
|
+
|
|
6233
|
+
```json
|
|
6234
|
+
{
|
|
6235
|
+
"status": "active|paused"
|
|
6236
|
+
}
|
|
6237
|
+
```
|
|
6238
|
+
|
|
6239
|
+
**Update the name of a log stream**
|
|
6240
|
+
|
|
6241
|
+
```json
|
|
6242
|
+
{
|
|
6243
|
+
"name": "string"
|
|
6244
|
+
}
|
|
6245
|
+
```
|
|
6246
|
+
|
|
6247
|
+
**Update the sink properties of a stream of type `http`**
|
|
6248
|
+
|
|
6249
|
+
```json
|
|
6250
|
+
{
|
|
6251
|
+
"sink": {
|
|
6252
|
+
"httpEndpoint": "string",
|
|
6253
|
+
"httpContentType": "string",
|
|
6254
|
+
"httpContentFormat": "JSONARRAY|JSONLINES",
|
|
6255
|
+
"httpAuthorization": "string"
|
|
6256
|
+
}
|
|
6257
|
+
}
|
|
6258
|
+
```
|
|
6259
|
+
|
|
6260
|
+
**Update the sink properties of a stream of type `datadog`**
|
|
6261
|
+
|
|
6262
|
+
```json
|
|
6263
|
+
{
|
|
6264
|
+
"sink": {
|
|
6265
|
+
"datadogRegion": "string",
|
|
6266
|
+
"datadogApiKey": "string"
|
|
6267
|
+
}
|
|
6268
|
+
}
|
|
6269
|
+
```
|
|
6270
|
+
|
|
6271
|
+
**Update the sink properties of a stream of type `splunk`**
|
|
6272
|
+
|
|
6273
|
+
```json
|
|
6274
|
+
{
|
|
6275
|
+
"sink": {
|
|
6276
|
+
"splunkDomain": "string",
|
|
6277
|
+
"splunkToken": "string",
|
|
6278
|
+
"splunkPort": "string",
|
|
6279
|
+
"splunkSecure": "boolean"
|
|
6280
|
+
}
|
|
6281
|
+
}
|
|
6282
|
+
```
|
|
6283
|
+
|
|
6284
|
+
**Update the sink properties of a stream of type `sumo`**
|
|
6285
|
+
|
|
6286
|
+
```json
|
|
6287
|
+
{
|
|
6288
|
+
"sink": {
|
|
6289
|
+
"sumoSourceAddress": "string"
|
|
6290
|
+
}
|
|
6291
|
+
}
|
|
6292
|
+
```
|
|
6293
|
+
|
|
6028
6294
|
</dd>
|
|
6029
6295
|
</dl>
|
|
6030
6296
|
</dd>
|
|
@@ -7339,6 +7605,69 @@ const response = page.response;
|
|
|
7339
7605
|
</dl>
|
|
7340
7606
|
</details>
|
|
7341
7607
|
|
|
7608
|
+
<details><summary><code>client.refreshTokens.<a href="/src/management/api/resources/refreshTokens/client/Client.ts">revoke</a>({ ...params }) -> void</code></summary>
|
|
7609
|
+
<dl>
|
|
7610
|
+
<dd>
|
|
7611
|
+
|
|
7612
|
+
#### 📝 Description
|
|
7613
|
+
|
|
7614
|
+
<dl>
|
|
7615
|
+
<dd>
|
|
7616
|
+
|
|
7617
|
+
<dl>
|
|
7618
|
+
<dd>
|
|
7619
|
+
|
|
7620
|
+
Revoke refresh tokens in bulk by ID list, user, user+client, or client.
|
|
7621
|
+
|
|
7622
|
+
</dd>
|
|
7623
|
+
</dl>
|
|
7624
|
+
</dd>
|
|
7625
|
+
</dl>
|
|
7626
|
+
|
|
7627
|
+
#### 🔌 Usage
|
|
7628
|
+
|
|
7629
|
+
<dl>
|
|
7630
|
+
<dd>
|
|
7631
|
+
|
|
7632
|
+
<dl>
|
|
7633
|
+
<dd>
|
|
7634
|
+
|
|
7635
|
+
```typescript
|
|
7636
|
+
await client.refreshTokens.revoke();
|
|
7637
|
+
```
|
|
7638
|
+
|
|
7639
|
+
</dd>
|
|
7640
|
+
</dl>
|
|
7641
|
+
</dd>
|
|
7642
|
+
</dl>
|
|
7643
|
+
|
|
7644
|
+
#### ⚙️ Parameters
|
|
7645
|
+
|
|
7646
|
+
<dl>
|
|
7647
|
+
<dd>
|
|
7648
|
+
|
|
7649
|
+
<dl>
|
|
7650
|
+
<dd>
|
|
7651
|
+
|
|
7652
|
+
**request:** `Management.RevokeRefreshTokensRequestContent`
|
|
7653
|
+
|
|
7654
|
+
</dd>
|
|
7655
|
+
</dl>
|
|
7656
|
+
|
|
7657
|
+
<dl>
|
|
7658
|
+
<dd>
|
|
7659
|
+
|
|
7660
|
+
**requestOptions:** `RefreshTokensClient.RequestOptions`
|
|
7661
|
+
|
|
7662
|
+
</dd>
|
|
7663
|
+
</dl>
|
|
7664
|
+
</dd>
|
|
7665
|
+
</dl>
|
|
7666
|
+
|
|
7667
|
+
</dd>
|
|
7668
|
+
</dl>
|
|
7669
|
+
</details>
|
|
7670
|
+
|
|
7342
7671
|
<details><summary><code>client.refreshTokens.<a href="/src/management/api/resources/refreshTokens/client/Client.ts">get</a>(id) -> Management.GetRefreshTokenResponseContent</code></summary>
|
|
7343
7672
|
<dl>
|
|
7344
7673
|
<dd>
|
|
@@ -7567,6 +7896,7 @@ Retrieve details of all APIs associated with your tenant.
|
|
|
7567
7896
|
|
|
7568
7897
|
```typescript
|
|
7569
7898
|
const pageableResponse = await client.resourceServers.list({
|
|
7899
|
+
identifiers: ["identifiers"],
|
|
7570
7900
|
page: 1,
|
|
7571
7901
|
per_page: 1,
|
|
7572
7902
|
include_totals: true,
|
|
@@ -7578,6 +7908,7 @@ for await (const item of pageableResponse) {
|
|
|
7578
7908
|
|
|
7579
7909
|
// Or you can manually iterate page-by-page
|
|
7580
7910
|
let page = await client.resourceServers.list({
|
|
7911
|
+
identifiers: ["identifiers"],
|
|
7581
7912
|
page: 1,
|
|
7582
7913
|
per_page: 1,
|
|
7583
7914
|
include_totals: true,
|
|
@@ -10258,7 +10589,7 @@ const response = page.response;
|
|
|
10258
10589
|
<dl>
|
|
10259
10590
|
<dd>
|
|
10260
10591
|
|
|
10261
|
-
|
|
10592
|
+
Create a User Attribute Profile
|
|
10262
10593
|
|
|
10263
10594
|
</dd>
|
|
10264
10595
|
</dl>
|
|
@@ -15453,6 +15784,7 @@ Retrieve all connections that are enabled for the specified <a href="https://www
|
|
|
15453
15784
|
|
|
15454
15785
|
```typescript
|
|
15455
15786
|
const pageableResponse = await client.clients.connections.get("id", {
|
|
15787
|
+
strategy: ["ad"],
|
|
15456
15788
|
from: "from",
|
|
15457
15789
|
take: 1,
|
|
15458
15790
|
fields: "fields",
|
|
@@ -15464,6 +15796,7 @@ for await (const item of pageableResponse) {
|
|
|
15464
15796
|
|
|
15465
15797
|
// Or you can manually iterate page-by-page
|
|
15466
15798
|
let page = await client.clients.connections.get("id", {
|
|
15799
|
+
strategy: ["ad"],
|
|
15467
15800
|
from: "from",
|
|
15468
15801
|
take: 1,
|
|
15469
15802
|
fields: "fields",
|
|
@@ -17880,7 +18213,9 @@ const response = page.response;
|
|
|
17880
18213
|
<dd>
|
|
17881
18214
|
|
|
17882
18215
|
```typescript
|
|
17883
|
-
await client.flows.executions.get("flow_id", "execution_id"
|
|
18216
|
+
await client.flows.executions.get("flow_id", "execution_id", {
|
|
18217
|
+
hydrate: ["debug"],
|
|
18218
|
+
});
|
|
17884
18219
|
```
|
|
17885
18220
|
|
|
17886
18221
|
</dd>
|
|
@@ -22020,6 +22355,7 @@ await client.keys.signing.revoke("kid");
|
|
|
22020
22355
|
const pageableResponse = await client.organizations.clientGrants.list("id", {
|
|
22021
22356
|
audience: "audience",
|
|
22022
22357
|
client_id: "client_id",
|
|
22358
|
+
grant_ids: ["grant_ids"],
|
|
22023
22359
|
page: 1,
|
|
22024
22360
|
per_page: 1,
|
|
22025
22361
|
include_totals: true,
|
|
@@ -22032,6 +22368,7 @@ for await (const item of pageableResponse) {
|
|
|
22032
22368
|
let page = await client.organizations.clientGrants.list("id", {
|
|
22033
22369
|
audience: "audience",
|
|
22034
22370
|
client_id: "client_id",
|
|
22371
|
+
grant_ids: ["grant_ids"],
|
|
22035
22372
|
page: 1,
|
|
22036
22373
|
per_page: 1,
|
|
22037
22374
|
include_totals: true,
|
|
@@ -25481,7 +25818,7 @@ await client.roles.users.assign("id", {
|
|
|
25481
25818
|
<dl>
|
|
25482
25819
|
<dd>
|
|
25483
25820
|
|
|
25484
|
-
Retrieves text customizations for a given self-service profile, language and Self
|
|
25821
|
+
Retrieves text customizations for a given self-service profile, language and Self-Service Enterprise Configuration flow page.
|
|
25485
25822
|
|
|
25486
25823
|
</dd>
|
|
25487
25824
|
</dl>
|
|
@@ -25560,7 +25897,7 @@ await client.selfServiceProfiles.customText.list("id", "en", "get-started");
|
|
|
25560
25897
|
<dl>
|
|
25561
25898
|
<dd>
|
|
25562
25899
|
|
|
25563
|
-
Updates text customizations for a given self-service profile, language and Self
|
|
25900
|
+
Updates text customizations for a given self-service profile, language and Self-Service Enterprise Configuration flow page.
|
|
25564
25901
|
|
|
25565
25902
|
</dd>
|
|
25566
25903
|
</dl>
|
|
@@ -25651,7 +25988,7 @@ await client.selfServiceProfiles.customText.set("id", "en", "get-started", {
|
|
|
25651
25988
|
<dl>
|
|
25652
25989
|
<dd>
|
|
25653
25990
|
|
|
25654
|
-
Creates an
|
|
25991
|
+
Creates an access ticket to initiate the Self-Service Enterprise Configuration flow using a self-service profile.
|
|
25655
25992
|
|
|
25656
25993
|
</dd>
|
|
25657
25994
|
</dl>
|
|
@@ -25722,7 +26059,7 @@ await client.selfServiceProfiles.ssoTicket.create("id");
|
|
|
25722
26059
|
<dl>
|
|
25723
26060
|
<dd>
|
|
25724
26061
|
|
|
25725
|
-
Revokes
|
|
26062
|
+
Revokes a Self-Service Enterprise Configuration access ticket and invalidates associated sessions. The ticket will no longer be accepted to initiate a Self-Service Enterprise Configuration session. If any users have already started a session through this ticket, their session will be terminated. Clients should expect a `202 Accepted` response upon successful processing, indicating that the request has been acknowledged and that the revocation is underway but may not be fully completed at the time of response. If the specified ticket does not exist, a `202 Accepted` response is also returned, signaling that no further action is required.
|
|
25726
26063
|
Clients should treat these `202` responses as an acknowledgment that the request has been accepted and is in progress, even if the ticket was not found.
|
|
25727
26064
|
|
|
25728
26065
|
</dd>
|
|
@@ -28264,7 +28601,7 @@ await client.users.sessions.delete("user_id");
|
|
|
28264
28601
|
<dl>
|
|
28265
28602
|
<dd>
|
|
28266
28603
|
|
|
28267
|
-
List
|
|
28604
|
+
List verifiable credential templates.
|
|
28268
28605
|
|
|
28269
28606
|
</dd>
|
|
28270
28607
|
</dl>
|