Documentation by YARD 0.9.38
Alphabetic Index
File Listing
README
Namespace Listing A-Z
A
APIConnectionError
(WorkOS)
APIError
(WorkOS)
ActionAuthenticationDenied
(WorkOS)
ActionAuthenticationDeniedData
(WorkOS)
ActionUserRegistrationDenied
(WorkOS)
ActionUserRegistrationDeniedData
(WorkOS)
Actions
(WorkOS)
AddRolePermission
(WorkOS)
AdminPortal
(WorkOS)
AesGcm
(WorkOS::Encryptors)
ApiKey
(WorkOS)
ApiKeyCreated
(WorkOS)
ApiKeyCreatedData
(WorkOS)
ApiKeyCreatedDataOwner
(WorkOS)
ApiKeyRevoked
(WorkOS)
ApiKeyValidationResponse
(WorkOS)
ApiKeyWithValue
(WorkOS)
ApiKeys
(WorkOS)
ApiResponse
(WorkOS::Types)
ApplicationCredentialsListItem
(WorkOS)
ApplicationsOrder
(WorkOS::Types)
AssignRole
(WorkOS)
AuditLogAction
(WorkOS)
AuditLogActionJson
(WorkOS)
AuditLogConfiguration
(WorkOS)
AuditLogConfigurationLogStream
(WorkOS)
AuditLogConfigurationLogStreamState
(WorkOS::Types)
AuditLogConfigurationLogStreamType
(WorkOS::Types)
AuditLogConfigurationState
(WorkOS::Types)
AuditLogEvent
(WorkOS)
AuditLogEventActor
(WorkOS)
AuditLogEventContext
(WorkOS)
AuditLogEventCreateResponse
(WorkOS)
AuditLogEventIngestion
(WorkOS)
AuditLogExport
(WorkOS)
AuditLogExportCreation
(WorkOS)
AuditLogExportJson
(WorkOS)
AuditLogExportJsonState
(WorkOS::Types)
AuditLogExportState
(WorkOS::Types)
AuditLogSchema
(WorkOS)
AuditLogSchemaActor
(WorkOS)
AuditLogSchemaJson
(WorkOS)
AuditLogSchemaJsonTarget
(WorkOS)
AuditLogs
(WorkOS)
AuditLogsRetention
(WorkOS)
AuditLogsRetentionJson
(WorkOS)
AuthError
(WorkOS::SessionManager)
AuthSuccess
(WorkOS::SessionManager)
AuthenticateResponse
(WorkOS)
AuthenticateResponseAuthenticationMethod
(WorkOS::Types)
AuthenticateResponseImpersonator
(WorkOS)
AuthenticateResponseOAuthToken
(WorkOS)
AuthenticationChallenge
(WorkOS)
AuthenticationChallengeVerifyResponse
(WorkOS)
AuthenticationChallengesVerifyRequest
(WorkOS)
AuthenticationEmailVerificationFailed
(WorkOS)
AuthenticationEmailVerificationFailedData
(WorkOS)
AuthenticationEmailVerificationFailedDataError
(WorkOS)
AuthenticationEmailVerificationSucceeded
(WorkOS)
AuthenticationEmailVerificationSucceededData
(WorkOS)
AuthenticationError
(WorkOS)
AuthenticationFactor
(WorkOS)
AuthenticationFactorEnrolled
(WorkOS)
AuthenticationFactorEnrolledSms
(WorkOS)
AuthenticationFactorEnrolledTotp
(WorkOS)
AuthenticationFactorEnrolledType
(WorkOS::Types)
AuthenticationFactorTotp
(WorkOS)
AuthenticationFactorsCreateRequest
(WorkOS)
AuthenticationFactorsCreateRequestType
(WorkOS::Types)
AuthenticationMFAFailed
(WorkOS)
AuthenticationMFAFailedData
(WorkOS)
AuthenticationMFASucceeded
(WorkOS)
AuthenticationMFASucceededData
(WorkOS)
AuthenticationMagicAuthFailed
(WorkOS)
AuthenticationMagicAuthFailedData
(WorkOS)
AuthenticationMagicAuthSucceeded
(WorkOS)
AuthenticationMagicAuthSucceededData
(WorkOS)
AuthenticationOAuthFailed
(WorkOS)
AuthenticationOAuthFailedData
(WorkOS)
AuthenticationOAuthSucceeded
(WorkOS)
AuthenticationOAuthSucceededData
(WorkOS)
AuthenticationPasskeyFailed
(WorkOS)
AuthenticationPasskeyFailedData
(WorkOS)
AuthenticationPasskeySucceeded
(WorkOS)
AuthenticationPasskeySucceededData
(WorkOS)
AuthenticationPasswordFailed
(WorkOS)
AuthenticationPasswordFailedData
(WorkOS)
AuthenticationPasswordSucceeded
(WorkOS)
AuthenticationPasswordSucceededData
(WorkOS)
AuthenticationRadarRiskDetected
(WorkOS)
AuthenticationRadarRiskDetectedData
(WorkOS)
AuthenticationRadarRiskDetectedDataAction
(WorkOS::Types)
AuthenticationSSOFailed
(WorkOS)
AuthenticationSSOFailedData
(WorkOS)
AuthenticationSSOFailedDataSSO
(WorkOS)
AuthenticationSSOStarted
(WorkOS)
AuthenticationSSOStartedData
(WorkOS)
AuthenticationSSOSucceeded
(WorkOS)
AuthenticationSSOSucceededData
(WorkOS)
AuthenticationSSOTimedOut
(WorkOS)
AuthenticationSSOTimedOutData
(WorkOS)
Authorization
(WorkOS)
AuthorizationAssignment
(WorkOS::Types)
AuthorizationCheck
(WorkOS)
AuthorizationCodeSessionAuthenticateRequest
(WorkOS)
AuthorizationPermission
(WorkOS)
AuthorizationResource
(WorkOS)
AuthorizedConnectApplicationListData
(WorkOS)
B
BaseClient
(WorkOS)
BaseModel
(WorkOS::Types)
C
CORSOriginResponse
(WorkOS)
ChallengeAuthenticationFactor
(WorkOS)
CheckAuthorization
(WorkOS)
Client
(WorkOS)
Configuration
(WorkOS)
Connect
(WorkOS)
ConnectApplication
(WorkOS)
ConnectedAccount
(WorkOS)
ConnectedAccountState
(WorkOS::Types)
Connection
(WorkOS)
ConnectionActivated
(WorkOS)
ConnectionActivatedData
(WorkOS)
ConnectionActivatedDataConnectionType
(WorkOS::Types)
ConnectionActivatedDataDomain
(WorkOS)
ConnectionActivatedDataState
(WorkOS::Types)
ConnectionActivatedDataStatus
(WorkOS::Types)
ConnectionDeactivated
(WorkOS)
ConnectionDeactivatedData
(WorkOS)
ConnectionDeleted
(WorkOS)
ConnectionDeletedData
(WorkOS)
ConnectionOption
(WorkOS)
ConnectionSAMLCertificateRenewalRequired
(WorkOS)
ConnectionSAMLCertificateRenewalRequiredData
(WorkOS)
ConnectionSAMLCertificateRenewalRequiredDataCertificate
(WorkOS)
ConnectionSAMLCertificateRenewalRequiredDataCertificateCertificateType
(WorkOS::Types)
ConnectionSAMLCertificateRenewalRequiredDataConnection
(WorkOS)
ConnectionSAMLCertificateRenewed
(WorkOS)
ConnectionSAMLCertificateRenewedData
(WorkOS)
ConnectionSAMLCertificateRenewedDataCertificate
(WorkOS)
ConnectionState
(WorkOS::Types)
ConnectionType
(WorkOS::Types)
ConnectionsConnectionType
(WorkOS::Types)
CreateApplicationSecret
(WorkOS)
CreateAuthorizationPermission
(WorkOS)
CreateAuthorizationResource
(WorkOS)
CreateCORSOrigin
(WorkOS)
CreateM2MApplication
(WorkOS)
CreateMagicCodeAndReturn
(WorkOS)
CreateOAuthApplication
(WorkOS)
CreateOrganizationApiKey
(WorkOS)
CreateOrganizationDomain
(WorkOS)
CreateOrganizationRole
(WorkOS)
CreatePasswordReset
(WorkOS)
CreatePasswordResetToken
(WorkOS)
CreateRedirectUri
(WorkOS)
CreateUser
(WorkOS)
CreateUserInviteOptions
(WorkOS)
CreateUserInviteOptionsLocale
(WorkOS::Types)
CreateUserOrganizationMembership
(WorkOS)
CreateUserPasswordHashType
(WorkOS::Types)
CreateWebhookEndpoint
(WorkOS)
CreateWebhookEndpointEvents
(WorkOS::Types)
D
DataIntegrationAccessTokenResponse
(WorkOS)
DataIntegrationAccessTokenResponseAccessToken
(WorkOS)
DataIntegrationAccessTokenResponseError
(WorkOS::Types)
DataIntegrationAuthorizeUrlResponse
(WorkOS)
DataIntegrationsGetDataIntegrationAuthorizeUrlRequest
(WorkOS)
DataIntegrationsGetUserTokenRequest
(WorkOS)
DataIntegrationsListResponse
(WorkOS)
DataIntegrationsListResponseData
(WorkOS)
DataIntegrationsListResponseDataConnectedAccount
(WorkOS)
DataIntegrationsListResponseDataOwnership
(WorkOS::Types)
DataKey
(WorkOS::Vault)
DataKeyPair
(WorkOS::Vault)
DeviceAuthorizationResponse
(WorkOS)
DeviceCodeSessionAuthenticateRequest
(WorkOS)
Directory
(WorkOS)
DirectoryGroup
(WorkOS)
DirectoryMetadata
(WorkOS)
DirectoryMetadataUser
(WorkOS)
DirectoryState
(WorkOS::Types)
DirectorySync
(WorkOS)
DirectoryType
(WorkOS::Types)
DirectoryUser
(WorkOS)
DirectoryUserEmail
(WorkOS)
DirectoryUserState
(WorkOS::Types)
DirectoryUserWithGroups
(WorkOS)
DsyncActivated
(WorkOS)
DsyncActivatedData
(WorkOS)
DsyncActivatedDataDomain
(WorkOS)
DsyncActivatedDataState
(WorkOS::Types)
DsyncActivatedDataType
(WorkOS::Types)
DsyncDeactivated
(WorkOS)
DsyncDeactivatedData
(WorkOS)
DsyncDeleted
(WorkOS)
DsyncDeletedData
(WorkOS)
DsyncGroupCreated
(WorkOS)
DsyncGroupDeleted
(WorkOS)
DsyncGroupUpdated
(WorkOS)
DsyncGroupUpdatedData
(WorkOS)
DsyncGroupUserAdded
(WorkOS)
DsyncGroupUserAddedData
(WorkOS)
DsyncGroupUserRemoved
(WorkOS)
DsyncUserCreated
(WorkOS)
DsyncUserDeleted
(WorkOS)
DsyncUserUpdated
(WorkOS)
DsyncUserUpdatedData
(WorkOS)
E
EmailChange
(WorkOS)
EmailChangeConfirmation
(WorkOS)
EmailChangeConfirmationUser
(WorkOS)
EmailVerification
(WorkOS)
EmailVerificationCodeSessionAuthenticateRequest
(WorkOS)
EmailVerificationCreated
(WorkOS)
EmailVerificationCreatedData
(WorkOS)
Encryptors
(WorkOS)
EnrollUserAuthenticationFactor
(WorkOS)
Error
(WorkOS)
EventContext
(WorkOS)
EventContextActor
(WorkOS)
EventContextActorSource
(WorkOS::Types)
EventContextGoogleAnalyticsSession
(WorkOS)
EventListListMetadata
(WorkOS)
EventSchema
(WorkOS)
Events
(WorkOS)
ExternalAuthCompleteResponse
(WorkOS)
F
FeatureFlag
(WorkOS)
FeatureFlagOwner
(WorkOS)
FeatureFlags
(WorkOS)
FlagCreated
(WorkOS)
FlagCreatedContext
(WorkOS)
FlagCreatedContextActor
(WorkOS)
FlagCreatedData
(WorkOS)
FlagDeleted
(WorkOS)
FlagDeletedContext
(WorkOS)
FlagDeletedContextActor
(WorkOS)
FlagRuleUpdated
(WorkOS)
FlagRuleUpdatedContext
(WorkOS)
FlagRuleUpdatedContextAccessType
(WorkOS::Types)
FlagRuleUpdatedContextActor
(WorkOS)
FlagRuleUpdatedContextConfiguredTarget
(WorkOS)
FlagRuleUpdatedContextConfiguredTargetOrganization
(WorkOS)
FlagRuleUpdatedContextConfiguredTargetUser
(WorkOS)
FlagRuleUpdatedContextPreviousAttribute
(WorkOS)
FlagRuleUpdatedContextPreviousAttributeContext
(WorkOS)
FlagRuleUpdatedContextPreviousAttributeData
(WorkOS)
FlagUpdated
(WorkOS)
FlagUpdatedContext
(WorkOS)
FlagUpdatedContextActor
(WorkOS)
FlagUpdatedContextPreviousAttribute
(WorkOS)
FlagUpdatedContextPreviousAttributeData
(WorkOS)
ForbiddenRequestError
(WorkOS)
G
GenerateLink
(WorkOS)
GenerateLinkIntent
(WorkOS::Types)
Group
(WorkOS)
GroupCreated
(WorkOS)
GroupDeleted
(WorkOS)
GroupMemberAdded
(WorkOS)
GroupMemberAddedData
(WorkOS)
GroupMemberRemoved
(WorkOS)
GroupUpdated
(WorkOS)
H
HashProvider
(WorkOS)
I
IdempotencyError
(WorkOS)
IntentOptions
(WorkOS)
InvalidRequestError
(WorkOS)
Invitation
(WorkOS)
InvitationAccepted
(WorkOS)
InvitationAcceptedData
(WorkOS)
InvitationAcceptedDataState
(WorkOS::Types)
InvitationCreated
(WorkOS)
InvitationCreatedData
(WorkOS)
InvitationResent
(WorkOS)
InvitationResentData
(WorkOS)
InvitationRevoked
(WorkOS)
InvitationRevokedData
(WorkOS)
J
JWTTemplateResponse
(WorkOS)
JwksResponse
(WorkOS)
JwksResponseKeys
(WorkOS)
L
ListStruct
(WorkOS::Types)
M
MFATotpSessionAuthenticateRequest
(WorkOS)
MagicAuth
(WorkOS)
MagicAuthCodeSessionAuthenticateRequest
(WorkOS)
MagicAuthCreated
(WorkOS)
MagicAuthCreatedData
(WorkOS)
MultiFactorAuth
(WorkOS)
N
NewConnectApplicationSecret
(WorkOS)
NotFoundError
(WorkOS)
O
ObjectDigest
(WorkOS::Vault)
ObjectMetadata
(WorkOS::Vault)
ObjectUpdateBy
(WorkOS::Vault)
ObjectVersion
(WorkOS::Vault)
Organization
(WorkOS)
OrganizationCreated
(WorkOS)
OrganizationCreatedData
(WorkOS)
OrganizationCreatedDataDomain
(WorkOS)
OrganizationCreatedDataDomainState
(WorkOS::Types)
OrganizationCreatedDataDomainVerificationStrategy
(WorkOS::Types)
OrganizationDeleted
(WorkOS)
OrganizationDeletedData
(WorkOS)
OrganizationDeletedDataDomain
(WorkOS)
OrganizationDomain
(WorkOS)
OrganizationDomainCreated
(WorkOS)
OrganizationDomainCreatedData
(WorkOS)
OrganizationDomainData
(WorkOS)
OrganizationDomainDataState
(WorkOS::Types)
OrganizationDomainDeleted
(WorkOS)
OrganizationDomainDeletedData
(WorkOS)
OrganizationDomainStandAlone
(WorkOS)
OrganizationDomainUpdated
(WorkOS)
OrganizationDomainUpdatedData
(WorkOS)
OrganizationDomainVerificationFailed
(WorkOS)
OrganizationDomainVerificationFailedData
(WorkOS)
OrganizationDomainVerificationFailedDataOrganizationDomain
(WorkOS)
OrganizationDomainVerificationFailedDataReason
(WorkOS::Types)
OrganizationDomainVerified
(WorkOS)
OrganizationDomainVerifiedData
(WorkOS)
OrganizationDomains
(WorkOS)
OrganizationInput
(WorkOS)
OrganizationMembership
(WorkOS)
OrganizationMembershipCreated
(WorkOS)
OrganizationMembershipCreatedData
(WorkOS)
OrganizationMembershipCreatedDataStatus
(WorkOS::Types)
OrganizationMembershipDeleted
(WorkOS)
OrganizationMembershipDeletedData
(WorkOS)
OrganizationMembershipUpdated
(WorkOS)
OrganizationMembershipUpdatedData
(WorkOS)
OrganizationRoleCreated
(WorkOS)
OrganizationRoleCreatedData
(WorkOS)
OrganizationRoleDeleted
(WorkOS)
OrganizationRoleUpdated
(WorkOS)
OrganizationSelectionSessionAuthenticateRequest
(WorkOS)
OrganizationUpdated
(WorkOS)
OrganizationUpdatedData
(WorkOS)
OrganizationUpdatedDataDomain
(WorkOS)
Organizations
(WorkOS)
P
PKCE
(WorkOS)
PasswordReset
(WorkOS)
PasswordResetCreated
(WorkOS)
PasswordResetCreatedData
(WorkOS)
PasswordResetSucceeded
(WorkOS)
PasswordSessionAuthenticateRequest
(WorkOS)
Passwordless
(WorkOS)
PasswordlessSession
(WorkOS::Passwordless)
PermissionCreated
(WorkOS)
PermissionCreatedData
(WorkOS)
PermissionDeleted
(WorkOS)
PermissionUpdated
(WorkOS)
Pipes
(WorkOS)
PortalLinkResponse
(WorkOS)
Profile
(WorkOS)
PublicClient
(WorkOS)
R
Radar
(WorkOS)
RadarAction
(WorkOS::Types)
RadarListEntryAlreadyPresentResponse
(WorkOS)
RadarStandaloneAssessRequest
(WorkOS)
RadarStandaloneAssessRequestAction
(WorkOS::Types)
RadarStandaloneAssessRequestAuthMethod
(WorkOS::Types)
RadarStandaloneDeleteRadarListEntryRequest
(WorkOS)
RadarStandaloneResponse
(WorkOS)
RadarStandaloneResponseBlocklistType
(WorkOS::Types)
RadarStandaloneResponseControl
(WorkOS::Types)
RadarStandaloneResponseVerdict
(WorkOS::Types)
RadarStandaloneUpdateRadarAttemptRequest
(WorkOS)
RateLimitExceededError
(WorkOS)
RedirectUri
(WorkOS)
RedirectUriInput
(WorkOS)
RefreshError
(WorkOS::SessionManager)
RefreshSuccess
(WorkOS::SessionManager)
RefreshTokenSessionAuthenticateRequest
(WorkOS)
RequestOptions
(WorkOS::Types)
ResendUserInviteOptions
(WorkOS)
ResetPasswordResponse
(WorkOS)
RevokeSession
(WorkOS)
Role
(WorkOS)
RoleAssignment
(WorkOS)
RoleAssignmentResource
(WorkOS)
RoleCreated
(WorkOS)
RoleCreatedData
(WorkOS)
RoleDeleted
(WorkOS)
RoleList
(WorkOS)
RoleType
(WorkOS::Types)
RoleUpdated
(WorkOS)
S
SSO
(WorkOS)
SSOAuthorizeUrlResponse
(WorkOS)
SSODeviceAuthorizationRequest
(WorkOS)
SSOIntentOptions
(WorkOS)
SSOLogoutAuthorizeRequest
(WorkOS)
SSOLogoutAuthorizeResponse
(WorkOS)
SSOProvider
(WorkOS::Types)
SSOTokenResponse
(WorkOS)
SendEmailChange
(WorkOS)
Session
(WorkOS)
SessionCreated
(WorkOS)
SessionCreatedData
(WorkOS)
SessionCreatedDataAuthMethod
(WorkOS::Types)
SessionCreatedDataStatus
(WorkOS::Types)
SessionManager
(WorkOS)
SessionRevoked
(WorkOS)
SessionRevokedData
(WorkOS)
SetRolePermissions
(WorkOS)
Signature
(WorkOS::Util)
SignatureVerificationError
(WorkOS)
T
TokenQuery
(WorkOS)
Types
(WorkOS)
U
UnprocessableEntityError
(WorkOS)
UpdateAuditLogsRetention
(WorkOS)
UpdateAuthorizationPermission
(WorkOS)
UpdateAuthorizationResource
(WorkOS)
UpdateJWTTemplate
(WorkOS)
UpdateOAuthApplication
(WorkOS)
UpdateOrganization
(WorkOS)
UpdateUser
(WorkOS)
UpdateUserOrganizationMembership
(WorkOS)
UpdateWebhookEndpoint
(WorkOS)
UpdateWebhookEndpointStatus
(WorkOS::Types)
UserAuthenticationFactorEnrollResponse
(WorkOS)
UserConsentOption
(WorkOS)
UserConsentOptionChoice
(WorkOS)
UserCreated
(WorkOS)
UserDeleted
(WorkOS)
UserIdentitiesGetItem
(WorkOS)
UserIdentitiesGetItemProvider
(WorkOS::Types)
UserInvite
(WorkOS)
UserManagement
(WorkOS)
UserManagementAuthenticationProvider
(WorkOS::Types)
UserManagementAuthenticationScreenHint
(WorkOS::Types)
UserManagementLoginRequest
(WorkOS)
UserObject
(WorkOS)
UserOrganizationMembership
(WorkOS)
UserOrganizationMembershipBaseListData
(WorkOS)
UserSessionsListItem
(WorkOS)
UserUpdated
(WorkOS)
Util
(WorkOS)
V
ValidateApiKey
(WorkOS)
Vault
(WorkOS)
VaultByokKeyVerificationCompleted
(WorkOS)
VaultByokKeyVerificationCompletedData
(WorkOS)
VaultByokKeyVerificationCompletedDataKeyProvider
(WorkOS::Types)
VaultDataCreated
(WorkOS)
VaultDataCreatedData
(WorkOS)
VaultDataCreatedDataActorSource
(WorkOS::Types)
VaultDataDeleted
(WorkOS)
VaultDataDeletedData
(WorkOS)
VaultDataRead
(WorkOS)
VaultDataReadData
(WorkOS)
VaultDataUpdated
(WorkOS)
VaultDataUpdatedData
(WorkOS)
VaultDekDecrypted
(WorkOS)
VaultDekDecryptedData
(WorkOS)
VaultDekRead
(WorkOS)
VaultDekReadData
(WorkOS)
VaultKekCreated
(WorkOS)
VaultKekCreatedData
(WorkOS)
VaultMetadataRead
(WorkOS)
VaultMetadataReadData
(WorkOS)
VaultNamesListed
(WorkOS)
VaultNamesListedData
(WorkOS)
VaultObject
(WorkOS::Vault)
W
WebhookEndpoint
(WorkOS)
WebhookEndpointJson
(WorkOS)
WebhookEndpointStatus
(WorkOS::Types)
WebhookEvent
(WorkOS)
Webhooks
(WorkOS)
WidgetSessionToken
(WorkOS)
WidgetSessionTokenResponse
(WorkOS)
WidgetSessionTokenScopes
(WorkOS::Types)
Widgets
(WorkOS)
WorkOS