Application
Table of Contents
Interfaces
- WorkOSException
Classes
- Actions
- ApiException
- Base exception thrown for any HTTP error response from the WorkOS API.
- AuthenticationException
- Base exception thrown for any HTTP error response from the WorkOS API.
- AuthorizationException
- Base exception thrown for any HTTP error response from the WorkOS API.
- BadRequestException
- Base exception thrown for any HTTP error response from the WorkOS API.
- BaseRequestException
- Base exception thrown for any HTTP error response from the WorkOS API.
- ConfigurationException
- ConflictException
- Base exception thrown for any HTTP error response from the WorkOS API.
- ConnectionException
- GenericException
- Class GenericException
- NotFoundException
- Base exception thrown for any HTTP error response from the WorkOS API.
- RateLimitExceededException
- Thrown when the WorkOS API returns HTTP 429 (Too Many Requests).
- ServerException
- Base exception thrown for any HTTP error response from the WorkOS API.
- TimeoutException
- UnexpectedValueException
- class UnexpectedValueException.
- UnprocessableEntityException
- Base exception thrown for any HTTP error response from the WorkOS API.
- HttpClient
- DateTimeFormat
- Renders date-time values in the one form the API accepts: ISO 8601 in UTC
with millisecond precision and a literal `Z` suffix.
- PaginatedResponse
- Passwordless
- PKCEHelper
- RequestOptions
- AccessDeniedOAuthErrorBody
- AccessTokenAgentRegistrationCredentialIssuedDataDetail
- AccountSelectionRequiredError
- AccountSelectionRequiredErrorBody
- ActionAuthenticationDenied
- ActionAuthenticationDeniedContext
- Additional context about the event.
- ActionAuthenticationDeniedContextActor
- The actor who performed the action.
- ActionAuthenticationDeniedContextGoogleAnalyticsSession
- ActionAuthenticationDeniedData
- The event payload.
- ActionDeniedErrorBody
- ActionUserRegistrationDenied
- ActionUserRegistrationDeniedContext
- Additional context about the event.
- ActionUserRegistrationDeniedContextActor
- The actor who performed the action.
- ActionUserRegistrationDeniedContextGoogleAnalyticsSession
- ActionUserRegistrationDeniedData
- The event payload.
- Actor
- The user or API key that performed an action.
- AddRolePermission
- AgentAdminLinkClaimAttemptToExternalUserRequest
- AgentAdminLinkClaimAttemptToExternalUserRequestUser
- The user to attach to the claim attempt, identified by email and external ID.
- AgentAdminValidateCredentialRequest
- The agent credential to validate. Either an `api_key` or an `access_token`, discriminated by `type`.
- AgentBlueprint
- AgentBlueprintCreated
- AgentBlueprintCreatedData
- The event payload.
- AgentBlueprintCreatedDataInvocableAs
- How sessions may be minted from this blueprint.
- AgentBlueprintCreatedDataInvocableBy
- Who may mint sessions from this blueprint.
- AgentBlueprintCreatedDataSessionSetting
- Token and session lifetimes for sessions minted from this blueprint.
- AgentBlueprintDeleted
- AgentBlueprintDeletedData
- The event payload.
- AgentBlueprintInvocableAs
- How sessions may be minted from this blueprint.
- AgentBlueprintInvocableBy
- Who may mint sessions from this blueprint.
- AgentBlueprintsCreateRequest
- Configuration for the new agent blueprint.
- AgentBlueprintsCreateRequestInvocableAs
- How sessions may be minted from this blueprint.
- AgentBlueprintsCreateRequestInvocableBy
- Who may mint sessions from this blueprint.
- AgentBlueprintsCreateRequestSessionSetting
- Token and session lifetimes for sessions minted from this blueprint.
- AgentBlueprintSessionSetting
- Token and session lifetimes for sessions minted from this blueprint.
- AgentBlueprintsTokenMintTokenRequest
- How to mint the agent session, discriminated by `type`. `intent` is optional on every variant.
- AgentBlueprintsTokenValidateTokenRequest
- The agent access token to validate.
- AgentBlueprintsUpdateRequest
- Fields to update on the agent blueprint. Omitted fields are left unchanged; provided lists replace the existing configuration.
- AgentBlueprintsUpdateRequestInvocableAs
- How sessions may be minted from this blueprint. Omitted lists are left unchanged.
- AgentBlueprintsUpdateRequestInvocableBy
- Who may mint sessions from this blueprint. Omitted lists are left unchanged.
- AgentBlueprintsUpdateRequestSessionSetting
- Token and session lifetimes for sessions minted from this blueprint. Omitted fields are left unchanged.
- AgentBlueprintUpdated
- AgentBlueprintUpdatedData
- The event payload.
- AgentBlueprintUpdatedDataInvocableAs
- How sessions may be minted from this blueprint.
- AgentBlueprintUpdatedDataInvocableBy
- Who may mint sessions from this blueprint.
- AgentBlueprintUpdatedDataSessionSetting
- Token and session lifetimes for sessions minted from this blueprint.
- AgentCredentialValidation
- AgentInstance
- AgentInstanceCreated
- AgentInstanceCreatedData
- The event payload.
- AgentInstanceDeleted
- AgentInstanceDeletedData
- The event payload.
- AgentInstanceSession
- AgentInstanceSessionCreated
- AgentInstanceSessionCreatedData
- The event payload.
- AgentInstanceSessionRevoked
- AgentInstanceSessionRevokedData
- The event payload.
- AgentRegistration
- AgentRegistrationAgentIdentity
- The agent identity associated with this registration.
- AgentRegistrationClaim
- The claim associated with this registration, or `null` if the registration has no claim.
- AgentRegistrationClaimAttemptCreated
- AgentRegistrationClaimAttemptCreatedData
- The event payload.
- AgentRegistrationClaimClaimCompletion
- The completion record for the claim, or `null` if the claim has not been completed.
- AgentRegistrationClaimCompleted
- AgentRegistrationClaimCompletedData
- The event payload.
- AgentRegistrationClaimCompletedDataClaimedBy
- The user who completed the claim.
- AgentRegistrationCreated
- AgentRegistrationCreatedData
- The event payload.
- AgentRegistrationCreatedDataAgentIdentity
- The agent identity for this registration.
- AgentRegistrationCredentialIssued
- AgentRegistrationCredentialIssuedData
- The event payload.
- AgentRegistrationCredentialIssuedDataDetail
- AgentRegistrationDeleted
- AgentRegistrationDeletedData
- The event payload.
- AgentRegistrationExpired
- AgentRegistrationExpiredData
- The event payload.
- AgentRegistrationOrganizationSwitched
- AgentRegistrationOrganizationSwitchedData
- The event payload.
- AgentRegistrationRefreshed
- AgentRegistrationRefreshedData
- The event payload.
- AgentRegistrationRevoked
- AgentRegistrationRevokedData
- The event payload.
- AgentToken
- AgentTokenValidation
- AlreadyClaimedErrorBody
- ApiKey
- ApiKeyCreated
- ApiKeyCreatedContext
- Additional context about the event.
- ApiKeyCreatedContextActor
- The actor who performed the action.
- ApiKeyCreatedContextGoogleAnalyticsSession
- ApiKeyCreatedData
- The event payload.
- ApiKeyCreatedDataOwner
- ApiKeyDataIntegrationVendedCredential
- ApiKeyInstallation
- ApiKeyOwner
- ApiKeyRevoked
- ApiKeyRevokedContext
- Additional context about the event.
- ApiKeyRevokedContextActor
- The actor who performed the action.
- ApiKeyRevokedContextGoogleAnalyticsSession
- ApiKeyRevokedData
- The event payload.
- ApiKeyRevokedDataOwner
- ApiKeyUpdated
- ApiKeyUpdatedData
- The event payload.
- ApiKeyUpdatedDataOwner
- ApiKeyUpdatedDataPreviousAttribute
- Previous API key attributes before the update.
- ApiKeyValidationResponse
- ApplicationConsentRequiredErrorBody
- ApplicationCredentialsListItem
- AssignRole
- AuditLogAction
- AuditLogConfiguration
- AuditLogConfigurationLogStream
- The Audit Log Stream currently configured for the organization, if any.
- AuditLogEvent
- AuditLogEventActor
- AuditLogEventContext
- AuditLogEventCreateResponse
- AuditLogEventIngestion
- AuditLogEventTarget
- AuditLogExport
- AuditLogExportCreation
- AuditLogSchema
- AuditLogSchemaActor
- The metadata schema for the actor.
- AuditLogSchemaActorInput
- AuditLogSchemaInput
- AuditLogSchemaTarget
- AuditLogSchemaTargetInput
- AuditLogsRetention
- AuthenticateResponse
- AuthenticateResponseImpersonator
- Information about the impersonator if this session was created via impersonation.
- AuthenticateResponseOAuthToken
- The OAuth tokens from the identity provider, if applicable.
- AuthenticationChallenge
- AuthenticationChallengesVerifyRequest
- AuthenticationChallengeVerifyResponse
- AuthenticationEmailVerificationFailed
- AuthenticationEmailVerificationFailedContext
- Additional context about the event.
- AuthenticationEmailVerificationFailedContextActor
- The actor who performed the action.
- AuthenticationEmailVerificationFailedContextGoogleAnalyticsSession
- AuthenticationEmailVerificationFailedData
- The event payload.
- AuthenticationEmailVerificationFailedDataError
- Details about the authentication error.
- AuthenticationEmailVerificationSucceeded
- AuthenticationEmailVerificationSucceededContext
- Additional context about the event.
- AuthenticationEmailVerificationSucceededContextActor
- The actor who performed the action.
- AuthenticationEmailVerificationSucceededContextGoogleAnalyticsSession
- AuthenticationEmailVerificationSucceededData
- The event payload.
- AuthenticationFactor
- AuthenticationFactorEnrolled
- AuthenticationFactorEnrolledSms
- SMS-based authentication factor details.
- AuthenticationFactorEnrolledTotp
- TOTP-based authentication factor details. Includes enrollment secrets only available at creation time.
- AuthenticationFactorsCreateRequest
- AuthenticationFactorSms
- SMS-based authentication factor details.
- AuthenticationFactorTotp
- TOTP-based authentication factor details.
- AuthenticationMagicAuthFailed
- AuthenticationMagicAuthFailedContext
- Additional context about the event.
- AuthenticationMagicAuthFailedContextActor
- The actor who performed the action.
- AuthenticationMagicAuthFailedContextGoogleAnalyticsSession
- AuthenticationMagicAuthFailedData
- The event payload.
- AuthenticationMagicAuthFailedDataError
- Details about the authentication error.
- AuthenticationMagicAuthSucceeded
- AuthenticationMagicAuthSucceededContext
- Additional context about the event.
- AuthenticationMagicAuthSucceededContextActor
- The actor who performed the action.
- AuthenticationMagicAuthSucceededContextGoogleAnalyticsSession
- AuthenticationMagicAuthSucceededData
- The event payload.
- AuthenticationMethodNotAllowedErrorBody
- AuthenticationMethodNotAllowedOAuthErrorBody
- AuthenticationMFAFailed
- AuthenticationMFAFailedContext
- Additional context about the event.
- AuthenticationMFAFailedContextActor
- The actor who performed the action.
- AuthenticationMFAFailedContextGoogleAnalyticsSession
- AuthenticationMFAFailedData
- The event payload.
- AuthenticationMFAFailedDataError
- Details about the authentication error.
- AuthenticationMFASucceeded
- AuthenticationMFASucceededContext
- Additional context about the event.
- AuthenticationMFASucceededContextActor
- The actor who performed the action.
- AuthenticationMFASucceededContextGoogleAnalyticsSession
- AuthenticationMFASucceededData
- The event payload.
- AuthenticationOAuthFailed
- AuthenticationOAuthFailedContext
- Additional context about the event.
- AuthenticationOAuthFailedContextActor
- The actor who performed the action.
- AuthenticationOAuthFailedContextGoogleAnalyticsSession
- AuthenticationOAuthFailedData
- The event payload.
- AuthenticationOAuthFailedDataError
- Details about the authentication error.
- AuthenticationOAuthSucceeded
- AuthenticationOAuthSucceededContext
- Additional context about the event.
- AuthenticationOAuthSucceededContextActor
- The actor who performed the action.
- AuthenticationOAuthSucceededContextGoogleAnalyticsSession
- AuthenticationOAuthSucceededData
- The event payload.
- AuthenticationPasskeyFailed
- AuthenticationPasskeyFailedContext
- Additional context about the event.
- AuthenticationPasskeyFailedContextActor
- The actor who performed the action.
- AuthenticationPasskeyFailedContextGoogleAnalyticsSession
- AuthenticationPasskeyFailedData
- The event payload.
- AuthenticationPasskeyFailedDataError
- Details about the authentication error.
- AuthenticationPasskeySucceeded
- AuthenticationPasskeySucceededContext
- Additional context about the event.
- AuthenticationPasskeySucceededContextActor
- The actor who performed the action.
- AuthenticationPasskeySucceededContextGoogleAnalyticsSession
- AuthenticationPasskeySucceededData
- The event payload.
- AuthenticationPasswordFailed
- AuthenticationPasswordFailedContext
- Additional context about the event.
- AuthenticationPasswordFailedContextActor
- The actor who performed the action.
- AuthenticationPasswordFailedContextGoogleAnalyticsSession
- AuthenticationPasswordFailedData
- The event payload.
- AuthenticationPasswordFailedDataError
- Details about the authentication error.
- AuthenticationPasswordSucceeded
- AuthenticationPasswordSucceededContext
- Additional context about the event.
- AuthenticationPasswordSucceededContextActor
- The actor who performed the action.
- AuthenticationPasswordSucceededContextGoogleAnalyticsSession
- AuthenticationPasswordSucceededData
- The event payload.
- AuthenticationRadarRiskDetected
- AuthenticationRadarRiskDetectedContext
- Additional context about the event.
- AuthenticationRadarRiskDetectedContextActor
- The actor who performed the action.
- AuthenticationRadarRiskDetectedContextGoogleAnalyticsSession
- AuthenticationRadarRiskDetectedData
- The event payload.
- AuthenticationReauthenticationSucceeded
- AuthenticationReauthenticationSucceededData
- The event payload.
- AuthenticationSSOFailed
- AuthenticationSSOFailedContext
- Additional context about the event.
- AuthenticationSSOFailedContextActor
- The actor who performed the action.
- AuthenticationSSOFailedContextGoogleAnalyticsSession
- AuthenticationSSOFailedData
- The event payload.
- AuthenticationSSOFailedDataError
- Details about the authentication error.
- AuthenticationSSOFailedDataSSO
- SSO connection details.
- AuthenticationSSOStarted
- AuthenticationSSOStartedContext
- Additional context about the event.
- AuthenticationSSOStartedContextActor
- The actor who performed the action.
- AuthenticationSSOStartedContextGoogleAnalyticsSession
- AuthenticationSSOStartedData
- The event payload.
- AuthenticationSSOStartedDataSSO
- SSO connection details.
- AuthenticationSSOSucceeded
- AuthenticationSSOSucceededContext
- Additional context about the event.
- AuthenticationSSOSucceededContextActor
- The actor who performed the action.
- AuthenticationSSOSucceededContextGoogleAnalyticsSession
- AuthenticationSSOSucceededData
- The event payload.
- AuthenticationSSOSucceededDataSSO
- SSO connection details.
- AuthenticationSSOTimedOut
- AuthenticationSSOTimedOutContext
- Additional context about the event.
- AuthenticationSSOTimedOutContextActor
- The actor who performed the action.
- AuthenticationSSOTimedOutContextGoogleAnalyticsSession
- AuthenticationSSOTimedOutData
- The event payload.
- AuthenticationSSOTimedOutDataError
- Details about the authentication error.
- AuthenticationSSOTimedOutDataSSO
- SSO connection details.
- AuthkitOAuthResource
- AuthMethodMismatchError
- AuthMethodMismatchErrorBody
- AuthorizationCheck
- AuthorizationCodeSessionAuthenticateRequest
- AuthorizationPendingOAuthErrorBody
- AuthorizationPermission
- AuthorizationResource
- AuthorizationUrlNotFoundErrorBody
- AuthorizationUrlRequestErrorBody
- AuthorizedConnectApplicationListData
- ChallengeAuthenticationFactor
- CheckAuthorization
- ClaimViewResponse
- ClaimViewResponseOrganization
- ClientApiToken
- ClientApiTokenResponse
- ClientCredentialsDataIntegrationVendedCredential
- CodeChallengeNotFoundErrorBody
- ConfigureDataIntegrationBody
- ConfirmEmailChange
- ConnectApplication
- ConnectApplicationM2M
- ConnectApplicationOAuth
- ConnectApplicationOAuthRedirectUris
- ConnectApplicationRedirectUri
- ConnectedAccount
- ConnectedAccountInput
- ConnectedAccountLimitReachedErrorBody
- ConnectedAccountWarning
- Connection
- ConnectionActivated
- ConnectionActivatedContext
- Additional context about the event.
- ConnectionActivatedContextActor
- The actor who performed the action.
- ConnectionActivatedContextGoogleAnalyticsSession
- ConnectionActivatedData
- The event payload.
- ConnectionActivatedDataDomain
- ConnectionCouldNotBeVerifiedErrorBody
- ConnectionCreationConflictErrorBody
- ConnectionCreationNotFoundErrorBody
- ConnectionDeactivated
- ConnectionDeactivatedContext
- Additional context about the event.
- ConnectionDeactivatedContextActor
- The actor who performed the action.
- ConnectionDeactivatedContextGoogleAnalyticsSession
- ConnectionDeactivatedData
- The event payload.
- ConnectionDeactivatedDataDomain
- ConnectionDeleted
- ConnectionDeletedContext
- Additional context about the event.
- ConnectionDeletedContextActor
- The actor who performed the action.
- ConnectionDeletedContextGoogleAnalyticsSession
- ConnectionDeletedData
- The event payload.
- ConnectionDomain
- ConnectionFinishErrorBody
- ConnectionSAMLCertificateRenewalRequired
- ConnectionSAMLCertificateRenewalRequiredContext
- Additional context about the event.
- ConnectionSAMLCertificateRenewalRequiredContextActor
- The actor who performed the action.
- ConnectionSAMLCertificateRenewalRequiredContextGoogleAnalyticsSession
- ConnectionSAMLCertificateRenewalRequiredData
- The event payload.
- ConnectionSAMLCertificateRenewalRequiredDataCertificate
- The SAML certificate details.
- ConnectionSAMLCertificateRenewalRequiredDataConnection
- The connection with the expiring certificate.
- ConnectionSAMLCertificateRenewed
- ConnectionSAMLCertificateRenewedContext
- Additional context about the event.
- ConnectionSAMLCertificateRenewedContextActor
- The actor who performed the action.
- ConnectionSAMLCertificateRenewedContextGoogleAnalyticsSession
- ConnectionSAMLCertificateRenewedData
- The event payload.
- ConnectionSAMLCertificateRenewedDataCertificate
- The renewed SAML certificate details.
- ConnectionSAMLCertificateRenewedDataConnection
- The connection with the renewed certificate.
- ConnectionTypeNotUpdatableErrorBody
- CORSOriginResponse
- CreateApplicationSecret
- CreateAuthkitOAuthResource
- CreateAuthorizationPermission
- CreateAuthorizationResource
- CreateConnectedAccount
- CreateConnection
- CreateConnectionAttributeMaps
- CreateConnectionKeyPair
- CreateConnectionOIDCOptions
- CreateConnectionSAMLOptions
- CreateConnectionStandardAttributes
- CreateCORSOrigin
- CreateDataIntegration
- CreateDataKeyRequest
- CreateDataKeyResponse
- CreateGroup
- CreateGroupMembership
- CreateGroupRoleAssignment
- CreateItContact
- CreateM2MApplication
- CreateMagicCodeAndReturn
- CreateOAuthApplication
- CreateObjectRequest
- CreateOrganizationApiKey
- CreateOrganizationConnectedAccount
- CreateOrganizationDomain
- CreateOrganizationRole
- CreatePasswordReset
- CreatePasswordResetToken
- CreateRedirectUri
- CreateRole
- CreateSAMLIdpSigningCertificate
- CreateTeam
- CreateUser
- CreateUserApiKey
- CreateUserInviteOptions
- CreateUserOrganizationMembership
- CreateWaitlistEntry
- CreateWebhookEndpoint
- CustomProviderDefinition
- DailyQuotaExceededErrorBody
- DataIntegration
- DataIntegrationAccessTokenResponse
- DataIntegrationAccessTokenResponseAccessToken
- The [access token](https://workos.com/docs/reference/pipes/access-token) object, present when `active` is `true`.
- DataIntegrationAccessTokenResponseWithAccessToken
- DataIntegrationAccessTokenResponseWithAccessTokenAccessToken
- The [access token](https://workos.com/docs/reference/pipes/access-token) object, present when `active` is `true`.
- DataIntegrationAccessTokenResponseWithError
- DataIntegrationAuthorizeUrlResponse
- DataIntegrationConfigurationListResponse
- DataIntegrationConfigurationResponse
- DataIntegrationCredential
- The integration-level OAuth app credentials. `null` for `api_key` and `client_credentials` integrations, which hold no integration-level credentials (secrets are installed per-tenant).
- DataIntegrationCredentials
- Organization-managed OAuth credential configuration. Present only for integrations whose credentials are supplied by the organization; absent otherwise.
- DataIntegrationCredentialsInput
- DataIntegrationCredentialsResponse
- DataIntegrationCredentialsResponseWithCredential
- DataIntegrationCredentialsResponseWithError
- DataIntegrationCustomProvider
- The OAuth definition when this is a custom provider; `null` for built-in providers.
- DataIntegrationFinishConnectionResponse
- DataIntegrationInstallation
- The tenant installation created when an API key was supplied at creation time; `null` otherwise. Not populated on list/get responses.
- DataIntegrationsCreateApiKeyConnectionRequest
- DataIntegrationsCreateClientCredentialsConnectionRequest
- DataIntegrationsFinishConnectionRequest
- DataIntegrationsGetDataIntegrationAuthorizeUrlRequest
- DataIntegrationsGetUserTokenRequest
- DataIntegrationsListResponse
- DataIntegrationsListResponseData
- DataIntegrationsListResponseDataConnectedAccount
- The user's compatibility [connected account](https://workos.com/docs/reference/pipes/connected-account) for this provider, or `null` when the compatibility slot is empty. This legacy field never selects a standard connection.
- DataIntegrationsListResponseDataConnectedAccountWarning
- DataIntegrationsUpsertApiKeyRequest
- DataIntegrationsUpsertClientCredentialsRequest
- DataIntegrationsVendCredentialsRequest
- DataIntegrationVendedCredential
- DecryptRequest
- DecryptResponse
- DeleteGroupRoleAssignmentsByCriteria
- DeleteObjectResponse
- DeviceAuthorizationResponse
- DeviceCodeSessionAuthenticateRequest
- Directory
- DirectoryGroup
- DirectoryMetadata
- Aggregate counts of directory users and groups synced from the provider.
- DirectoryMetadataUser
- Counts of active and inactive directory users.
- DirectorySyncRateLimitError
- DirectorySyncResponse
- DirectoryUser
- DirectoryUserEmail
- DirectoryUserWithGroups
- DirectoryUserWithGroupsEmail
- DsyncActivated
- DsyncActivatedContext
- Additional context about the event.
- DsyncActivatedContextActor
- The actor who performed the action.
- DsyncActivatedContextGoogleAnalyticsSession
- DsyncActivatedData
- The event payload.
- DsyncActivatedDataDomain
- DsyncDeactivatedContext
- Additional context about the event.
- DsyncDeactivatedContextActor
- The actor who performed the action.
- DsyncDeactivatedContextGoogleAnalyticsSession
- DsyncDeleted
- DsyncDeletedContext
- Additional context about the event.
- DsyncDeletedContextActor
- The actor who performed the action.
- DsyncDeletedContextGoogleAnalyticsSession
- DsyncDeletedData
- The event payload.
- DsyncGroupCreated
- DsyncGroupCreatedContext
- Additional context about the event.
- DsyncGroupCreatedContextActor
- The actor who performed the action.
- DsyncGroupCreatedContextGoogleAnalyticsSession
- DsyncGroupCreatedData
- The event payload.
- DsyncGroupDeleted
- DsyncGroupDeletedContext
- Additional context about the event.
- DsyncGroupDeletedContextActor
- The actor who performed the action.
- DsyncGroupDeletedContextGoogleAnalyticsSession
- DsyncGroupDeletedData
- The event payload.
- DsyncGroupUpdated
- DsyncGroupUpdatedContext
- Additional context about the event.
- DsyncGroupUpdatedContextActor
- The actor who performed the action.
- DsyncGroupUpdatedContextGoogleAnalyticsSession
- DsyncGroupUpdatedData
- The event payload.
- DsyncGroupUserAdded
- DsyncGroupUserAddedContext
- Additional context about the event.
- DsyncGroupUserAddedContextActor
- The actor who performed the action.
- DsyncGroupUserAddedContextGoogleAnalyticsSession
- DsyncGroupUserAddedData
- The event payload.
- DsyncGroupUserAddedDataGroup
- The directory group the user was added to.
- DsyncGroupUserAddedDataUser
- The directory user added to the group.
- DsyncGroupUserAddedDataUserEmail
- DsyncGroupUserAddedDataUserRole
- The primary role assigned to the user.
- DsyncGroupUserRemoved
- DsyncGroupUserRemovedContext
- Additional context about the event.
- DsyncGroupUserRemovedContextActor
- The actor who performed the action.
- DsyncGroupUserRemovedContextGoogleAnalyticsSession
- DsyncGroupUserRemovedData
- The event payload.
- DsyncGroupUserRemovedDataGroup
- The directory group the user was removed from.
- DsyncGroupUserRemovedDataUser
- The directory user removed from the group.
- DsyncGroupUserRemovedDataUserEmail
- DsyncGroupUserRemovedDataUserRole
- The primary role assigned to the user.
- DsyncTokenCreated
- DsyncTokenCreatedData
- The event payload.
- DsyncTokenRevoked
- DsyncTokenRevokedData
- The event payload.
- DsyncUserCreated
- DsyncUserCreatedContext
- Additional context about the event.
- DsyncUserCreatedContextActor
- The actor who performed the action.
- DsyncUserCreatedContextGoogleAnalyticsSession
- DsyncUserCreatedData
- The event payload.
- DsyncUserCreatedDataEmail
- DsyncUserCreatedDataRole
- The primary role assigned to the user.
- DsyncUserDeleted
- DsyncUserDeletedContext
- Additional context about the event.
- DsyncUserDeletedContextActor
- The actor who performed the action.
- DsyncUserDeletedContextGoogleAnalyticsSession
- DsyncUserDeletedData
- The event payload.
- DsyncUserDeletedDataEmail
- DsyncUserDeletedDataRole
- The primary role assigned to the user.
- DsyncUserUpdated
- DsyncUserUpdatedContext
- Additional context about the event.
- DsyncUserUpdatedContextActor
- The actor who performed the action.
- DsyncUserUpdatedContextGoogleAnalyticsSession
- DsyncUserUpdatedData
- The event payload.
- DsyncUserUpdatedDataEmail
- DsyncUserUpdatedDataRole
- The primary role assigned to the user.
- EmailAlreadyInUseErrorBody
- EmailAlreadyVerifiedErrorBody
- EmailChange
- EmailChangeConfirmation
- EmailChangeConfirmationUser
- The user object.
- EmailChangeNotAllowedErrorBody
- EmailCompletionRequiredErrorBodyWithEmailCompletionToken
- EmailCompletionSessionAuthenticateRequest
- EmailDomainNotDeliverableErrorBody
- EmailNotAvailableErrorBody
- EmailPasswordAuthDisabledErrorBody
- EmailVerification
- EmailVerificationCodeSessionAuthenticateRequest
- EmailVerificationCreated
- EmailVerificationCreatedContext
- Additional context about the event.
- EmailVerificationCreatedContextActor
- The actor who performed the action.
- EmailVerificationCreatedContextGoogleAnalyticsSession
- EmailVerificationCreatedData
- The event payload.
- EmailVerificationRequiredErrorBody
- EnrollUserAuthenticationFactor
- EntityNotFoundErrorBody
- ErrorBody
- ErrorBodyWithCode
- ErrorBodyWithCodeErrors
- ErrorBodyWithCodeFieldError
- ErrorBodyWithCodeFieldErrors
- ErrorBodyWithCodeInstancePathError
- ErrorBodyWithCodeInstancePathErrors
- ErrorBodyWithCodeStatusCode
- ErrorBodyWithConstraintsPropertyError
- ErrorBodyWithConstraintsPropertyErrors
- ErrorBodyWithError
- ErrorBodyWithErrorMessageList
- ErrorBodyWithMessageOrMessageList
- ErrorResponse
- Error response body.
- EventContext
- Additional context about the event.
- EventContextActor
- The actor who performed the action.
- EventContextGoogleAnalyticsSession
- EventListListMetadata
- Pagination cursor for navigating to the next page of results.
- EventSchema
- An event emitted by WorkOS.
- ExpireApiKey
- ExpiredTokenOAuthErrorBody
- ExternalAuthCompleteResponse
- ExternalAuthSessionAlreadyCompletedErrorBody
- ExternalIdAlreadyUsedErrorBody
- ExtraAttributesRequiredOAuthErrorBody
- FeatureFlag
- FeatureFlagOwner
- The owner of the Feature Flag.
- FeatureFlagsFlagCreated
- FeatureFlagsFlagCreatedContext
- Additional context about the event.
- FeatureFlagsFlagCreatedContextActor
- The actor who performed the action.
- FeatureFlagsFlagCreatedData
- The event payload.
- FeatureFlagsFlagCreatedDataOwner
- The owner of the Feature Flag.
- FeatureFlagsFlagDeleted
- FeatureFlagsFlagDeletedContext
- Additional context about the event.
- FeatureFlagsFlagDeletedContextActor
- The actor who performed the action.
- FeatureFlagsFlagDeletedData
- The event payload.
- FeatureFlagsFlagDeletedDataOwner
- The owner of the Feature Flag.
- FeatureFlagsFlagRuleCreated
- FeatureFlagsFlagRuleCreatedContext
- Additional context about the event.
- FeatureFlagsFlagRuleCreatedContextActor
- The actor who performed the action.
- FeatureFlagsFlagRuleDeleted
- FeatureFlagsFlagRuleDeletedContext
- Additional context about the event.
- FeatureFlagsFlagRuleDeletedContextActor
- The actor who performed the action.
- FeatureFlagsFlagRuleUpdated
- FeatureFlagsFlagRuleUpdatedContext
- Additional context about the event.
- FeatureFlagsFlagRuleUpdatedContextActor
- The actor who performed the action.
- FeatureFlagsFlagRuleUpdatedContextPreviousAttribute
- Attributes that changed from their previous values.
- FeatureFlagsFlagRuleUpdatedContextPreviousAttributeData
- The previous data attributes of the flag rule.
- FeatureFlagsFlagTargetCreated
- FeatureFlagsFlagTargetCreatedContext
- Additional context about the event.
- FeatureFlagsFlagTargetCreatedContextActor
- The actor who performed the action.
- FeatureFlagsFlagTargetDeleted
- FeatureFlagsFlagTargetDeletedContext
- Additional context about the event.
- FeatureFlagsFlagTargetDeletedContextActor
- The actor who performed the action.
- FeatureFlagsFlagUpdated
- FeatureFlagsFlagUpdatedContext
- Additional context about the event.
- FeatureFlagsFlagUpdatedContextActor
- The actor who performed the action.
- FeatureFlagsFlagUpdatedContextPreviousAttribute
- Attributes that changed from their previous values.
- FeatureFlagsFlagUpdatedContextPreviousAttributeData
- The previous data attributes of the flag.
- FeatureFlagsFlagUpdatedContextPreviousAttributeDataOwner
- The previous owner of the flag, or `null` if it had none.
- FeatureFlagsFlagUpdatedData
- The event payload.
- FeatureFlagsFlagUpdatedDataOwner
- The owner of the Feature Flag.
- Flag
- FlagCreated
- FlagCreatedContext
- Additional context about the event.
- FlagCreatedContextActor
- The actor who performed the action.
- FlagCreatedData
- The event payload.
- FlagCreatedDataOwner
- The owner of the Feature Flag.
- FlagDeleted
- FlagDeletedContext
- Additional context about the event.
- FlagDeletedContextActor
- The actor who performed the action.
- FlagDeletedData
- The event payload.
- FlagDeletedDataOwner
- The owner of the Feature Flag.
- FlagOwner
- The owner of the Feature Flag.
- FlagRule
- FlagRuleUpdated
- FlagRuleUpdatedContext
- Additional context about the event.
- FlagRuleUpdatedContextActor
- The actor who performed the action.
- FlagRuleUpdatedContextConfiguredTarget
- The configured targets for the flag rule.
- FlagRuleUpdatedContextConfiguredTargetOrganization
- FlagRuleUpdatedContextConfiguredTargetUser
- FlagRuleUpdatedContextPreviousAttribute
- Attributes that changed from their previous values.
- FlagRuleUpdatedContextPreviousAttributeContext
- The previous context attributes of the flag rule.
- FlagRuleUpdatedContextPreviousAttributeContextConfiguredTarget
- The previous configured targets for the flag rule.
- FlagRuleUpdatedContextPreviousAttributeContextConfiguredTargetOrganization
- FlagRuleUpdatedContextPreviousAttributeContextConfiguredTargetUser
- FlagRuleUpdatedContextPreviousAttributeData
- The previous data attributes of the flag.
- FlagRuleUpdatedData
- The event payload.
- FlagRuleUpdatedDataOwner
- The owner of the Feature Flag.
- FlagTarget
- FlagTargetWithRuleId
- FlagTargetWithValueType
- FlagUpdated
- FlagUpdatedContext
- Additional context about the event.
- FlagUpdatedContextActor
- The actor who performed the action.
- FlagUpdatedContextPreviousAttribute
- Attributes that changed from their previous values.
- FlagUpdatedContextPreviousAttributeData
- The previous data attributes of the flag.
- FlagUpdatedContextPreviousAttributeDataOwner
- The previous owner of the flag, or `null` if it had none.
- FlagUpdatedData
- The event payload.
- FlagUpdatedDataOwner
- The owner of the Feature Flag.
- GenerateLink
- Group
- GroupCreated
- GroupDeleted
- GroupMemberAdded
- GroupMemberAddedData
- The event payload.
- GroupMemberRemoved
- GroupMemberRemovedData
- The event payload.
- GroupRoleAssignment
- GroupRoleAssignmentList
- GroupRoleAssignmentResource
- The resource the role is assigned on.
- GroupUpdated
- IdpMetadataFetchFailedErrorBody
- InvalidClientOAuthErrorBody
- InvalidConnectionOAuthErrorBody
- InvalidCredentialsErrorBody
- InvalidEmailErrorBody
- InvalidGrantOAuthErrorBody
- InvalidIdpSSOUrlErrorBody
- InvalidLinkAuthorizationCodeOAuthErrorBody
- InvalidLocaleErrorBody
- InvalidMetadataErrorBody
- InvalidOneTimeCodeErrorBody
- InvalidOrganizationIdErrorBody
- InvalidPasswordHashErrorBody
- InvalidPendingAuthenticationTokenErrorBody
- InvalidProfileOAuthErrorBody
- InvalidRefreshTokenErrorBody
- InvalidRequestOAuthErrorBody
- InvalidRequestParametersErrorBody
- InvalidRequestParametersErrorBodyWithErrors
- InvalidRoleErrorBody
- InvalidUrlErrorBody
- Invitation
- InvitationAccepted
- InvitationAcceptedContext
- Additional context about the event.
- InvitationAcceptedContextActor
- The actor who performed the action.
- InvitationAcceptedContextGoogleAnalyticsSession
- InvitationAcceptedData
- The event payload.
- InvitationCannotBeUsedForEmailOAuthErrorBody
- InvitationCreated
- InvitationCreatedContext
- Additional context about the event.
- InvitationCreatedContextActor
- The actor who performed the action.
- InvitationCreatedContextGoogleAnalyticsSession
- InvitationCreatedData
- The event payload.
- InvitationInvalidOAuthErrorBody
- InvitationResent
- InvitationResentContext
- Additional context about the event.
- InvitationResentContextActor
- The actor who performed the action.
- InvitationResentContextGoogleAnalyticsSession
- InvitationResentData
- The event payload.
- InvitationRevoked
- InvitationRevokedContext
- Additional context about the event.
- InvitationRevokedContextActor
- The actor who performed the action.
- InvitationRevokedContextGoogleAnalyticsSession
- InvitationRevokedData
- The event payload.
- InviteItContact
- ItContact
- ItContactList
- ItContactListListMetadata
- Pagination cursors for navigating between pages of results.
- JwksResponse
- JwksResponseKeys
- JWTTemplateResponse
- ListData
- ListMetadata
- Cursor-based pagination metadata.
- ListModel
- MagicAuth
- MagicAuthCodeSessionAuthenticateRequest
- MagicAuthCreated
- MagicAuthCreatedContext
- Additional context about the event.
- MagicAuthCreatedContextActor
- The actor who performed the action.
- MagicAuthCreatedContextGoogleAnalyticsSession
- MagicAuthCreatedData
- The event payload.
- MagicAuthSendMagicAuthCodeAndReturnResponse
- MFAChallengeErrorBody
- MFAEnrollmentErrorBody
- MFAEnrollmentOAuthErrorBody
- MFATotpSessionAuthenticateRequest
- MultipleRolesNotEnabledErrorBody
- MustUseSSOForSelectedOrganizationMessageErrorBody
- NewConnectApplicationSecret
- OAuthDataIntegrationVendedCredential
- OAuthErrorBody
- ObjectMetadata
- Metadata for a stored encrypted object.
- ObjectSummary
- Summary of an encrypted object returned in list responses.
- ObjectVersion
- A static snapshot of an encrypted object.
- ObjectWithoutValue
- An encrypted object's metadata (value excluded).
- OneTimeCodeExpiredErrorBody
- OneTimeCodePreviouslyUsedErrorBody
- OneTimeCodeTooManyAttemptsErrorBody
- Organization
- OrganizationApiKey
- OrganizationApiKeyOwner
- The entity that owns the API Key.
- OrganizationApiKeyWithValue
- OrganizationApiKeyWithValueOwner
- The entity that owns the API Key.
- OrganizationAuthenticationMethodsRequiredOAuthErrorBody
- OrganizationAuthorizedConnectApplicationListData
- OrganizationConnectedAccount
- OrganizationConnectedAccountImportErrorBody
- OrganizationCreated
- OrganizationCreatedContext
- Additional context about the event.
- OrganizationCreatedContextActor
- The actor who performed the action.
- OrganizationCreatedContextGoogleAnalyticsSession
- OrganizationCreatedData
- The event payload.
- OrganizationCreatedDataDomain
- OrganizationDeleted
- OrganizationDeletedContext
- Additional context about the event.
- OrganizationDeletedContextActor
- The actor who performed the action.
- OrganizationDeletedContextGoogleAnalyticsSession
- OrganizationDeletedData
- The event payload.
- OrganizationDeletedDataDomain
- OrganizationDomain
- OrganizationDomainCreated
- OrganizationDomainCreatedContext
- Additional context about the event.
- OrganizationDomainCreatedContextActor
- The actor who performed the action.
- OrganizationDomainCreatedContextGoogleAnalyticsSession
- OrganizationDomainCreatedData
- The event payload.
- OrganizationDomainData
- OrganizationDomainDeleted
- OrganizationDomainDeletedContext
- Additional context about the event.
- OrganizationDomainDeletedContextActor
- The actor who performed the action.
- OrganizationDomainDeletedContextGoogleAnalyticsSession
- OrganizationDomainDeletedData
- The event payload.
- OrganizationDomainUpdated
- OrganizationDomainUpdatedContext
- Additional context about the event.
- OrganizationDomainUpdatedContextActor
- The actor who performed the action.
- OrganizationDomainUpdatedContextGoogleAnalyticsSession
- OrganizationDomainUpdatedData
- The event payload.
- OrganizationDomainVerificationFailed
- OrganizationDomainVerificationFailedContext
- Additional context about the event.
- OrganizationDomainVerificationFailedContextActor
- The actor who performed the action.
- OrganizationDomainVerificationFailedContextGoogleAnalyticsSession
- OrganizationDomainVerificationFailedData
- The event payload.
- OrganizationDomainVerificationFailedDataOrganizationDomain
- The organization domain that failed verification.
- OrganizationDomainVerified
- OrganizationDomainVerifiedContext
- Additional context about the event.
- OrganizationDomainVerifiedContextActor
- The actor who performed the action.
- OrganizationDomainVerifiedContextGoogleAnalyticsSession
- OrganizationDomainVerifiedData
- The event payload.
- OrganizationInput
- OrganizationMembership
- OrganizationMembershipCreated
- OrganizationMembershipCreatedContext
- Additional context about the event.
- OrganizationMembershipCreatedContextActor
- The actor who performed the action.
- OrganizationMembershipCreatedContextGoogleAnalyticsSession
- OrganizationMembershipCreatedData
- The event payload.
- OrganizationMembershipDeleted
- OrganizationMembershipDeletedContext
- Additional context about the event.
- OrganizationMembershipDeletedContextActor
- The actor who performed the action.
- OrganizationMembershipDeletedContextGoogleAnalyticsSession
- OrganizationMembershipDeletedData
- The event payload.
- OrganizationMembershipNotFoundOAuthErrorBody
- OrganizationMembershipUpdated
- OrganizationMembershipUpdatedContext
- Additional context about the event.
- OrganizationMembershipUpdatedContextActor
- The actor who performed the action.
- OrganizationMembershipUpdatedContextGoogleAnalyticsSession
- OrganizationMembershipUpdatedData
- The event payload.
- OrganizationNotFoundOAuthErrorBody
- OrganizationRoleCreated
- OrganizationRoleCreatedContext
- Additional context about the event.
- OrganizationRoleCreatedContextActor
- The actor who performed the action.
- OrganizationRoleCreatedContextGoogleAnalyticsSession
- OrganizationRoleCreatedData
- The event payload.
- OrganizationRoleDeleted
- OrganizationRoleDeletedContext
- Additional context about the event.
- OrganizationRoleDeletedContextActor
- The actor who performed the action.
- OrganizationRoleDeletedContextGoogleAnalyticsSession
- OrganizationRoleDeletedData
- The event payload.
- OrganizationRoleUpdated
- OrganizationRoleUpdatedContext
- Additional context about the event.
- OrganizationRoleUpdatedContextActor
- The actor who performed the action.
- OrganizationRoleUpdatedContextGoogleAnalyticsSession
- OrganizationRoleUpdatedData
- The event payload.
- OrganizationSelectionRequiredErrorBody
- OrganizationSelectionRequiredErrorBodyWithOrganization
- OrganizationSelectionRequiredErrorBodyWithOrganizations
- OrganizationSelectionSessionAuthenticateRequest
- OrganizationUpdated
- OrganizationUpdatedContext
- Additional context about the event.
- OrganizationUpdatedContextActor
- The actor who performed the action.
- OrganizationUpdatedContextGoogleAnalyticsSession
- OrganizationUpdatedData
- The event payload.
- OrganizationUpdatedDataDomain
- PasskeyProgressiveEnrollmentErrorBody
- PasswordAndPasswordHashProvidedErrorBody
- PasswordAndPasswordHashTypeProvidedErrorBody
- PasswordReset
- PasswordResetCreated
- PasswordResetCreatedContext
- Additional context about the event.
- PasswordResetCreatedContextActor
- The actor who performed the action.
- PasswordResetCreatedContextGoogleAnalyticsSession
- PasswordResetCreatedData
- The event payload.
- PasswordResetSucceeded
- PasswordResetSucceededContext
- Additional context about the event.
- PasswordResetSucceededContextActor
- The actor who performed the action.
- PasswordResetSucceededContextGoogleAnalyticsSession
- PasswordResetSucceededData
- The event payload.
- PasswordSaltPositionRequiresPasswordHashErrorBody
- PasswordSessionAuthenticateRequest
- PasswordStrengthErrorErrorBodyWithErrors
- PatchConnection
- PatchConnectionAttributeMaps
- PatchConnectionOIDCOptions
- PatchConnectionSAMLOptions
- PatchConnectionStandardAttributes
- PatchGroupMemberships
- PatchGroupRoleAssignments
- Permission
- PermissionCreated
- PermissionCreatedContext
- Additional context about the event.
- PermissionCreatedContextActor
- The actor who performed the action.
- PermissionCreatedContextGoogleAnalyticsSession
- PermissionCreatedData
- The event payload.
- PermissionDeleted
- PermissionDeletedContext
- Additional context about the event.
- PermissionDeletedContextActor
- The actor who performed the action.
- PermissionDeletedContextGoogleAnalyticsSession
- PermissionDeletedData
- The event payload.
- PermissionUpdated
- PermissionUpdatedContext
- Additional context about the event.
- PermissionUpdatedContextActor
- The actor who performed the action.
- PermissionUpdatedContextGoogleAnalyticsSession
- PermissionUpdatedData
- The event payload.
- PhoneNumberRequiredErrorBody
- PipeConnectedAccount
- PipesAccountConnectionAddFailed
- PipesAccountConnectionAddFailedData
- The event payload.
- PipesAccountConnectionConnected
- PipesAccountConnectionConnectionFailed
- PipesAccountConnectionConnectionFailedData
- The event payload.
- PipesAccountConnectionDisconnected
- PipesAccountConnectionReauthorizationNeeded
- PipesConnectedAccountConnected
- PipesConnectedAccountConnectionFailed
- PipesConnectedAccountConnectionFailedData
- The event payload.
- PipesConnectedAccountDisconnected
- PipesConnectedAccountReauthorizationNeeded
- PkceNotSupportedOAuthErrorBody
- PolicyDeniedErrorBody
- PortalLinkResponse
- Profile
- RadarChallenge
- RadarChallengeCreated
- RadarChallengeCreatedData
- The event payload.
- RadarChallengeErrorBody
- RadarEmailChallengeCodeSessionAuthenticateRequest
- RadarListEntryAlreadyPresentResponse
- RadarSignUpChallengeErrorBody
- RadarSmsChallengeCodeSessionAuthenticateRequest
- RadarSmsSignInChallengeErrorBody
- RadarStandaloneAssessRequest
- RadarStandaloneDeleteRadarListEntryRequest
- RadarStandaloneResponse
- RadarStandaloneUpdateRadarAttemptRequest
- RadarStandaloneUpdateRadarListRequest
- RateLimitExceededErrorBodyWithRetryAfter
- RedirectUri
- RedirectUriInput
- RefreshTokenSessionAuthenticateRequest
- RekeyRequest
- RemoveRole
- ReplaceGroupRoleAssignmentEntry
- ReplaceGroupRoleAssignments
- ResendUserInviteOptions
- ResetPasswordResponse
- ResourceExportCompleted
- ResourceExportCompletedData
- The event payload.
- ResourceExportCreated
- ResourceExportCreatedData
- The event payload.
- ResourceExportDownloaded
- ResourceExportDownloadedData
- The event payload.
- ResourceExportFailed
- ResourceExportFailedData
- The event payload.
- RevokeLink
- RevokeSession
- Role
- RoleCreated
- RoleCreatedContext
- Additional context about the event.
- RoleCreatedContextActor
- The actor who performed the action.
- RoleCreatedContextGoogleAnalyticsSession
- RoleCreatedData
- The event payload.
- RoleDeleted
- RoleDeletedContext
- Additional context about the event.
- RoleDeletedContextActor
- The actor who performed the action.
- RoleDeletedContextGoogleAnalyticsSession
- RoleDeletedData
- The event payload.
- RoleList
- RoleUpdated
- RoleUpdatedContext
- Additional context about the event.
- RoleUpdatedContextActor
- The actor who performed the action.
- RoleUpdatedContextGoogleAnalyticsSession
- RoleUpdatedData
- The event payload.
- SAMLIdpSigningCertificate
- SAMLIdpSigningCertificateList
- SAMLSpEncryptionCertificate
- SAMLSpEncryptionCertificateList
- SAMLSpSigningCertificate
- SendEmailChange
- SendRadarSmsChallenge
- SendRadarSmsChallengeResponse
- SendVerificationEmail
- SendVerificationEmailResponse
- SessionCreated
- SessionCreatedContext
- Additional context about the event.
- SessionCreatedContextActor
- The actor who performed the action.
- SessionCreatedContextGoogleAnalyticsSession
- SessionCreatedData
- The event payload.
- SessionCreatedDataImpersonator
- Information about the impersonator if this session was created via impersonation.
- SessionRevoked
- SessionRevokedContext
- Additional context about the event.
- SessionRevokedContextActor
- The actor who performed the action.
- SessionRevokedContextGoogleAnalyticsSession
- SessionRevokedData
- The event payload.
- SessionRevokedDataImpersonator
- Information about the impersonator if this session was created via impersonation.
- SetRolePermissions
- SignUpNotAllowedOAuthErrorBody
- SlimRole
- The primary role assigned to the user.
- SlowDownOAuthErrorBody
- SmsChallengeQuotaReachedErrorBody
- SmsChallengeRateLimitedErrorBody
- SSOAuthorizeUrlResponse
- SSODeviceAuthorizationRequest
- SSOLogoutAuthorizeRequest
- SSOLogoutAuthorizeResponse
- SSORequiredOAuthErrorBodyWithConnectionIdsListEmailPendingAuthenticationToken
- SSOTokenResponse
- SSOTokenResponseOAuthToken
- OAuth tokens issued by the identity provider, if available.
- SubResourceScopedRoleNotAllowedErrorBodyWithRoleSlug
- Team
- TokenQuery
- TokenTooBigOAuthErrorBody
- TooManyFailedVerificationAttemptsErrorBodyWithRetryAfter
- TooManyRequestsOAuthErrorBody
- UnauthorizedClientOAuthErrorBody
- UnauthorizedErrorBody
- UpdateAuditLogsRetention
- UpdateAuditLogsRetentionWithRetentionPeriod
- UpdateAuditLogsRetentionWithRetentionPeriodInDays
- UpdateAuthorizationPermission
- UpdateAuthorizationResource
- UpdateCustomProviderDefinition
- UpdateDataIntegration
- UpdateGroup
- UpdateJWTTemplate
- UpdateOAuthApplication
- UpdateObjectRequest
- UpdateOrganization
- UpdateOrganizationRole
- UpdateRole
- UpdateUser
- UpdateUserOrganizationMembership
- UpdateUserOrganizationMembershipWithRoleSlug
- UpdateUserOrganizationMembershipWithRoleSlugs
- UpdateWebhookEndpoint
- User
- The user object.
- UserApiKey
- UserApiKeyCreatedDataOwner
- UserApiKeyOwner
- The entity that owns the API Key.
- UserApiKeyRevokedDataOwner
- UserApiKeyUpdatedDataOwner
- UserApiKeyWithValue
- UserApiKeyWithValueOwner
- The entity that owns the API Key.
- UserAuthenticationFactorEnrollResponse
- UserConnectedAccountImportErrorBody
- UserConsentOption
- UserConsentOptionChoice
- UserConsentOptionsNotSupportedErrorBody
- UserCreated
- UserCreatedContext
- Additional context about the event.
- UserCreatedContextActor
- The actor who performed the action.
- UserCreatedContextGoogleAnalyticsSession
- UserCreatedData
- The event payload.
- UserCreateResponse
- UserCreationErrorErrorBodyWithErrors
- UserDeleted
- UserDeletedContext
- Additional context about the event.
- UserDeletedContextActor
- The actor who performed the action.
- UserDeletedContextGoogleAnalyticsSession
- UserDeletedData
- The event payload.
- UserIdentitiesGetItem
- UserInvite
- UserManagementLoginRequest
- UserMismatchErrorBody
- UserObject
- UserOrganizationMembership
- UserOrganizationMembershipBaseListData
- UserRoleAssignment
- UserRoleAssignmentResource
- The resource the role is assigned on.
- UserRoleAssignmentSource
- The origin of the role assignment.
- UserRoleAssignmentSourceGroup
- The group the role was derived from, or null if direct.
- UserSessionsImpersonator
- Information about the impersonator if this session was created via impersonation.
- UserSessionsListItem
- UserUpdated
- UserUpdatedContext
- Additional context about the event.
- UserUpdatedContextActor
- The actor who performed the action.
- UserUpdatedContextGoogleAnalyticsSession
- UserUpdatedData
- The event payload.
- ValidateApiKey
- VaultByokKeyDeleted
- VaultByokKeyDeletedData
- The event payload.
- VaultByokKeyVerificationCompleted
- VaultByokKeyVerificationCompletedContext
- Additional context about the event.
- VaultByokKeyVerificationCompletedContextActor
- The actor who performed the action.
- VaultByokKeyVerificationCompletedContextGoogleAnalyticsSession
- VaultByokKeyVerificationCompletedData
- The event payload.
- VaultDataCreated
- VaultDataCreatedContext
- Additional context about the event.
- VaultDataCreatedContextActor
- The actor who performed the action.
- VaultDataCreatedContextGoogleAnalyticsSession
- VaultDataCreatedData
- The event payload.
- VaultDataDeleted
- VaultDataDeletedContext
- Additional context about the event.
- VaultDataDeletedContextActor
- The actor who performed the action.
- VaultDataDeletedContextGoogleAnalyticsSession
- VaultDataDeletedData
- The event payload.
- VaultDataRead
- VaultDataReadContext
- Additional context about the event.
- VaultDataReadContextActor
- The actor who performed the action.
- VaultDataReadContextGoogleAnalyticsSession
- VaultDataReadData
- The event payload.
- VaultDataUpdated
- VaultDataUpdatedContext
- Additional context about the event.
- VaultDataUpdatedContextActor
- The actor who performed the action.
- VaultDataUpdatedContextGoogleAnalyticsSession
- VaultDataUpdatedData
- The event payload.
- VaultDekDecrypted
- VaultDekDecryptedContext
- Additional context about the event.
- VaultDekDecryptedContextActor
- The actor who performed the action.
- VaultDekDecryptedContextGoogleAnalyticsSession
- VaultDekDecryptedData
- The event payload.
- VaultDekRead
- VaultDekReadContext
- Additional context about the event.
- VaultDekReadContextActor
- The actor who performed the action.
- VaultDekReadContextGoogleAnalyticsSession
- VaultDekReadData
- The event payload.
- VaultDekRekeyed
- VaultDekRekeyedData
- The event payload.
- VaultKekCreated
- VaultKekCreatedContext
- Additional context about the event.
- VaultKekCreatedContextActor
- The actor who performed the action.
- VaultKekCreatedContextGoogleAnalyticsSession
- VaultKekCreatedData
- The event payload.
- VaultKekDeleted
- VaultKekDeletedData
- The event payload.
- VaultMetadataRead
- VaultMetadataReadContext
- Additional context about the event.
- VaultMetadataReadContextActor
- The actor who performed the action.
- VaultMetadataReadContextGoogleAnalyticsSession
- VaultMetadataReadData
- The event payload.
- VaultNamesListed
- VaultNamesListedContext
- Additional context about the event.
- VaultNamesListedContextActor
- The actor who performed the action.
- VaultNamesListedContextGoogleAnalyticsSession
- VaultNamesListedData
- The event payload.
- VaultObject
- An encrypted object with its decrypted value and metadata.
- VerificationIdRequiredErrorBody
- VerifyEmailAddress
- VerifyEmailResponse
- VersionListResponse
- Waitlist
- WaitlistEntry
- WaitlistListResponse
- WaitlistListResponseListMetadata
- Pagination cursors for navigating between pages of results.
- WaitlistUser
- WaitlistUserApproved
- WaitlistUserCreated
- WaitlistUserDenied
- Webhook
- Representation of a WorkOS webhook event.
- WebhookEndpoint
- WebhookResponse
- Response structure for WorkOS webhook action verdicts.
- WidgetSessionToken
- WidgetSessionTokenResponse
- AdminPortal
- Agents
- ApiKeys
- AuditLogs
- Authorization
- ClientApi
- Connect
- CreateProtocolOptionsOIDC
- CreateProtocolOptionsSAML
- DirectorySync
- Events
- FeatureFlags
- Groups
- MultiFactorAuth
- OrganizationDomains
- OrganizationMembershipService
- Organizations
- ParentByExternalId
- ParentById
- ParentResourceByExternalId
- ParentResourceById
- PasswordHashed
- PasswordPlaintext
- PatchProtocolOptionsOIDC
- PatchProtocolOptionsSAML
- Pipes
- PipesProvider
- PlatformTeams
- Radar
- ResourceTargetByExternalId
- ResourceTargetById
- RetentionPeriod
- RetentionPeriodInDays
- RoleMultiple
- RoleSingle
- SSO
- UserManagement
- Vault
- Webhooks
- Widgets
- SessionManager
- Version
- WebhookVerification
- WorkOS
Traits
- JsonSerializableTrait
Enums
- AgentAdminValidateCredentialRequestType
- AgentBlueprintsTokenMintTokenRequestType
- AgentInstanceType
- AgentRegistrationCreatedDataMethod
- AgentRegistrationKind
- AgentRegistrationStatus
- ApplicationsOrder
- ApplicationsRegistrationTypes
- AuditLogConfigurationLogStreamState
- AuditLogConfigurationLogStreamType
- AuditLogConfigurationState
- AuditLogExportState
- AuditLogsOrder
- AuthenticateResponseAuthenticationMethod
- AuthenticationFactorEnrolledType
- AuthenticationFactorsCreateRequestType
- AuthenticationFactorType
- AuthenticationRadarRiskDetectedDataAction
- AuthorizationAssignment
- AuthorizationOrder
- AuthorizationUrlNotFoundErrorBodyCode
- AuthorizationUrlRequestErrorBodyCode
- ConnectedAccountConnectionRole
- ConnectedAccountState
- ConnectionCreationConflictErrorBodyCode
- ConnectionCreationNotFoundErrorBodyCode
- ConnectionDeletedDataConnectionType
- ConnectionDeletedDataState
- ConnectionFinishErrorBodyCode
- ConnectionSAMLCertificateRenewedDataCertificateCertificateType
- ConnectionsConnectionType
- ConnectionsOrder
- ConnectionState
- ConnectionStatus
- ConnectionType
- CreateUserPasswordHashType
- CreateUserPasswordSaltPosition
- CreateWebhookEndpointEvents
- CustomProviderDefinitionAuthenticateVia
- DataIntegrationAccessTokenResponseError
- DataIntegrationAuthMethods
- DataIntegrationCredentialsCredentialsType
- DataIntegrationCredentialType
- DataIntegrationsGetDataIntegrationAuthorizeUrlRequestConnectionIntent
- DataIntegrationsListResponseDataOwnership
- DataIntegrationState
- DirectoriesOrder
- DirectoryGroupsOrder
- DirectoryState
- DirectoryType
- DirectoryUsersOrder
- DirectoryUserState
- DirectoryUserWithGroupsState
- DsyncDeletedDataState
- DsyncDeletedDataType
- DsyncUserCreatedDataState
- ErrorBodyCode
- EventContextActorSource
- FeatureFlagsOrder
- FlagCreatedContextActorSource
- FlagRuleUpdatedContextAccessType
- GenerateLinkIntent
- InvitationState
- InviteItContactIntents
- ListDataType
- OrganizationConnectedAccountImportErrorBodyCode
- OrganizationDomainDataState
- OrganizationDomainStandAloneState
- OrganizationDomainStandAloneVerificationStrategy
- OrganizationDomainState
- OrganizationDomainVerificationFailedDataReason
- OrganizationDomainVerificationStrategy
- OrganizationMembershipStatus
- OrganizationsApiKeysOrder
- OrganizationsFeatureFlagsOrder
- OrganizationsOrder
- PaginationOrder
- PatchConnectionOIDCOptionsIdTokenSignatureAlgorithm
- PatchConnectionOIDCOptionsTokenAuthenticationMethod
- PermissionsOrder
- PipeConnectedAccountState
- PipesOwnership
- ProfileConnectionType
- RadarListAction
- RadarListType
- RadarStandaloneAssessRequestAction
- RadarStandaloneAssessRequestAuthMethod
- RadarStandaloneResponseBlocklistType
- RadarStandaloneResponseControl
- RadarStandaloneResponseVerdict
- ResendUserInviteOptionsLocale
- ResourceExportFailedDataResourceType
- RoleType
- SendEmailChangeLocale
- SSOGrantType
- SSOProvider
- TeamProductionState
- UpdateAuditLogsRetentionRetentionPeriod
- UpdateUserPasswordHashType
- UpdateWebhookEndpointEvents
- UpdateWebhookEndpointStatus
- UserConnectedAccountImportErrorBodyCode
- UserIdentitiesGetItemProvider
- UserInviteState
- UserManagementAuthenticationProvider
- UserManagementInvitationsOrder
- UserManagementMultiFactorAuthenticationOrder
- UserManagementOrganizationMembershipOrder
- UserManagementOrganizationMembershipStatuses
- UserManagementUsersAuthorizedApplicationsOrder
- UserManagementUsersFeatureFlagsOrder
- UserManagementUsersOrder
- UserOrganizationMembershipBaseListDataStatus
- UserOrganizationMembershipStatus
- UserRoleAssignmentSourceType
- UserSessionsAuthMethod
- UserSessionsStatus
- VaultByokKeyProvider
- VaultDekReadDataActorSource
- VaultOrder
- WaitlistUserState
- WebhookEndpointStatus
- WebhooksOrder
- WidgetSessionTokenScopes