workos

type APIError struct {
	StatusCode int    `json:"-"`
	RequestID  string `json:"-"`
	RetryAfter int    `json:"-"`
	RawBody    string `json:"-"`

	// Code is the error code from responses using the {"code": ..., "message": ...} format.
	Code string `json:"code"`
	// Message is the human-readable error message.
	Message string `json:"message"`
	// ErrorCode is the error identifier from responses using the {"error": ..., "error_description": ...} format (e.g. "invalid_client", "sso_required").
	ErrorCode string `json:"error"`
	// ErrorDescription is the human-readable description from OAuth-style error responses.
	ErrorDescription string `json:"error_description"`
	// Errors is a list of error strings returned by the API.
	Errors []string `json:"errors,omitempty"`
	// FieldErrors is a list of field-level validation errors.
	FieldErrors []FieldError `json:"-"`

	// PendingAuthenticationToken is a token for continuing an authentication flow that requires additional steps.
	PendingAuthenticationToken string `json:"pending_authentication_token,omitempty"`
	// EmailVerificationID is the ID of the pending email verification.
	EmailVerificationID string `json:"email_verification_id,omitempty"`
}

type APIKey struct {
	// Object distinguishes the API Key object.
	Object string `json:"object"`
	// ID is unique identifier of the API Key.
	ID string `json:"id"`
	// Owner is the entity that owns the API Key.
	Owner *APIKeyOwner `json:"owner"`
	// Name is a descriptive name for the API Key.
	Name string `json:"name"`
	// ObfuscatedValue is an obfuscated representation of the API Key value.
	ObfuscatedValue string `json:"obfuscated_value"`
	// LastUsedAt is timestamp of when the API Key was last used.
	LastUsedAt *string `json:"last_used_at"`
	// Permissions is the permission slugs assigned to the API Key.
	Permissions []string `json:"permissions"`
	// CreatedAt is an ISO 8601 timestamp.
	CreatedAt string `json:"created_at"`
	// UpdatedAt is an ISO 8601 timestamp.
	UpdatedAt string `json:"updated_at"`
}

type APIKeyCreated struct {
	// ID is unique identifier for the event.
	ID    string `json:"id"`
	Event string `json:"event"`
	// Data is the event payload.
	Data *APIKeyCreatedData `json:"data"`
	// CreatedAt is an ISO 8601 timestamp.
	CreatedAt string        `json:"created_at"`
	Context   *EventContext `json:"context,omitempty"`
	// Object distinguishes the Event object.
	Object string `json:"object"`
}

type APIKeyCreatedData struct {
	// Object distinguishes the API key object.
	Object string `json:"object"`
	// ID is unique identifier of the API key.
	ID string `json:"id"`
	// Owner is the owner of the API key.
	Owner *APIKeyCreatedDataOwner `json:"owner"`
	// Name is the name of the API key.
	Name string `json:"name"`
	// ObfuscatedValue is the obfuscated value of the API key.
	ObfuscatedValue string `json:"obfuscated_value"`
	// LastUsedAt is the timestamp when the API key was last used.
	LastUsedAt *string `json:"last_used_at"`
	// Permissions is the permissions granted to the API key.
	Permissions []string `json:"permissions"`
	// CreatedAt is the timestamp when the API key was created.
	CreatedAt string `json:"created_at"`
	// UpdatedAt is the timestamp when the API key was last updated.
	UpdatedAt string `json:"updated_at"`
}

type APIKeyCreatedDataOwner struct {
	// Type is the type of the API key owner.
	Type string `json:"type"`
	// ID is the unique identifier of the API key owner.
	ID string `json:"id"`
}

type APIKeyOwner = APIKeyCreatedDataOwner

type APIKeyRevoked struct {
	// ID is unique identifier for the event.
	ID    string `json:"id"`
	Event string `json:"event"`
	// Data is the event payload.
	Data *APIKeyRevokedData `json:"data"`
	// CreatedAt is an ISO 8601 timestamp.
	CreatedAt string        `json:"created_at"`
	Context   *EventContext `json:"context,omitempty"`
	// Object distinguishes the Event object.
	Object string `json:"object"`
}

type APIKeyRevokedData struct {
	// Object distinguishes the API key object.
	Object string `json:"object"`
	// ID is unique identifier of the API key.
	ID string `json:"id"`
	// Owner is the owner of the API key.
	Owner *APIKeyRevokedDataOwner `json:"owner"`
	// Name is the name of the API key.
	Name string `json:"name"`
	// ObfuscatedValue is the obfuscated value of the API key.
	ObfuscatedValue string `json:"obfuscated_value"`
	// LastUsedAt is the timestamp when the API key was last used.
	LastUsedAt *string `json:"last_used_at"`
	// Permissions is the permissions granted to the API key.
	Permissions []string `json:"permissions"`
	// CreatedAt is the timestamp when the API key was created.
	CreatedAt string `json:"created_at"`
	// UpdatedAt is the timestamp when the API key was last updated.
	UpdatedAt string `json:"updated_at"`
}

type APIKeyRevokedDataOwner = APIKeyCreatedDataOwner

type APIKeyService struct {
	// contains filtered or unexported fields
}

type APIKeyValidationResponse struct {
	APIKey *APIKey `json:"api_key"`
}

type APIKeyWithValue struct {
	// Object distinguishes the API Key object.
	Object string `json:"object"`
	// ID is unique identifier of the API Key.
	ID string `json:"id"`
	// Owner is the entity that owns the API Key.
	Owner *APIKeyWithValueOwner `json:"owner"`
	// Name is a descriptive name for the API Key.
	Name string `json:"name"`
	// ObfuscatedValue is an obfuscated representation of the API Key value.
	ObfuscatedValue string `json:"obfuscated_value"`
	// LastUsedAt is timestamp of when the API Key was last used.
	LastUsedAt *string `json:"last_used_at"`
	// Permissions is the permission slugs assigned to the API Key.
	Permissions []string `json:"permissions"`
	// CreatedAt is an ISO 8601 timestamp.
	CreatedAt string `json:"created_at"`
	// UpdatedAt is an ISO 8601 timestamp.
	UpdatedAt string `json:"updated_at"`
	// Value is the full API Key value. Only returned once at creation time.
	Value string `json:"value"`
}

type APIKeyWithValueOwner = APIKeyCreatedDataOwner

type APIKeysCreateOrganizationAPIKeyParams struct {
	// Name is the name for the API key.
	Name string `json:"name"`
	// Permissions is the permission slugs to assign to the API key.
	Permissions []string `json:"permissions,omitempty"`
}

type APIKeysCreateValidationParams struct {
	// Value is the value for an API key.
	Value string `json:"value"`
}

type APIKeysListOrganizationAPIKeysParams struct {
	PaginationParams
}

type ActionAuthenticationDenied struct {
	// ID is unique identifier for the event.
	ID    string `json:"id"`
	Event string `json:"event"`
	// Data is the event payload.
	Data    *ActionAuthenticationDeniedData `json:"data"`
	Context *EventContext                   `json:"context,omitempty"`
	// CreatedAt is an ISO 8601 timestamp.
	CreatedAt string `json:"created_at"`
	// Object distinguishes the Event object.
	Object string `json:"object"`
}

type ActionAuthenticationDeniedData struct {
	// ActionEndpointID is the ID of the action endpoint.
	ActionEndpointID string `json:"action_endpoint_id"`
	// ActionExecutionID is the ID of the action execution.
	ActionExecutionID string `json:"action_execution_id"`
	// Type is the type of action that was denied.
	Type string `json:"type"`
	// Verdict is the verdict of the action.
	Verdict string `json:"verdict"`
	// UserID is the ID of the user.
	UserID string `json:"user_id"`
	// OrganizationID is the ID of the organization.
	OrganizationID *string `json:"organization_id"`
	// Email is the email address of the user.
	Email string `json:"email"`
	// IPAddress is the IP address of the request.
	IPAddress *string `json:"ip_address"`
	// UserAgent is the user agent of the request.
	UserAgent *string `json:"user_agent"`
}

type ActionSignedResponse struct {
	// Payload is the base64-encoded JSON response body.
	Payload string `json:"payload"`
	// Sig is the signature header in the form "t=<timestamp>,v1=<hex>".
	Sig string `json:"sig"`
}

type ActionType string

type ActionUserRegistrationDenied struct {
	// ID is unique identifier for the event.
	ID    string `json:"id"`
	Event string `json:"event"`
	// Data is the event payload.
	Data    *ActionUserRegistrationDeniedData `json:"data"`
	Context *EventContext                     `json:"context,omitempty"`
	// CreatedAt is an ISO 8601 timestamp.
	CreatedAt string `json:"created_at"`
	// Object distinguishes the Event object.
	Object string `json:"object"`
}

type ActionUserRegistrationDeniedData struct {
	// ActionEndpointID is the ID of the action endpoint.
	ActionEndpointID string `json:"action_endpoint_id"`
	// ActionExecutionID is the ID of the action execution.
	ActionExecutionID string `json:"action_execution_id"`
	// Type is the type of action that was denied.
	Type string `json:"type"`
	// Verdict is the verdict of the action.
	Verdict string `json:"verdict"`
	// OrganizationID is the ID of the organization.
	OrganizationID *string `json:"organization_id"`
	// Email is the email address of the user.
	Email string `json:"email"`
	// IPAddress is the IP address of the request.
	IPAddress *string `json:"ip_address"`
	// UserAgent is the user agent of the request.
	UserAgent *string `json:"user_agent"`
}

type ActionVerdict string

type ActionsHelper struct {
	// contains filtered or unexported fields
}

type AddRolePermission struct {
	// Slug is the slug of the permission to add to the role.
	Slug string `json:"slug"`
}

type AdminPortalGenerateLinkParams struct {
	// ReturnURL is the URL to go to when an admin clicks on your logo in the Admin Portal. If not specified, the return URL configured on the [Redirects](https://dashboard.workos.com/redirects) page will be used.
	ReturnURL *string `json:"return_url,omitempty"`
	// SuccessURL is the URL to redirect the admin to when they finish setup. If not specified, the success URL configured on the [Redirects](https://dashboard.workos.com/redirects) page will be used.
	SuccessURL *string `json:"success_url,omitempty"`
	// Organization is an [Organization](https://workos.com/docs/reference/organization) identifier.
	Organization string `json:"organization"`
	// Intent is       The intent of the Admin Portal.
	// - `sso` - Launch Admin Portal for creating SSO connections
	// - `dsync` - Launch Admin Portal for creating Directory Sync connections
	// - `audit_logs` - Launch Admin Portal for viewing Audit Logs
	// - `log_streams` - Launch Admin Portal for creating Log Streams
	// - `domain_verification` - Launch Admin Portal for Domain Verification
	// - `certificate_renewal` - Launch Admin Portal for renewing SAML Certificates
	// - `bring_your_own_key` - Launch Admin Portal for configuring Bring Your Own Key
	Intent *GenerateLinkIntent `json:"intent,omitempty"`
	// IntentOptions is options to configure the Admin Portal based on the intent.
	IntentOptions *IntentOptions `json:"intent_options,omitempty"`
	// AdminEmails is the email addresses of the IT admins to grant access to the Admin Portal for the given organization. Accepts up to 20 emails.
	AdminEmails []string `json:"admin_emails,omitempty"`
}

type AdminPortalService struct {
	// contains filtered or unexported fields
}

type ApplicationCredentialsListItem struct {
	// Object distinguishes the connect application secret object.
	Object string `json:"object"`
	// ID is the unique ID of the client secret.
	ID string `json:"id"`
	// SecretHint is a hint showing the last few characters of the secret value.
	SecretHint string `json:"secret_hint"`
	// LastUsedAt is the timestamp when the client secret was last used, or null if never used.
	LastUsedAt *string `json:"last_used_at"`
	// CreatedAt is an ISO 8601 timestamp.
	CreatedAt string `json:"created_at"`
	// UpdatedAt is an ISO 8601 timestamp.
	UpdatedAt string `json:"updated_at"`
}

type ApplicationsOrder string

type AssignRole struct {
	// RoleSlug is the slug of the role to assign.
	RoleSlug string `json:"role_slug"`
	// ResourceID is the ID of the resource. Mutually exclusive with `resource_external_id` and `resource_type_slug`.
	ResourceID *string `json:"resource_id,omitempty"`
	// ResourceExternalID is the external ID of the resource. Required with `resource_type_slug`. Mutually exclusive with `resource_id`.
	ResourceExternalID *string `json:"resource_external_id,omitempty"`
	// ResourceTypeSlug is the resource type slug. Required with `resource_external_id`. Mutually exclusive with `resource_id`.
	ResourceTypeSlug *string `json:"resource_type_slug,omitempty"`
}

type AuditLogActionJSON struct {
	// Object distinguishes the Audit Log Action object.
	Object string `json:"object"`
	// Name is identifier of what action was taken.
	Name string `json:"name"`
	// Schema is the schema associated with the action.
	Schema *AuditLogSchemaJSON `json:"schema"`
	// CreatedAt is an ISO 8601 timestamp.
	CreatedAt string `json:"created_at"`
	// UpdatedAt is an ISO 8601 timestamp.
	UpdatedAt string `json:"updated_at"`
}

type AuditLogConfiguration struct {
	// OrganizationID is unique identifier of the Organization.
	OrganizationID string `json:"organization_id"`
	// RetentionPeriodInDays is the number of days Audit Log events will be retained before being permanently deleted.
	RetentionPeriodInDays int `json:"retention_period_in_days"`
	// State is the current state of the audit log configuration for the organization.
	State AuditLogConfigurationState `json:"state"`
	// LogStream is the Audit Log Stream currently configured for the organization, if any.
	LogStream *AuditLogConfigurationLogStream `json:"log_stream,omitempty"`
}

type AuditLogConfigurationLogStream struct {
	// ID is unique identifier of the Audit Log Stream.
	ID string `json:"id"`
	// Type is the type of the Audit Log Stream destination.
	Type AuditLogConfigurationLogStreamType `json:"type"`
	// State is the current state of the Audit Log Stream.
	State AuditLogConfigurationLogStreamState `json:"state"`
	// LastSyncedAt is iso-8601 timestamp of when the last event was successfully synced, or null if no events have been synced.
	LastSyncedAt *string `json:"last_synced_at"`
	// CreatedAt is an ISO 8601 timestamp.
	CreatedAt string `json:"created_at"`
}

type AuditLogConfigurationLogStreamState string

type AuditLogConfigurationLogStreamType string

type AuditLogConfigurationState string

type AuditLogEvent struct {
	// Action is identifier of what happened.
	Action string `json:"action"`
	// OccurredAt is iso-8601 value of when the action occurred.
	OccurredAt string `json:"occurred_at"`
	// Actor is the entity that performed the action.
	Actor *AuditLogEventActor `json:"actor"`
	// Targets is the resources affected by the action.
	Targets []*AuditLogEventTarget `json:"targets"`
	// Context is additional context about where and how the action occurred.
	Context *AuditLogEventContext `json:"context"`
	// Metadata is additional data associated with the event or entity.
	Metadata map[string]interface{} `json:"metadata,omitempty"`
	// Version is what schema version the event is associated with.
	Version *int `json:"version,omitempty"`
}

type AuditLogEventActor struct {
	// ID is actor identifier.
	ID string `json:"id"`
	// Type is actor type.
	Type string `json:"type"`
	// Name is optional actor name.
	Name *string `json:"name,omitempty"`
	// Metadata is additional data associated with the event or entity.
	Metadata map[string]interface{} `json:"metadata,omitempty"`
}

type AuditLogEventContext struct {
	// Location is ip Address or some other geolocation identifier.
	Location string `json:"location"`
	// UserAgent is user agent string.
	UserAgent *string `json:"user_agent,omitempty"`
}

type AuditLogEventCreateResponse struct {
	// Success is whether the Audit Log event was created successfully.
	Success bool `json:"success"`
}

type AuditLogEventIngestion struct {
	// OrganizationID is the unique ID of the Organization.
	OrganizationID string `json:"organization_id"`
	// Event is the audit log event to create.
	Event *AuditLogEvent `json:"event"`
}

type AuditLogEventTarget = AuditLogEventActor

type AuditLogExportCreation struct {
	// OrganizationID is the unique ID of the Organization.
	OrganizationID string `json:"organization_id"`
	// RangeStart is iso-8601 value for start of the export range.
	RangeStart string `json:"range_start"`
	// RangeEnd is iso-8601 value for end of the export range.
	RangeEnd string `json:"range_end"`
	// Actions is list of actions to filter against.
	Actions []string `json:"actions,omitempty"`
	// Actors is deprecated. Use `actor_names` instead.
	//
	// Deprecated: Use `actor_names` instead.
	Actors []string `json:"actors,omitempty"`
	// ActorNames is list of actor names to filter against.
	ActorNames []string `json:"actor_names,omitempty"`
	// ActorIDs is list of actor IDs to filter against.
	ActorIDs []string `json:"actor_ids,omitempty"`
	// Targets is list of target types to filter against.
	Targets []string `json:"targets,omitempty"`
}

type AuditLogExportJSON struct {
	// Object distinguishes the Audit Log Export object.
	Object string `json:"object"`
	// ID is the unique ID of the Audit Log Export.
	ID string `json:"id"`
	// State is the state of the export. Possible values: pending, ready, error.
	State AuditLogExportJSONState `json:"state"`
	// URL is a URL to the CSV file. Only defined when the Audit Log Export is ready.
	URL *string `json:"url,omitempty"`
	// CreatedAt is an ISO 8601 timestamp.
	CreatedAt string `json:"created_at"`
	// UpdatedAt is an ISO 8601 timestamp.
	UpdatedAt string `json:"updated_at"`
}

type AuditLogExportJSONState string

type AuditLogSchema struct {
	// Actor is the metadata schema for the actor.
	Actor *AuditLogSchemaActor `json:"actor,omitempty"`
	// Targets is the list of targets for the schema.
	Targets []*AuditLogSchemaTarget `json:"targets"`
	// Metadata is optional JSON schema for event metadata.
	Metadata map[string]interface{} `json:"metadata,omitempty"`
}

type AuditLogSchemaActor struct {
	// Metadata is json schema for actor metadata.
	Metadata map[string]interface{} `json:"metadata"`
}

type AuditLogSchemaJSON struct {
	// Object distinguishes the Audit Log Schema object.
	Object string `json:"object"`
	// Version is the version of the schema.
	Version int `json:"version"`
	// Actor is the metadata schema for the actor.
	Actor *AuditLogSchemaJSONActor `json:"actor,omitempty"`
	// Targets is the list of targets for the schema.
	Targets []*AuditLogSchemaJSONTarget `json:"targets"`
	// Metadata is additional data associated with the event or entity.
	Metadata map[string]interface{} `json:"metadata,omitempty"`
	// CreatedAt is the timestamp when the Audit Log Schema was created.
	CreatedAt string `json:"created_at"`
}

type AuditLogSchemaJSONActor = AuditLogSchemaActor

type AuditLogSchemaJSONTarget struct {
	// Type is the type of the target resource.
	Type string `json:"type"`
	// Metadata is additional data associated with the event or entity.
	Metadata map[string]interface{} `json:"metadata,omitempty"`
}

type AuditLogSchemaTarget = AuditLogSchemaJSONTarget

type AuditLogService struct {
	// contains filtered or unexported fields
}

type AuditLogsCreateEventParams struct {
	// OrganizationID is the unique ID of the Organization.
	OrganizationID string `json:"organization_id"`
	// Event is the audit log event to create.
	Event *AuditLogEvent `json:"event"`
}

type AuditLogsCreateExportParams struct {
	// OrganizationID is the unique ID of the Organization.
	OrganizationID string `json:"organization_id"`
	// RangeStart is iso-8601 value for start of the export range.
	RangeStart string `json:"range_start"`
	// RangeEnd is iso-8601 value for end of the export range.
	RangeEnd string `json:"range_end"`
	// Actions is list of actions to filter against.
	Actions []string `json:"actions,omitempty"`
	// Actors is deprecated. Use `actor_names` instead.
	//
	// Deprecated: this field is deprecated.
	Actors []string `json:"actors,omitempty"`
	// ActorNames is list of actor names to filter against.
	ActorNames []string `json:"actor_names,omitempty"`
	// ActorIDs is list of actor IDs to filter against.
	ActorIDs []string `json:"actor_ids,omitempty"`
	// Targets is list of target types to filter against.
	Targets []string `json:"targets,omitempty"`
}

type AuditLogsCreateSchemaParams struct {
	// Actor is the metadata schema for the actor.
	Actor *AuditLogSchemaActor `json:"actor,omitempty"`
	// Targets is the list of targets for the schema.
	Targets []*AuditLogSchemaTarget `json:"targets"`
	// Metadata is optional JSON schema for event metadata.
	Metadata map[string]interface{} `json:"metadata,omitempty"`
}

type AuditLogsListActionSchemasParams struct {
	PaginationParams
}

type AuditLogsListActionsParams struct {
	PaginationParams
}

type AuditLogsOrder = ApplicationsOrder

type AuditLogsRetentionJSON struct {
	// RetentionPeriodInDays is the number of days Audit Log events will be retained before being permanently deleted. Valid values are 30 and 365.
	RetentionPeriodInDays *int `json:"retention_period_in_days"`
}

type AuditLogsUpdateOrganizationAuditLogsRetentionParams struct {
	// RetentionPeriodInDays is the number of days Audit Log events will be retained. Valid values are `30` and `365`.
	RetentionPeriodInDays int `json:"retention_period_in_days"`
}

type AuthKitAuthorizationURLParams struct {
	RedirectURI         string
	ClientID            string // if empty, uses client's configured clientID
	Provider            *string
	ConnectionID        *string
	OrganizationID      *string
	DomainHint          *string
	LoginHint           *string
	State               *string
	CodeChallenge       *string
	CodeChallengeMethod *string
	ScreenHint          *string
}

type AuthKitPKCEAuthorizationURLResult struct {
	URL          string
	CodeVerifier string
	State        string
}

type AuthKitPKCECodeExchangeParams struct {
	Code         string
	CodeVerifier string
}

type AuthenticateResponse struct {
	// User is the corresponding [user](https://workos.com/docs/reference/authkit/user) object.
	User *User `json:"user"`
	// OrganizationID is the ID of the organization the user selected to sign in to.
	OrganizationID *string `json:"organization_id,omitempty"`
	// AuthkitAuthorizationCode is an authorization code that can be exchanged for tokens by a different application.
	AuthkitAuthorizationCode *string `json:"authkit_authorization_code,omitempty"`
	// AccessToken is a JWT containing information about the current session.
	AccessToken string `json:"access_token"`
	// RefreshToken is [Exchange this token](https://workos.com/docs/reference/authkit/authentication/refresh-token) for a new access token.
	RefreshToken string `json:"refresh_token"`
	// AuthenticationMethod is the authentication method used to initiate the session.
	AuthenticationMethod *AuthenticateResponseAuthenticationMethod `json:"authentication_method,omitempty"`
	// Impersonator is information about the impersonator if this session was created via impersonation.
	Impersonator *AuthenticateResponseImpersonator `json:"impersonator,omitempty"`
	// OAuthTokens is the OAuth tokens from the identity provider, if applicable.
	OAuthTokens *AuthenticateResponseOAuthToken `json:"oauth_tokens,omitempty"`
}

type AuthenticateResponseAuthenticationMethod string

type AuthenticateResponseImpersonator struct {
	// Email is the email address of the WorkOS Dashboard user who is impersonating the user.
	Email string `json:"email"`
	// Reason is the justification the impersonator gave for impersonating the user.
	Reason *string `json:"reason"`
}

type AuthenticateResponseOAuthToken struct {
	// Provider is the OAuth provider used for authentication.
	Provider string `json:"provider"`
	// RefreshToken is the refresh token from the OAuth provider.
	RefreshToken string `json:"refresh_token"`
	// AccessToken is the access token from the OAuth provider.
	AccessToken string `json:"access_token"`
	// ExpiresAt is the timestamp at which the access token expires.
	ExpiresAt int `json:"expires_at"`
	// Scopes is a list of OAuth scopes for which the access token is authorized.
	Scopes []string `json:"scopes"`
}

type AuthenticateSessionResult struct {
	Authenticated  bool
	SessionID      string
	OrganizationID string
	Role           string
	Permissions    []string
	Entitlements   []string
	User           *User
	Impersonator   *AuthenticateResponseImpersonator
	Reason         string // populated on failure: "no_session_cookie_provided", "invalid_session_cookie", "invalid_jwt", etc.
}

type AuthenticationChallenge struct {
	// Object distinguishes the authentication challenge object.
	Object string `json:"object"`
	// ID is the unique ID of the authentication challenge.
	ID string `json:"id"`
	// ExpiresAt is the timestamp when the challenge will expire. Does not apply to TOTP factors.
	ExpiresAt *string `json:"expires_at,omitempty"`
	// Code is the one-time code for the challenge.
	Code *string `json:"code,omitempty"`
	// AuthenticationFactorID is the unique ID of the authentication factor the challenge belongs to.
	AuthenticationFactorID string `json:"authentication_factor_id"`
	// CreatedAt is an ISO 8601 timestamp.
	CreatedAt string `json:"created_at"`
	// UpdatedAt is an ISO 8601 timestamp.
	UpdatedAt string `json:"updated_at"`
}

type AuthenticationChallengeVerifyResponse struct {
	// Challenge is the authentication challenge object.
	Challenge *AuthenticationChallenge `json:"challenge"`
	// Valid is whether the code was valid.
	Valid bool `json:"valid"`
}

type AuthenticationChallengesVerifyRequest struct {
	// Code is the one-time code to verify.
	Code string `json:"code"`
}

type AuthenticationEmailVerificationFailed struct {
	// ID is unique identifier for the event.
	ID    string `json:"id"`
	Event string `json:"event"`
	// Data is the event payload.
	Data *AuthenticationEmailVerificationFailedData `json:"data"`
	// CreatedAt is an ISO 8601 timestamp.
	CreatedAt string        `json:"created_at"`
	Context   *EventContext `json:"context,omitempty"`
	// Object distinguishes the Event object.
	Object string `json:"object"`
}

type AuthenticationEmailVerificationFailedData struct {
	Type   string `json:"type"`
	Status string `json:"status"`
	// IPAddress is the IP address of the request.
	IPAddress *string `json:"ip_address"`
	// UserAgent is the user agent of the request.
	UserAgent *string `json:"user_agent"`
	// UserID is the ID of the user.
	UserID *string `json:"user_id"`
	// Email is the email address of the user.
	Email *string `json:"email"`
	// Error is details about the authentication error.
	Error *AuthenticationEmailVerificationFailedDataError `json:"error"`
}

type AuthenticationEmailVerificationFailedDataError struct {
	// Code is the error code.
	Code string `json:"code"`
	// Message is a human-readable error message.
	Message string `json:"message"`
}

type AuthenticationEmailVerificationSucceeded struct {
	// ID is unique identifier for the event.
	ID    string `json:"id"`
	Event string `json:"event"`
	// Data is the event payload.
	Data *AuthenticationEmailVerificationSucceededData `json:"data"`
	// CreatedAt is an ISO 8601 timestamp.
	CreatedAt string        `json:"created_at"`
	Context   *EventContext `json:"context,omitempty"`
	// Object distinguishes the Event object.
	Object string `json:"object"`
}

type AuthenticationEmailVerificationSucceededData struct {
	Type   string `json:"type"`
	Status string `json:"status"`
	// IPAddress is the IP address of the request.
	IPAddress *string `json:"ip_address"`
	// UserAgent is the user agent of the request.
	UserAgent *string `json:"user_agent"`
	// UserID is the ID of the user.
	UserID string `json:"user_id"`
	// Email is the email address of the user.
	Email string `json:"email"`
}

type AuthenticationError struct {
	*APIError
}

type AuthenticationFactor struct {
	// Object distinguishes the authentication factor object.
	Object string `json:"object"`
	// ID is the unique ID of the factor.
	ID string `json:"id"`
	// Type is the type of the factor to enroll.
	Type AuthenticationFactorType `json:"type"`
	// UserID is the ID of the [user](https://workos.com/docs/reference/authkit/user).
	UserID *string `json:"user_id,omitempty"`
	// Sms is sms-based authentication factor details.
	Sms *AuthenticationFactorSms `json:"sms,omitempty"`
	// TOTP is totp-based authentication factor details.
	TOTP *AuthenticationFactorTOTP `json:"totp,omitempty"`
	// CreatedAt is an ISO 8601 timestamp.
	CreatedAt string `json:"created_at"`
	// UpdatedAt is an ISO 8601 timestamp.
	UpdatedAt string `json:"updated_at"`
}

type AuthenticationFactorEnrolled struct {
	// Object distinguishes the authentication factor object.
	Object string `json:"object"`
	// ID is the unique ID of the factor.
	ID string `json:"id"`
	// Type is the type of the factor to enroll.
	Type AuthenticationFactorEnrolledType `json:"type"`
	// UserID is the ID of the [user](https://workos.com/docs/reference/authkit/user).
	UserID *string `json:"user_id,omitempty"`
	// Sms is sms-based authentication factor details.
	Sms *AuthenticationFactorEnrolledSms `json:"sms,omitempty"`
	// TOTP is totp-based authentication factor details. Includes enrollment secrets only available at creation time.
	TOTP *AuthenticationFactorEnrolledTOTP `json:"totp,omitempty"`
	// CreatedAt is an ISO 8601 timestamp.
	CreatedAt string `json:"created_at"`
	// UpdatedAt is an ISO 8601 timestamp.
	UpdatedAt string `json:"updated_at"`
}

type AuthenticationFactorEnrolledSms struct {
	// PhoneNumber is the user's phone number for SMS-based authentication.
	PhoneNumber string `json:"phone_number"`
}

type AuthenticationFactorEnrolledTOTP struct {
	// Issuer is your application or company name displayed in the user's authenticator app. Defaults to your WorkOS team name.
	Issuer string `json:"issuer"`
	// User is the user's account name displayed in their authenticator app. Defaults to the user's email.
	User string `json:"user"`
	// Secret is totp secret that can be manually entered into some authenticator apps in place of scanning a QR code.
	Secret string `json:"secret"`
	// QrCode is base64 encoded image containing scannable QR code.
	QrCode string `json:"qr_code"`
	// URI is the `otpauth` URI that is encoded by the provided `qr_code`.
	URI string `json:"uri"`
}

type AuthenticationFactorEnrolledType string

type AuthenticationFactorSms = AuthenticationFactorEnrolledSms

type AuthenticationFactorTOTP struct {
	// Issuer is your application or company name displayed in the user's authenticator app. Defaults to your WorkOS team name.
	Issuer string `json:"issuer"`
	// User is the user's account name displayed in their authenticator app. Defaults to the user's email.
	User string `json:"user"`
}

type AuthenticationFactorType = AuthenticationFactorEnrolledType

type AuthenticationFactorsCreateRequest struct {
	// Type is the type of factor to enroll.
	Type AuthenticationFactorsCreateRequestType `json:"type"`
	// PhoneNumber is required when type is 'sms'.
	PhoneNumber *string `json:"phone_number,omitempty"`
	// TOTPIssuer is required when type is 'totp'.
	TOTPIssuer *string `json:"totp_issuer,omitempty"`
	// TOTPUser is required when type is 'totp'.
	TOTPUser *string `json:"totp_user,omitempty"`
	// UserID is the ID of the user to associate the factor with.
	UserID *string `json:"user_id,omitempty"`
}

type AuthenticationFactorsCreateRequestType string

type AuthenticationMFAFailed struct {
	// ID is unique identifier for the event.
	ID    string `json:"id"`
	Event string `json:"event"`
	// Data is the event payload.
	Data *AuthenticationMFAFailedData `json:"data"`
	// CreatedAt is an ISO 8601 timestamp.
	CreatedAt string        `json:"created_at"`
	Context   *EventContext `json:"context,omitempty"`
	// Object distinguishes the Event object.
	Object string `json:"object"`
}

type AuthenticationMFAFailedData struct {
	Type   string `json:"type"`
	Status string `json:"status"`
	// IPAddress is the IP address of the request.
	IPAddress *string `json:"ip_address"`
	// UserAgent is the user agent of the request.
	UserAgent *string `json:"user_agent"`
	// UserID is the ID of the user.
	UserID *string `json:"user_id"`
	// Email is the email address of the user.
	Email *string `json:"email"`
	// Error is details about the authentication error.
	Error *AuthenticationMFAFailedDataError `json:"error"`
}

type AuthenticationMFAFailedDataError = AuthenticationEmailVerificationFailedDataError

type AuthenticationMFASucceeded struct {
	// ID is unique identifier for the event.
	ID    string `json:"id"`
	Event string `json:"event"`
	// Data is the event payload.
	Data *AuthenticationMFASucceededData `json:"data"`
	// CreatedAt is an ISO 8601 timestamp.
	CreatedAt string        `json:"created_at"`
	Context   *EventContext `json:"context,omitempty"`
	// Object distinguishes the Event object.
	Object string `json:"object"`
}

type AuthenticationMFASucceededData struct {
	Type   string `json:"type"`
	Status string `json:"status"`
	// IPAddress is the IP address of the request.
	IPAddress *string `json:"ip_address"`
	// UserAgent is the user agent of the request.
	UserAgent *string `json:"user_agent"`
	// UserID is the ID of the user.
	UserID string `json:"user_id"`
	// Email is the email address of the user.
	Email string `json:"email"`
}

type AuthenticationMagicAuthFailed struct {
	// ID is unique identifier for the event.
	ID    string `json:"id"`
	Event string `json:"event"`
	// Data is the event payload.
	Data *AuthenticationMagicAuthFailedData `json:"data"`
	// CreatedAt is an ISO 8601 timestamp.
	CreatedAt string        `json:"created_at"`
	Context   *EventContext `json:"context,omitempty"`
	// Object distinguishes the Event object.
	Object string `json:"object"`
}

type AuthenticationMagicAuthFailedData struct {
	Type   string `json:"type"`
	Status string `json:"status"`
	// IPAddress is the IP address of the request.
	IPAddress *string `json:"ip_address"`
	// UserAgent is the user agent of the request.
	UserAgent *string `json:"user_agent"`
	// UserID is the ID of the user.
	UserID *string `json:"user_id"`
	// Email is the email address of the user.
	Email *string `json:"email"`
	// Error is details about the authentication error.
	Error *AuthenticationMagicAuthFailedDataError `json:"error"`
}

type AuthenticationMagicAuthFailedDataError = AuthenticationEmailVerificationFailedDataError

type AuthenticationMagicAuthSucceeded struct {
	// ID is unique identifier for the event.
	ID    string `json:"id"`
	Event string `json:"event"`
	// Data is the event payload.
	Data *AuthenticationMagicAuthSucceededData `json:"data"`
	// CreatedAt is an ISO 8601 timestamp.
	CreatedAt string        `json:"created_at"`
	Context   *EventContext `json:"context,omitempty"`
	// Object distinguishes the Event object.
	Object string `json:"object"`
}

type AuthenticationMagicAuthSucceededData struct {
	Type   string `json:"type"`
	Status string `json:"status"`
	// IPAddress is the IP address of the request.
	IPAddress *string `json:"ip_address"`
	// UserAgent is the user agent of the request.
	UserAgent *string `json:"user_agent"`
	// UserID is the ID of the user.
	UserID string `json:"user_id"`
	// Email is the email address of the user.
	Email string `json:"email"`
}

type AuthenticationOAuthFailed struct {
	// ID is unique identifier for the event.
	ID    string `json:"id"`
	Event string `json:"event"`
	// Data is the event payload.
	Data *AuthenticationOAuthFailedData `json:"data"`
	// CreatedAt is an ISO 8601 timestamp.
	CreatedAt string        `json:"created_at"`
	Context   *EventContext `json:"context,omitempty"`
	// Object distinguishes the Event object.
	Object string `json:"object"`
}

type AuthenticationOAuthFailedData struct {
	Type   string `json:"type"`
	Status string `json:"status"`
	// IPAddress is the IP address of the request.
	IPAddress *string `json:"ip_address"`
	// UserAgent is the user agent of the request.
	UserAgent *string `json:"user_agent"`
	// UserID is the ID of the user.
	UserID *string `json:"user_id"`
	// Email is the email address of the user.
	Email *string `json:"email"`
	// Error is details about the authentication error.
	Error *AuthenticationOAuthFailedDataError `json:"error"`
}

type AuthenticationOAuthFailedDataError = AuthenticationEmailVerificationFailedDataError

type AuthenticationOAuthSucceeded struct {
	// ID is unique identifier for the event.
	ID    string `json:"id"`
	Event string `json:"event"`
	// Data is the event payload.
	Data *AuthenticationOAuthSucceededData `json:"data"`
	// CreatedAt is an ISO 8601 timestamp.
	CreatedAt string        `json:"created_at"`
	Context   *EventContext `json:"context,omitempty"`
	// Object distinguishes the Event object.
	Object string `json:"object"`
}

type AuthenticationOAuthSucceededData struct {
	Type   string `json:"type"`
	Status string `json:"status"`
	// IPAddress is the IP address of the request.
	IPAddress *string `json:"ip_address"`
	// UserAgent is the user agent of the request.
	UserAgent *string `json:"user_agent"`
	// UserID is the ID of the user.
	UserID *string `json:"user_id"`
	// Email is the email address of the user.
	Email string `json:"email"`
}

type AuthenticationPasskeyFailed struct {
	// ID is unique identifier for the event.
	ID    string `json:"id"`
	Event string `json:"event"`
	// Data is the event payload.
	Data *AuthenticationPasskeyFailedData `json:"data"`
	// CreatedAt is an ISO 8601 timestamp.
	CreatedAt string        `json:"created_at"`
	Context   *EventContext `json:"context,omitempty"`
	// Object distinguishes the Event object.
	Object string `json:"object"`
}

type AuthenticationPasskeyFailedData struct {
	Type   string `json:"type"`
	Status string `json:"status"`
	// IPAddress is the IP address of the request.
	IPAddress *string `json:"ip_address"`
	// UserAgent is the user agent of the request.
	UserAgent *string `json:"user_agent"`
	// UserID is the ID of the user.
	UserID *string `json:"user_id"`
	// Email is the email address of the user.
	Email *string `json:"email"`
	// Error is details about the authentication error.
	Error *AuthenticationPasskeyFailedDataError `json:"error"`
}

type AuthenticationPasskeyFailedDataError = AuthenticationEmailVerificationFailedDataError

type AuthenticationPasskeySucceeded struct {
	// ID is unique identifier for the event.
	ID    string `json:"id"`
	Event string `json:"event"`
	// Data is the event payload.
	Data *AuthenticationPasskeySucceededData `json:"data"`
	// CreatedAt is an ISO 8601 timestamp.
	CreatedAt string        `json:"created_at"`
	Context   *EventContext `json:"context,omitempty"`
	// Object distinguishes the Event object.
	Object string `json:"object"`
}

type AuthenticationPasskeySucceededData struct {
	Type   string `json:"type"`
	Status string `json:"status"`
	// IPAddress is the IP address of the request.
	IPAddress *string `json:"ip_address"`
	// UserAgent is the user agent of the request.
	UserAgent *string `json:"user_agent"`
	// UserID is the ID of the user.
	UserID string `json:"user_id"`
	// Email is the email address of the user.
	Email string `json:"email"`
}

type AuthenticationPasswordFailed struct {
	// ID is unique identifier for the event.
	ID    string `json:"id"`
	Event string `json:"event"`
	// Data is the event payload.
	Data *AuthenticationPasswordFailedData `json:"data"`
	// CreatedAt is an ISO 8601 timestamp.
	CreatedAt string        `json:"created_at"`
	Context   *EventContext `json:"context,omitempty"`
	// Object distinguishes the Event object.
	Object string `json:"object"`
}

type AuthenticationPasswordFailedData struct {
	Type   string `json:"type"`
	Status string `json:"status"`
	// IPAddress is the IP address of the request.
	IPAddress *string `json:"ip_address"`
	// UserAgent is the user agent of the request.
	UserAgent *string `json:"user_agent"`
	// UserID is the ID of the user.
	UserID *string `json:"user_id"`
	// Email is the email address of the user.
	Email *string `json:"email"`
	// Error is details about the authentication error.
	Error *AuthenticationPasswordFailedDataError `json:"error"`
}

type AuthenticationPasswordFailedDataError = AuthenticationEmailVerificationFailedDataError

type AuthenticationPasswordSucceeded struct {
	// ID is unique identifier for the event.
	ID    string `json:"id"`
	Event string `json:"event"`
	// Data is the event payload.
	Data *AuthenticationPasswordSucceededData `json:"data"`
	// CreatedAt is an ISO 8601 timestamp.
	CreatedAt string        `json:"created_at"`
	Context   *EventContext `json:"context,omitempty"`
	// Object distinguishes the Event object.
	Object string `json:"object"`
}

type AuthenticationPasswordSucceededData struct {
	Type   string `json:"type"`
	Status string `json:"status"`
	// IPAddress is the IP address of the request.
	IPAddress *string `json:"ip_address"`
	// UserAgent is the user agent of the request.
	UserAgent *string `json:"user_agent"`
	// UserID is the ID of the user.
	UserID string `json:"user_id"`
	// Email is the email address of the user.
	Email string `json:"email"`
}

type AuthenticationRadarRiskDetected struct {
	// ID is unique identifier for the event.
	ID    string `json:"id"`
	Event string `json:"event"`
	// Data is the event payload.
	Data *AuthenticationRadarRiskDetectedData `json:"data"`
	// CreatedAt is an ISO 8601 timestamp.
	CreatedAt string        `json:"created_at"`
	Context   *EventContext `json:"context,omitempty"`
	// Object distinguishes the Event object.
	Object string `json:"object"`
}

type AuthenticationRadarRiskDetectedData struct {
	// AuthMethod is the authentication method used.
	AuthMethod string                                    `json:"auth_method"`
	Action     AuthenticationRadarRiskDetectedDataAction `json:"action"`
	// Control is the control action taken for the detected risk.
	Control *string `json:"control"`
	// BlocklistType is the type of blocklist that triggered the risk detection.
	BlocklistType *string `json:"blocklist_type"`
	// IPAddress is the IP address of the request.
	IPAddress *string `json:"ip_address"`
	// UserAgent is the user agent of the request.
	UserAgent *string `json:"user_agent"`
	// UserID is the ID of the user.
	UserID string `json:"user_id"`
	// Email is the email address of the user.
	Email string `json:"email"`
}

type AuthenticationRadarRiskDetectedDataAction string

type AuthenticationSSOFailed struct {
	// ID is unique identifier for the event.
	ID    string `json:"id"`
	Event string `json:"event"`
	// Data is the event payload.
	Data *AuthenticationSSOFailedData `json:"data"`
	// CreatedAt is an ISO 8601 timestamp.
	CreatedAt string        `json:"created_at"`
	Context   *EventContext `json:"context,omitempty"`
	// Object distinguishes the Event object.
	Object string `json:"object"`
}

type AuthenticationSSOFailedData struct {
	Type   string `json:"type"`
	Status string `json:"status"`
	// IPAddress is the IP address of the request.
	IPAddress *string `json:"ip_address"`
	// UserAgent is the user agent of the request.
	UserAgent *string `json:"user_agent"`
	// UserID is the ID of the user.
	UserID *string `json:"user_id"`
	// Email is the email address of the user.
	Email *string `json:"email"`
	// SSO is sso connection details.
	SSO *AuthenticationSSOFailedDataSSO `json:"sso"`
	// Error is details about the authentication error.
	Error *AuthenticationSSOFailedDataError `json:"error"`
}

type AuthenticationSSOFailedDataError = AuthenticationEmailVerificationFailedDataError

type AuthenticationSSOFailedDataSSO struct {
	// OrganizationID is the ID of the organization.
	OrganizationID *string `json:"organization_id"`
	// ConnectionID is the ID of the SSO connection.
	ConnectionID *string `json:"connection_id"`
	// SessionID is the ID of the SSO session.
	SessionID *string `json:"session_id"`
}

type AuthenticationSSOStarted struct {
	// ID is unique identifier for the event.
	ID    string `json:"id"`
	Event string `json:"event"`
	// Data is the event payload.
	Data *AuthenticationSSOStartedData `json:"data"`
	// CreatedAt is an ISO 8601 timestamp.
	CreatedAt string        `json:"created_at"`
	Context   *EventContext `json:"context,omitempty"`
	// Object distinguishes the Event object.
	Object string `json:"object"`
}

type AuthenticationSSOStartedData struct {
	Type   string `json:"type"`
	Status string `json:"status"`
	// IPAddress is the IP address of the request.
	IPAddress *string `json:"ip_address"`
	// UserAgent is the user agent of the request.
	UserAgent *string `json:"user_agent"`
	// UserID is the ID of the user.
	UserID *string `json:"user_id"`
	// Email is the email address of the user.
	Email *string `json:"email"`
	// SSO is sso connection details.
	SSO *AuthenticationSSOStartedDataSSO `json:"sso"`
}

type AuthenticationSSOStartedDataSSO = AuthenticationSSOFailedDataSSO

type AuthenticationSSOSucceeded struct {
	// ID is unique identifier for the event.
	ID    string `json:"id"`
	Event string `json:"event"`
	// Data is the event payload.
	Data *AuthenticationSSOSucceededData `json:"data"`
	// CreatedAt is an ISO 8601 timestamp.
	CreatedAt string        `json:"created_at"`
	Context   *EventContext `json:"context,omitempty"`
	// Object distinguishes the Event object.
	Object string `json:"object"`
}

type AuthenticationSSOSucceededData struct {
	Type   string `json:"type"`
	Status string `json:"status"`
	// IPAddress is the IP address of the request.
	IPAddress *string `json:"ip_address"`
	// UserAgent is the user agent of the request.
	UserAgent *string `json:"user_agent"`
	// UserID is the ID of the user.
	UserID *string `json:"user_id"`
	// Email is the email address of the user.
	Email string `json:"email"`
	// SSO is sso connection details.
	SSO *AuthenticationSSOSucceededDataSSO `json:"sso"`
}

type AuthenticationSSOSucceededDataSSO = AuthenticationSSOFailedDataSSO

type AuthenticationSSOTimedOut struct {
	// ID is unique identifier for the event.
	ID    string `json:"id"`
	Event string `json:"event"`
	// Data is the event payload.
	Data *AuthenticationSSOTimedOutData `json:"data"`
	// CreatedAt is an ISO 8601 timestamp.
	CreatedAt string        `json:"created_at"`
	Context   *EventContext `json:"context,omitempty"`
	// Object distinguishes the Event object.
	Object string `json:"object"`
}

type AuthenticationSSOTimedOutData struct {
	Type   string `json:"type"`
	Status string `json:"status"`
	// IPAddress is the IP address of the request.
	IPAddress *string `json:"ip_address"`
	// UserAgent is the user agent of the request.
	UserAgent *string `json:"user_agent"`
	// UserID is the ID of the user.
	UserID *string `json:"user_id"`
	// Email is the email address of the user.
	Email *string `json:"email"`
	// SSO is sso connection details.
	SSO *AuthenticationSSOTimedOutDataSSO `json:"sso"`
	// Error is details about the authentication error.
	Error *AuthenticationSSOTimedOutDataError `json:"error"`
}

type AuthenticationSSOTimedOutDataError = AuthenticationEmailVerificationFailedDataError

type AuthenticationSSOTimedOutDataSSO = AuthenticationSSOFailedDataSSO

type AuthorizationAddEnvironmentRolePermissionParams struct {
	// Slug is the slug of the permission to add to the role.
	Slug string `json:"slug"`
}

type AuthorizationAssignRoleParams struct {
	// RoleSlug is the slug of the role to assign.
	RoleSlug string `json:"role_slug"`
	// ResourceTarget identifies the resource target (required).
	ResourceTarget AuthorizationResourceTarget `url:"-" json:"-"`
}

type AuthorizationAssignment string

type AuthorizationCheck struct {
	// Authorized is whether the organization membership has the specified permission on the resource.
	Authorized bool `json:"authorized"`
}

type AuthorizationCheckParams struct {
	// PermissionSlug is the slug of the permission to check.
	PermissionSlug string `json:"permission_slug"`
	// ResourceTarget identifies the resource target (required).
	ResourceTarget AuthorizationResourceTarget `url:"-" json:"-"`
}

type AuthorizationCodeSessionAuthenticateRequest struct {
	// ClientID is the client ID of the application.
	ClientID string `json:"client_id"`
	// ClientSecret is the client secret of the application.
	ClientSecret string `json:"client_secret"`
	GrantType    string `json:"grant_type"`
	// Code is the authorization code received from the redirect.
	Code string `json:"code"`
	// CodeVerifier is the PKCE code verifier used to derive the code challenge passed to the authorization URL.
	CodeVerifier *string `json:"code_verifier,omitempty"`
	// InvitationToken is an invitation token to accept during authentication.
	InvitationToken *string `json:"invitation_token,omitempty"`
	// IPAddress is the IP address of the user's request.
	IPAddress *string `json:"ip_address,omitempty"`
	// DeviceID is a unique identifier for the device.
	DeviceID *string `json:"device_id,omitempty"`
	// UserAgent is the user agent string from the user's browser.
	UserAgent *string `json:"user_agent,omitempty"`
}

type AuthorizationCreateEnvironmentRoleParams struct {
	// Slug is a unique slug for the role.
	Slug string `json:"slug"`
	// Name is a descriptive name for the role.
	Name string `json:"name"`
	// Description is an optional description of the role.
	Description *string `json:"description,omitempty"`
	// ResourceTypeSlug is the slug of the resource type the role is scoped to.
	ResourceTypeSlug *string `json:"resource_type_slug,omitempty"`
}

type AuthorizationCreateOrganizationRoleParams struct {
	// Slug is a unique identifier for the role within the organization. When provided, must begin with 'org-' and contain only lowercase letters, numbers, hyphens, and underscores. When omitted, a slug is auto-generated from the role name and a random suffix.
	Slug *string `json:"slug,omitempty"`
	// Name is a descriptive name for the role.
	Name string `json:"name"`
	// Description is an optional description of the role's purpose.
	Description *string `json:"description,omitempty"`
	// ResourceTypeSlug is the slug of the resource type the role is scoped to.
	ResourceTypeSlug *string `json:"resource_type_slug,omitempty"`
}

type AuthorizationCreatePermissionParams struct {
	// Slug is a unique key to reference the permission. Must be lowercase and contain only letters, numbers, hyphens, underscores, colons, periods, and asterisks.
	Slug string `json:"slug"`
	// Name is a descriptive name for the Permission.
	Name string `json:"name"`
	// Description is an optional description of the Permission.
	Description *string `json:"description,omitempty"`
	// ResourceTypeSlug is the slug of the resource type this permission is scoped to.
	ResourceTypeSlug *string `json:"resource_type_slug,omitempty"`
}

type AuthorizationCreateResourceParams struct {
	// ExternalID is an external identifier for the resource.
	ExternalID string `json:"external_id"`
	// Name is a display name for the resource.
	Name string `json:"name"`
	// Description is an optional description of the resource.
	Description *string `json:"description,omitempty"`
	// ResourceTypeSlug is the slug of the resource type.
	ResourceTypeSlug string `json:"resource_type_slug"`
	// OrganizationID is the ID of the organization this resource belongs to.
	OrganizationID string `json:"organization_id"`
	// ParentResource optionally identifies the parent resource.
	ParentResource AuthorizationParentResource `url:"-" json:"-"`
}

type AuthorizationCreateRolePermissionParams struct {
	// Slug is the slug of the permission to add to the role.
	Slug string `json:"slug"`
}

type AuthorizationDeleteOrganizationResourceParams struct {
	// CascadeDelete is if true, deletes all descendant resources and role assignments. If not set and the resource has children or assignments, the request will fail.
	// Defaults to false.
	CascadeDelete *bool `url:"cascade_delete,omitempty" json:"-"`
}

type AuthorizationDeleteResourceParams struct {
	// CascadeDelete is if true, deletes all descendant resources and role assignments. If not set and the resource has children or assignments, the request will fail.
	// Defaults to false.
	CascadeDelete *bool `url:"cascade_delete,omitempty" json:"-"`
}

type AuthorizationListEffectivePermissionsByExternalIDParams struct {
	PaginationParams
}

type AuthorizationListMembershipsForResourceParams struct {
	PaginationParams
	// PermissionSlug is the permission slug to filter by. Only users with this permission on the resource are returned.
	PermissionSlug string `url:"permission_slug" json:"-"`
	// Assignment is filter by assignment type. Use `direct` for direct assignments only, or `indirect` to include inherited assignments.
	Assignment *AuthorizationAssignment `url:"assignment,omitempty" json:"-"`
}

type AuthorizationListOrganizationMembershipResourcesParams struct {
	PaginationParams
	// PermissionSlug is the permission slug to filter by. Only child resources where the organization membership has this permission are returned.
	PermissionSlug string `url:"permission_slug" json:"-"`
	// ParentResource identifies the parent resource (required).
	ParentResource AuthorizationParentResource `url:"-" json:"-"`
}

type AuthorizationListOrganizationMembershipRoleAssignmentsParams struct {
	PaginationParams
}

type AuthorizationListPermissionsParams struct {
	PaginationParams
}

type AuthorizationListResourceOrganizationMembershipsParams struct {
	PaginationParams
	// PermissionSlug is the permission slug to filter by. Only users with this permission on the resource are returned.
	PermissionSlug string `url:"permission_slug" json:"-"`
	// Assignment is filter by assignment type. Use "direct" for direct assignments only, or "indirect" to include inherited assignments.
	Assignment *AuthorizationAssignment `url:"assignment,omitempty" json:"-"`
}

type AuthorizationListResourcePermissionsParams struct {
	PaginationParams
}

type AuthorizationListResourcesParams struct {
	PaginationParams
	// OrganizationID is filter resources by organization ID.
	OrganizationID *string `url:"organization_id,omitempty" json:"-"`
	// ResourceTypeSlug is filter resources by resource type slug.
	ResourceTypeSlug *string `url:"resource_type_slug,omitempty" json:"-"`
	// Search is search resources by name.
	Search *string `url:"search,omitempty" json:"-"`
	// Parent optionally identifies the parent.
	Parent AuthorizationParent `url:"-" json:"-"`
}

type AuthorizationOrder = ApplicationsOrder

type AuthorizationParent interface {
	// contains filtered or unexported methods
}

type AuthorizationParentByExternalID struct {
	ResourceTypeSlug string
	ExternalID       string
}

type AuthorizationParentByID struct {
	ResourceID string
}

type AuthorizationParentResource interface {
	// contains filtered or unexported methods
}

type AuthorizationParentResourceByExternalID struct {
	TypeSlug   string
	ExternalID string
}

type AuthorizationParentResourceByID struct {
	ID string
}

type AuthorizationPermission struct {
	// Object distinguishes the Permission object.
	Object string `json:"object"`
	// ID is unique identifier of the Permission.
	ID string `json:"id"`
	// Slug is a unique key to reference the permission. Must be lowercase and contain only letters, numbers, hyphens, underscores, colons, periods, and asterisks.
	Slug string `json:"slug"`
	// Name is a descriptive name for the Permission.
	Name string `json:"name"`
	// Description is an optional description of the Permission.
	Description *string `json:"description"`
	// System is whether the permission is a system permission. System permissions are managed by WorkOS and cannot be deleted.
	System bool `json:"system"`
	// ResourceTypeSlug is the slug of the resource type associated with the permission.
	ResourceTypeSlug string `json:"resource_type_slug"`
	// CreatedAt is an ISO 8601 timestamp.
	CreatedAt string `json:"created_at"`
	// UpdatedAt is an ISO 8601 timestamp.
	UpdatedAt string `json:"updated_at"`
}

type AuthorizationRemoveRoleParams struct {
	// RoleSlug is the slug of the role to remove.
	RoleSlug string `json:"role_slug"`
	// ResourceTarget identifies the resource target (required).
	ResourceTarget AuthorizationResourceTarget `url:"-" json:"-"`
}

type AuthorizationResource struct {
	// Object distinguishes the Resource object.
	Object string `json:"object"`
	// Name is a human-readable name for the Resource.
	Name string `json:"name"`
	// Description is an optional description of the Resource.
	Description *string `json:"description"`
	// OrganizationID is the ID of the organization that owns the resource.
	OrganizationID string `json:"organization_id"`
	// ParentResourceID is the ID of the parent resource, if this resource is nested.
	ParentResourceID *string `json:"parent_resource_id"`
	// ID is the unique ID of the Resource.
	ID string `json:"id"`
	// ExternalID is an identifier you provide to reference the resource in your system.
	ExternalID string `json:"external_id"`
	// ResourceTypeSlug is the slug of the resource type this resource belongs to.
	ResourceTypeSlug string `json:"resource_type_slug"`
	// CreatedAt is an ISO 8601 timestamp.
	CreatedAt string `json:"created_at"`
	// UpdatedAt is an ISO 8601 timestamp.
	UpdatedAt string `json:"updated_at"`
}

type AuthorizationResourceTarget interface {
	// contains filtered or unexported methods
}

type AuthorizationResourceTargetByExternalID struct {
	ResourceExternalID string
	ResourceTypeSlug   string
}

type AuthorizationResourceTargetByID struct {
	ResourceID string
}

type AuthorizationService struct {
	// contains filtered or unexported fields
}

type AuthorizationSetEnvironmentRolePermissionsParams struct {
	// Permissions is the permission slugs to assign to the role.
	Permissions []string `json:"permissions"`
}

type AuthorizationUpdateEnvironmentRoleParams struct {
	// Name is a descriptive name for the role.
	Name *string `json:"name,omitempty"`
	// Description is an optional description of the role.
	Description *string `json:"description,omitempty"`
}

type AuthorizationUpdateOrganizationResourceParams struct {
	// Name is a display name for the resource.
	Name *string `json:"name,omitempty"`
	// Description is an optional description of the resource.
	Description *string `json:"description,omitempty"`
	// ParentResource optionally identifies the parent resource.
	ParentResource AuthorizationParentResource `url:"-" json:"-"`
}

type AuthorizationUpdateOrganizationRoleParams struct {
	// Name is a descriptive name for the role.
	Name *string `json:"name,omitempty"`
	// Description is an optional description of the role's purpose.
	Description *string `json:"description,omitempty"`
}

type AuthorizationUpdatePermissionParams struct {
	// Name is a descriptive name for the Permission.
	Name *string `json:"name,omitempty"`
	// Description is an optional description of the Permission.
	Description *string `json:"description,omitempty"`
}

type AuthorizationUpdateResourceParams struct {
	// Name is a display name for the resource.
	Name *string `json:"name,omitempty"`
	// Description is an optional description of the resource.
	Description *string `json:"description,omitempty"`
	// ParentResource optionally identifies the parent resource.
	ParentResource AuthorizationParentResource `url:"-" json:"-"`
}

type AuthorizationUpdateRolePermissionsParams struct {
	// Permissions is the permission slugs to assign to the role.
	Permissions []string `json:"permissions"`
}

type AuthorizedConnectApplicationListData struct {
	// Object distinguishes the authorized connect application object.
	Object string `json:"object"`
	// ID is the unique ID of the authorized connect application.
	ID string `json:"id"`
	// GrantedScopes is the scopes granted by the user to the application.
	GrantedScopes []string `json:"granted_scopes"`
	// OAuthResource is the OAuth resource associated with the authorized connect application, if one was requested.
	OAuthResource *string             `json:"oauth_resource,omitempty"`
	Application   *ConnectApplication `json:"application"`
}

type CORSOriginResponse struct {
	// Object distinguishes the CORS origin object.
	Object string `json:"object"`
	// ID is unique identifier of the CORS origin.
	ID string `json:"id"`
	// Origin is the origin URL.
	Origin string `json:"origin"`
	// CreatedAt is timestamp when the CORS origin was created.
	CreatedAt string `json:"created_at"`
	// UpdatedAt is timestamp when the CORS origin was last updated.
	UpdatedAt string `json:"updated_at"`
}

type ChallengeAuthenticationFactor struct {
	// SmsTemplate is a custom template for the SMS message. Use the {{code}} placeholder to include the verification code.
	SmsTemplate *string `json:"sms_template,omitempty"`
}

type CheckAuthorization struct {
	// PermissionSlug is the slug of the permission to check.
	PermissionSlug string `json:"permission_slug"`
	// ResourceID is the ID of the resource. Mutually exclusive with `resource_external_id` and `resource_type_slug`.
	ResourceID *string `json:"resource_id,omitempty"`
	// ResourceExternalID is the external ID of the resource. Required with `resource_type_slug`. Mutually exclusive with `resource_id`.
	ResourceExternalID *string `json:"resource_external_id,omitempty"`
	// ResourceTypeSlug is the slug of the resource type. Required with `resource_external_id`. Mutually exclusive with `resource_id`.
	ResourceTypeSlug *string `json:"resource_type_slug,omitempty"`
}

type Client struct {
	// contains filtered or unexported fields
}

type ClientOption func(*Client)

type ConfirmEmailChange = AuthenticationChallengesVerifyRequest

type ConnectApplication struct {
	// Object distinguishes the connect application object.
	Object string `json:"object"`
	// ID is the unique ID of the connect application.
	ID string `json:"id"`
	// ClientID is the client ID of the connect application.
	ClientID string `json:"client_id"`
	// Description is a description of the connect application.
	Description *string `json:"description"`
	// Name is the name of the connect application.
	Name string `json:"name"`
	// Scopes is the scopes available for this application.
	Scopes []string `json:"scopes"`
	// CreatedAt is an ISO 8601 timestamp.
	CreatedAt string `json:"created_at"`
	// UpdatedAt is an ISO 8601 timestamp.
	UpdatedAt string `json:"updated_at"`
	// ApplicationType is the type of the application.
	ApplicationType *string `json:"application_type,omitempty"`
	// OrganizationID is the ID of the organization the application belongs to.
	OrganizationID *string `json:"organization_id,omitempty"`
	// RedirectURIs is the redirect URIs configured for this application.
	RedirectURIs []*ConnectApplicationRedirectURI `json:"redirect_uris,omitempty"`
	// UsesPKCE is whether the application uses PKCE for authorization.
	UsesPKCE *bool `json:"uses_pkce,omitempty"`
	// IsFirstParty is whether the application is a first-party application.
	IsFirstParty *bool `json:"is_first_party,omitempty"`
	// WasDynamicallyRegistered is whether the application was dynamically registered.
	WasDynamicallyRegistered *bool `json:"was_dynamically_registered,omitempty"`
}

type ConnectApplicationRedirectURI struct {
	// URI is the redirect URI for the application.
	URI string `json:"uri"`
	// Default is whether this is the default redirect URI.
	Default bool `json:"default"`
}

type ConnectCompleteOAuth2Params struct {
	// ExternalAuthID is identifier provided when AuthKit redirected to your login page.
	ExternalAuthID string `json:"external_auth_id"`
	// User is the user to create or update in AuthKit.
	User *UserObject `json:"user"`
	// UserConsentOptions is array of [User Consent Options](https://workos.com/docs/reference/workos-connect/standalone/user-consent-options) to store with the session.
	UserConsentOptions []*UserConsentOption `json:"user_consent_options,omitempty"`
}

type ConnectCreateM2MApplicationParams struct {
	// Name is the name of the application.
	Name string `json:"name"`
	// OrganizationID is the organization ID this application belongs to.
	OrganizationID string `json:"organization_id"`
	// Description is a description for the application.
	Description *string `json:"description,omitempty"`
	// Scopes is the OAuth scopes granted to the application.
	Scopes []string `json:"scopes,omitempty"`
}

type ConnectCreateOAuthApplicationParams struct {
	// Name is the name of the application.
	Name string `json:"name"`
	// IsFirstParty is whether this is a first-party application. Third-party applications require an organization_id.
	IsFirstParty bool `json:"is_first_party"`
	// Description is a description for the application.
	Description *string `json:"description,omitempty"`
	// Scopes is the OAuth scopes granted to the application.
	Scopes []string `json:"scopes,omitempty"`
	// RedirectURIs is redirect URIs for the application.
	RedirectURIs []*RedirectURIInput `json:"redirect_uris,omitempty"`
	// UsesPKCE is whether the application uses PKCE (Proof Key for Code Exchange).
	UsesPKCE *bool `json:"uses_pkce,omitempty"`
	// OrganizationID is the organization ID this application belongs to. Required when is_first_party is false.
	OrganizationID *string `json:"organization_id,omitempty"`
}

type ConnectListApplicationsParams struct {
	PaginationParams
	// OrganizationID is filter Connect Applications by organization ID.
	OrganizationID *string `url:"organization_id,omitempty" json:"-"`
}

type ConnectService struct {
	// contains filtered or unexported fields
}