WorkOS · JSON Structure
Workos Structure
Structural overview of the WorkOS API surface; extracted from openapi/.
Type:
Properties: 0
AuthenticationIdentity ProviderSSOSAMLOIDCSCIMDirectory SyncAuthorizationFGAAudit LogsMFAB2B SaaSAgentsMCP
Workos Structure is a JSON Structure definition published by WorkOS.
Meta-schema:
JSON Structure
{
"provider": "WorkOS",
"providerId": "workos",
"kind": "json-structure",
"description": "Structural overview of the WorkOS API surface; extracted from openapi/.",
"schemaCount": 159,
"operationCount": 172,
"schemas": [
{
"name": "UserObject",
"type": "object",
"propertyCount": 5,
"required": [
"id",
"email"
]
},
{
"name": "UserConsentOption",
"type": "object",
"propertyCount": 4,
"required": [
"claim",
"type",
"label",
"choices"
]
},
{
"name": "UserManagementLoginRequest",
"type": "object",
"propertyCount": 3,
"required": [
"external_auth_id",
"user"
]
},
{
"name": "ValidateApiKeyDto",
"type": "object",
"propertyCount": 1,
"required": [
"value"
]
},
{
"name": "PaginationOrder",
"type": "string",
"propertyCount": 0,
"required": []
},
{
"name": "RedirectUriDto",
"type": "object",
"propertyCount": 2,
"required": [
"uri"
]
},
{
"name": "CreateOAuthApplicationDto",
"type": "object",
"propertyCount": 8,
"required": [
"name",
"application_type",
"is_first_party"
]
},
{
"name": "CreateM2MApplicationDto",
"type": "object",
"propertyCount": 5,
"required": [
"name",
"application_type",
"organization_id"
]
},
{
"name": "UpdateOAuthApplicationDto",
"type": "object",
"propertyCount": 4,
"required": []
},
{
"name": "CreateApplicationSecretDto",
"type": "object",
"propertyCount": 0,
"required": []
},
{
"name": "AuditLogEventActorDto",
"type": "object",
"propertyCount": 4,
"required": [
"id",
"type"
]
},
{
"name": "AuditLogEventTargetDto",
"type": "object",
"propertyCount": 4,
"required": [
"id",
"type"
]
},
{
"name": "AuditLogEventContextDto",
"type": "object",
"propertyCount": 2,
"required": [
"location"
]
},
{
"name": "AuditLogEventDto",
"type": "object",
"propertyCount": 7,
"required": [
"action",
"occurred_at",
"actor",
"targets",
"context"
]
},
{
"name": "AuditLogEventIngestionDto",
"type": "object",
"propertyCount": 2,
"required": [
"organization_id",
"event"
]
},
{
"name": "AuditLogExportCreationDto",
"type": "object",
"propertyCount": 8,
"required": [
"organization_id",
"range_start",
"range_end"
]
},
{
"name": "UpdateAuditLogsRetentionDto",
"type": "object",
"propertyCount": 1,
"required": [
"retention_period_in_days"
]
},
{
"name": "AuditLogSchemaActorDto",
"type": "object",
"propertyCount": 1,
"required": [
"metadata"
]
},
{
"name": "AuditLogSchemaTargetDto",
"type": "object",
"propertyCount": 2,
"required": [
"type"
]
},
{
"name": "AuditLogSchemaDto",
"type": "object",
"propertyCount": 3,
"required": [
"targets"
]
},
{
"name": "ChallengeAuthenticationFactorDto",
"type": "object",
"propertyCount": 1,
"required": []
},
{
"name": "CheckAuthorizationDto",
"type": null,
"propertyCount": 0,
"required": []
},
{
"name": "AssignRoleDto",
"type": null,
"propertyCount": 0,
"required": []
},
{
"name": "RemoveRoleDto",
"type": null,
"propertyCount": 0,
"required": []
},
{
"name": "SetRolePermissionsDto",
"type": "object",
"propertyCount": 1,
"required": [
"permissions"
]
},
{
"name": "AddRolePermissionDto",
"type": "object",
"propertyCount": 1,
"required": [
"slug"
]
},
{
"name": "CreateOrganizationRoleDto",
"type": "object",
"propertyCount": 4,
"required": [
"name"
]
},
{
"name": "UpdateOrganizationRoleDto",
"type": "object",
"propertyCount": 2,
"required": []
},
{
"name": "CreateAuthorizationPermissionDto",
"type": "object",
"propertyCount": 4,
"required": [
"slug",
"name"
]
},
{
"name": "UpdateAuthorizationPermissionDto",
"type": "object",
"propertyCount": 2,
"required": []
},
{
"name": "CreateRoleDto",
"type": "object",
"propertyCount": 4,
"required": [
"slug",
"name"
]
},
{
"name": "UpdateRoleDto",
"type": "object",
"propertyCount": 2,
"required": []
},
{
"name": "UpdateAuthorizationResourceDto",
"type": null,
"propertyCount": 0,
"required": []
},
{
"name": "CreateAuthorizationResourceDto",
"type": null,
"propertyCount": 0,
"required": []
},
{
"name": "CreateCorsOriginDto",
"type": "object",
"propertyCount": 1,
"required": [
"origin"
]
},
{
"name": "CreateGroupMembershipDto",
"type": "object",
"propertyCount": 1,
"required": [
"organization_membership_id"
]
},
{
"name": "CreateGroupDto",
"type": "object",
"propertyCount": 2,
"required": [
"name"
]
},
{
"name": "UpdateGroupDto",
"type": "object",
"propertyCount": 2,
"required": []
},
{
"name": "UpdateJwtTemplateDto",
"type": "object",
"propertyCount": 1,
"required": [
"content"
]
},
{
"name": "CreateOrganizationDomainDto",
"type": "object",
"propertyCount": 2,
"required": [
"domain",
"organization_id"
]
},
{
"name": "CreateOrganizationApiKeyDto",
"type": "object",
"propertyCount": 2,
"required": [
"name"
]
},
{
"name": "OrganizationDomainDataDto",
"type": "object",
"propertyCount": 2,
"required": [
"domain",
"state"
]
},
{
"name": "OrganizationDto",
"type": "object",
"propertyCount": 6,
"required": [
"name"
]
},
{
"name": "UpdateOrganizationDto",
"type": "object",
"propertyCount": 7,
"required": []
},
{
"name": "SsoIntentOptions",
"type": "object",
"propertyCount": 2,
"required": []
},
{
"name": "DomainVerificationIntentOptions",
"type": "object",
"propertyCount": 1,
"required": []
},
{
"name": "IntentOptions",
"type": "object",
"propertyCount": 2,
"required": []
},
{
"name": "GenerateLinkDto",
"type": "object",
"propertyCount": 6,
"required": [
"organization"
]
},
{
"name": "CreateRedirectUriDto",
"type": "object",
"propertyCount": 1,
"required": [
"uri"
]
},
{
"name": "EnrollUserlandUserAuthenticationFactorDto",
"type": "object",
"propertyCount": 4,
"required": [
"type"
]
},
{
"name": "CreateUserlandMagicCodeAndReturnDto",
"type": "object",
"propertyCount": 2,
"required": [
"email"
]
},
{
"name": "CreateUserlandUserInviteOptionsDto",
"type": "object",
"propertyCount": 6,
"required": [
"email"
]
},
{
"name": "ResendUserlandUserInviteOptionsDto",
"type": "object",
"propertyCount": 1,
"required": []
},
{
"name": "CreateUserlandUserOrganizationMembershipDto",
"type": null,
"propertyCount": 0,
"required": []
},
{
"name": "UpdateUserlandUserOrganizationMembershipDto",
"type": null,
"propertyCount": 0,
"required": []
},
{
"name": "CreateUserApiKeyDto",
"type": "object",
"propertyCount": 3,
"required": [
"name",
"organization_id"
]
},
{
"name": "CreateUserlandUserDto",
"type": null,
"propertyCount": 0,
"required": []
},
{
"name": "UpdateUserlandUserDto",
"type": null,
"propertyCount": 0,
"required": []
},
{
"name": "VerifyEmailAddressDto",
"type": "object",
"propertyCount": 1,
"required": [
"code"
]
},
{
"name": "CreatePasswordResetTokenDto",
"type": "object",
"propertyCount": 1,
"required": [
"email"
]
},
{
"name": "CreatePasswordResetDto",
"type": "object",
"propertyCount": 2,
"required": [
"token",
"new_password"
]
},
{
"name": "SendEmailChangeDto",
"type": "object",
"propertyCount": 1,
"required": [
"new_email"
]
},
{
"name": "ConfirmEmailChangeDto",
"type": "object",
"propertyCount": 1,
"required": [
"code"
]
},
{
"name": "UserlandRevokeSessionDto",
"type": "object",
"propertyCount": 2,
"required": [
"session_id"
]
},
{
"name": "CreateWebhookEndpointDto",
"type": "object",
"propertyCount": 2,
"required": [
"endpoint_url",
"events"
]
},
{
"name": "UpdateWebhookEndpointDto",
"type": "object",
"propertyCount": 3,
"required": []
},
{
"name": "WidgetSessionTokenDto",
"type": "object",
"propertyCount": 3,
"required": [
"organization_id"
]
},
{
"name": "TokenQueryDto",
"type": "object",
"propertyCount": 4,
"required": [
"client_id",
"client_secret",
"code",
"grant_type"
]
},
{
"name": "ExternalAuthCompleteResponse",
"type": "object",
"propertyCount": 1,
"required": [
"redirect_uri"
]
},
{
"name": "ApiKey",
"type": "object",
"propertyCount": 9,
"required": [
"object",
"id",
"owner",
"name",
"obfuscated_value",
"last_used_at",
"permissions",
"created_at",
"updated_at"
]
},
{
"name": "ApiKeyValidationResponse",
"type": "object",
"propertyCount": 1,
"required": [
"api_key"
]
},
{
"name": "ConnectApplication",
"type": null,
"propertyCount": 0,
"required": []
},
{
"name": "ConnectApplicationList",
"type": "object",
"propertyCount": 3,
"required": [
"object",
"data",
"list_metadata"
]
},
{
"name": "AuthorizedConnectApplicationList",
"type": "object",
"propertyCount": 3,
"required": [
"object",
"data",
"list_metadata"
]
},
{
"name": "NewConnectApplicationSecret",
"type": "object",
"propertyCount": 7,
"required": [
"object",
"id",
"secret_hint",
"last_used_at",
"created_at",
"updated_at",
"secret"
]
},
{
"name": "AuditLogEventCreateResponse",
"type": "object",
"propertyCount": 1,
"required": [
"success"
]
},
{
"name": "AuditLogExportJson",
"type": "object",
"propertyCount": 6,
"required": [
"object",
"id",
"state",
"created_at",
"updated_at"
]
},
{
"name": "AuditLogsRetentionJson",
"type": "object",
"propertyCount": 1,
"required": [
"retention_period_in_days"
]
},
{
"name": "AuditLogSchemaJson",
"type": "object",
"propertyCount": 6,
"required": [
"object",
"version",
"targets",
"created_at"
]
},
{
"name": "AuditLogActionJson",
"type": "object",
"propertyCount": 5,
"required": [
"object",
"name",
"schema",
"created_at",
"updated_at"
]
},
{
"name": "AuthenticationChallenge",
"type": "object",
"propertyCount": 7,
"required": [
"object",
"id",
"authentication_factor_id",
"created_at",
"updated_at"
]
},
{
"name": "AuthenticationChallengeVerifyResponse",
"type": "object",
"propertyCount": 2,
"required": [
"challenge",
"valid"
]
},
{
"name": "AuthenticationFactorEnrolled",
"type": "object",
"propertyCount": 8,
"required": [
"object",
"id",
"type",
"created_at",
"updated_at"
]
},
{
"name": "AuthenticationFactor",
"type": "object",
"propertyCount": 8,
"required": [
"object",
"id",
"type",
"created_at",
"updated_at"
]
},
{
"name": "AuthorizationCheck",
"type": "object",
"propertyCount": 1,
"required": [
"authorized"
]
},
{
"name": "AuthorizationResource",
"type": "object",
"propertyCount": 10,
"required": [
"object",
"name",
"description",
"organization_id",
"parent_resource_id",
"id",
"external_id",
"resource_type_slug",
"created_at",
"updated_at"
]
},
{
"name": "AuthorizationResourceList",
"type": "object",
"propertyCount": 3,
"required": [
"object",
"data",
"list_metadata"
]
},
{
"name": "AuthorizationPermission",
"type": "object",
"propertyCount": 9,
"required": [
"object",
"id",
"slug",
"name",
"description",
"system",
"resource_type_slug",
"created_at",
"updated_at"
]
},
{
"name": "AuthorizationPermissionList",
"type": "object",
"propertyCount": 3,
"required": [
"object",
"data",
"list_metadata"
]
},
{
"name": "SlimRole",
"type": "object",
"propertyCount": 1,
"required": [
"slug"
]
},
{
"name": "UserRoleAssignment",
"type": "object",
"propertyCount": 7,
"required": [
"object",
"id",
"organization_membership_id",
"role",
"resource",
"created_at",
"updated_at"
]
},
{
"name": "UserRoleAssignmentList",
"type": "object",
"propertyCount": 3,
"required": [
"object",
"data",
"list_metadata"
]
},
{
"name": "Role",
"type": "object",
"propertyCount": 10,
"required": [
"slug",
"object",
"id",
"name",
"description",
"type",
"resource_type_slug",
"permissions",
"created_at",
"updated_at"
]
},
{
"name": "RoleList",
"type": "object",
"propertyCount": 2,
"required": [
"object",
"data"
]
},
{
"name": "UserlandUser",
"type": "object",
"propertyCount": 13,
"required": [
"object",
"id",
"first_name",
"last_name",
"profile_picture_url",
"email",
"email_verified",
"external_id",
"last_sign_in_at",
"created_at",
"updated_at"
]
},
{
"name": "UserlandUserOrganizationMembershipBaseWithUser",
"type": "object",
"propertyCount": 11,
"required": [
"object",
"id",
"user_id",
"organization_id",
"status",
"directory_managed",
"created_at",
"updated_at",
"user"
]
},
{
"name": "UserlandUserOrganizationMembershipBaseWithUserList",
"type": "object",
"propertyCount": 3,
"required": [
"object",
"data",
"list_metadata"
]
},
{
"name": "Connection",
"type": "object",
"propertyCount": 11,
"required": [
"object",
"id",
"connection_type",
"name",
"state",
"status",
"domains",
"created_at",
"updated_at"
]
},
{
"name": "ConnectionList",
"type": "object",
"propertyCount": 3,
"required": [
"object",
"data",
"list_metadata",
"list_metadata"
]
},
{
"name": "CorsOriginResponse",
"type": "object",
"propertyCount": 5,
"required": [
"object",
"id",
"origin",
"created_at",
"updated_at"
]
},
{
"name": "Directory",
"type": "object",
"propertyCount": 11,
"required": [
"object",
"id",
"organization_id",
"external_key",
"type",
"state",
"name",
"created_at",
"updated_at"
]
},
{
"name": "DirectoryList",
"type": "object",
"propertyCount": 3,
"required": [
"object",
"data",
"list_metadata",
"list_metadata"
]
},
{
"name": "DirectoryGroup",
"type": "object",
"propertyCount": 9,
"required": [
"object",
"id",
"idp_id",
"directory_id",
"organization_id",
"name",
"created_at",
"updated_at"
]
},
{
"name": "DirectoryGroupList",
"type": "object",
"propertyCount": 3,
"required": [
"object",
"data",
"list_metadata",
"list_metadata"
]
},
{
"name": "DirectoryUserWithGroups",
"type": "object",
"propertyCount": 20,
"required": [
"object",
"id",
"directory_id",
"organization_id",
"idp_id",
"email",
"state",
"raw_attributes",
"custom_attributes",
"created_at",
"updated_at",
"groups"
]
},
{
"name": "DirectoryUserList",
"type": "object",
"propertyCount": 3,
"required": [
"object",
"data",
"list_metadata",
"list_metadata"
]
},
{
"name": "UserlandUserOrganizationMembershipBaseList",
"type": "object",
"propertyCount": 3,
"required": [
"object",
"data",
"list_metadata"
]
},
{
"name": "Group",
"type": "object",
"propertyCount": 7,
"required": [
"object",
"id",
"organization_id",
"name",
"description",
"created_at",
"updated_at"
]
},
{
"name": "GroupList",
"type": "object",
"propertyCount": 3,
"required": [
"object",
"data",
"list_metadata"
]
},
{
"name": "EventContextActorDto",
"type": "object",
"propertyCount": 3,
"required": [
"id",
"source",
"name"
]
},
{
"name": "EventContextDto",
"type": "object",
"propertyCount": 6,
"required": []
},
{
"name": "DirectoryUser",
"type": "object",
"propertyCount": 19,
"required": [
"object",
"id",
"directory_id",
"organization_id",
"idp_id",
"email",
"state",
"raw_attributes",
"custom_attributes",
"created_at",
"updated_at"
]
},
{
"name": "VaultByokKeyProvider",
"type": "string",
"propertyCount": 0,
"required": []
},
{
"name": "WaitlistUser",
"type": "object",
"propertyCount": 7,
"required": [
"object",
"id",
"email",
"state",
"approved_at",
"created_at",
"updated_at"
]
},
{
"name": "EventSchema",
"type": null,
"propertyCount": 0,
"required": []
},
{
"name": "EventList",
"type": "object",
"propertyCount": 3,
"required": [
"object",
"data",
"list_metadata"
]
},
{
"name": "JwtTemplate",
"type": "object",
"propertyCount": 4,
"required": [
"object",
"content",
"created_at",
"updated_at"
]
},
{
"name": "OrganizationDomainStandAlone",
"type": "object",
"propertyCount": 10,
"required": [
"object",
"id",
"organization_id",
"domain",
"created_at",
"updated_at"
]
},
{
"name": "Flag",
"type": "object",
"propertyCount": 11,
"required": [
"object",
"id",
"slug",
"name",
"description",
"owner",
"tags",
"enabled",
"default_value",
"created_at",
"updated_at"
]
},
{
"name": "FlagList",
"type": "object",
"propertyCount": 3,
"required": [
"object",
"data",
"list_metadata"
]
},
{
"name": "OrganizationApiKey",
"type": "object",
"propertyCount": 9,
"required": [
"object",
"id",
"owner",
"name",
"obfuscated_value",
"last_used_at",
"permissions",
"created_at",
"updated_at"
]
},
{
"name": "OrganizationApiKeyList",
"type": "object",
"propertyCount": 3,
"required": [
"object",
"data",
"list_metadata"
]
},
{
"name": "OrganizationApiKeyWithValue",
"type": "object",
"propertyCount": 10,
"required": [
"object",
"id",
"owner",
"name",
"obfuscated_value",
"last_used_at",
"permissions",
"created_at",
"updated_at",
"value"
]
},
{
"name": "Organization",
"type": "object",
"propertyCount": 10,
"required": [
"object",
"id",
"name",
"domains",
"metadata",
"external_id",
"created_at",
"updated_at"
]
},
{
"name": "OrganizationList",
"type": "object",
"propertyCount": 3,
"required": [
"object",
"data",
"list_metadata",
"list_metadata"
]
},
{
"name": "AuditLogConfiguration",
"type": "object",
"propertyCount": 4,
"required": [
"organization_id",
"retention_period_in_days",
"state"
]
},
{
"name": "DataIntegrationAuthorizeUrlResponse",
"type": "object",
"propertyCount": 1,
"required": [
"url"
]
},
{
"name": "DataIntegrationAccessTokenResponse",
"type": null,
"propertyCount": 0,
"required": []
},
{
"name": "ConnectedAccount",
"type": "object",
"propertyCount": 8,
"required": [
"object",
"id",
"user_id",
"organization_id",
"scopes",
"state",
"created_at",
"updated_at"
]
},
{
"name": "DataIntegrationsListResponse",
"type": "object",
"propertyCount": 2,
"required": [
"object",
"data"
]
},
{
"name": "PortalLinkResponse",
"type": "object",
"propertyCount": 1,
"required": [
"link"
]
},
{
"name": "RadarStandaloneResponse",
"type": "object",
"propertyCount": 5,
"required": [
"verdict",
"reason",
"attempt_id"
]
},
{
"name": "RadarListEntryAlreadyPresentResponse",
"type": "object",
"propertyCount": 1,
"required": [
"message"
]
},
{
"name": "RedirectUri",
"type": "object",
"propertyCount": 6,
"required": [
"object",
"id",
"uri",
"default",
"created_at",
"updated_at"
]
},
{
"name": "UserlandUserAuthenticationFactorList",
"type": "object",
"propertyCount": 3,
"required": [
"object",
"data",
"list_metadata"
]
},
{
"name": "UserlandUserAuthenticationFactorEnrollResponse",
"type": "object",
"propertyCount": 2,
"required": [
"authentication_factor",
"authentication_challenge"
]
},
{
"name": "MagicAuth",
"type": "object",
"propertyCount": 8,
"required": [
"object",
"id",
"user_id",
"email",
"expires_at",
"created_at",
"updated_at",
"code"
]
},
{
"name": "UserlandUserInvite",
"type": "object",
"propertyCount": 15,
"required": [
"object",
"id",
"email",
"state",
"accepted_at",
"revoked_at",
"expires_at",
"organization_id",
"inviter_user_id",
"accepted_user_id",
"role_slug",
"created_at",
"updated_at",
"token",
"accept_invitation_url"
]
},
{
"name": "UserlandUserOrganizationMembership",
"type": "object",
"propertyCount": 12,
"required": [
"object",
"id",
"user_id",
"organization_id",
"status",
"directory_managed",
"created_at",
"updated_at",
"role",
"user"
]
},
{
"name": "UserApiKey",
"type": "object",
"propertyCount": 9,
"required": [
"object",
"id",
"owner",
"name",
"obfuscated_value",
"last_used_at",
"permissions",
"created_at",
"updated_at"
]
},
{
"name": "UserApiKeyList",
"type": "object",
"propertyCount": 3,
"required": [
"object",
"data",
"list_metadata"
]
},
{
"name": "UserApiKeyWithValue",
"type": "object",
"propertyCount": 10,
"required": [
"object",
"id",
"owner",
"name",
"obfuscated_value",
"last_used_at",
"permissions",
"created_at",
"updated_at",
"value"
]
},
{
"name": "UserlandUserList",
"type": "object",
"propertyCount": 3,
"required": [
"object",
"data",
"list_metadata"
]
},
{
"name": "EmailVerification",
"type": "object",
"propertyCount": 8,
"required": [
"object",
"id",
"user_id",
"email",
"expires_at",
"created_at",
"updated_at",
"code"
]
},
{
"name": "SendVerificationEmailResponse",
"type": "object",
"propertyCount": 1,
"required": [
"user"
]
},
{
"name": "VerifyEmailResponse",
"type": "object",
"propertyCount": 1,
"required": [
"user"
]
},
{
"name": "PasswordReset",
"type": "object",
"propertyCount": 8,
"required": [
"object",
"id",
"user_id",
"email",
"expires_at",
"created_at",
"password_reset_token",
"password_reset_url"
]
},
{
"name": "ResetPasswordResponse",
"type": "object",
"propertyCount": 1,
"required": [
"user"
]
},
{
"name": "EmailChange",
"type": "object",
"propertyCount": 5,
"required": [
"object",
"user",
"new_email",
"expires_at",
"created_at"
]
},
{
"name": "UserlandAuthenticateResponse",
"type": "object",
"propertyCount": 8,
"required": [
"user",
"access_token",
"refresh_token"
]
},
{
"name": "DeviceAuthorizationResponse",
"type": "object",
"propertyCount": 6,
"required": [
"device_code",
"user_code",
"verification_uri",
"expires_in"
]
},
{
"name": "WebhookEndpointJson",
"type": "object",
"propertyCount": 8,
"required": [
"object",
"id",
"endpoint_url",
"secret",
"status",
"events",
"created_at",
"updated_at"
]
},
{
"name": "WebhookEndpointList",
"type": "object",
"propertyCount": 3,
"required": [
"object",
"data",
"list_metadata"
]
},
{
"name": "WidgetSessionTokenResponse",
"type": "object",
"propertyCount": 1,
"required": [
"token"
]
},
{
"name": "SsoAuthorizeUrlResponse",
"type": "object",
"propertyCount": 1,
"required": [
"url"
]
},
{
"name": "Profile",
"type": "object",
"propertyCount": 15,
"required": [
"object",
"id",
"organization_id",
"connection_id",
"connection_type",
"idp_id",
"email",
"first_name",
"last_name",
"name",
"raw_attributes"
]
},
{
"name": "SsoTokenResponse",
"type": "object",
"propertyCount": 5,
"required": [
"token_type",
"access_token",
"expires_in",
"profile"
]
},
{
"name": "SsoLogoutAuthorizeResponse",
"type": "object",
"propertyCount": 2,
"required": [
"logout_url",
"logout_token"
]
},
{
"name": "JwksResponse",
"type": "object",
"propertyCount": 1,
"required": [
"keys"
]
}
],
"operations": [
{
"method": "POST",
"path": "/api_keys/validations",
"operationId": "ApiKeysController_validateApiKey",
"summary": "Validate API Key",
"tags": [
"api_keys"
]
},
{
"method": "DELETE",
"path": "/api_keys/{id}",
"operationId": "ApiKeysController_delete",
"summary": "Delete an API Key",
"tags": [
"api_keys"
]
},
{
"method": "GET",
"path": "/audit_logs/actions",
"operationId": "AuditLogValidatorsController_list",
"summary": "List Actions",
"tags": [
"audit-logs"
]
},
{
"method": "GET",
"path": "/audit_logs/actions/{actionName}/schemas",
"operationId": "AuditLogValidatorVersionsController_schemas",
"summary": "List Schemas",
"tags": [
"audit-logs"
]
},
{
"method": "POST",
"path": "/audit_logs/actions/{actionName}/schemas",
"operationId": "AuditLogValidatorVersionsController_create",
"summary": "Create Schema",
"tags": [
"audit-logs"
]
},
{
"method": "POST",
"path": "/audit_logs/events",
"operationId": "AuditLogEventsController_create",
"summary": "Create Event",
"tags": [
"audit-logs"
]
},
{
"method": "POST",
"path": "/audit_logs/exports",
"operationId": "AuditLogExportsController_exports",
"summary": "Create Export",
"tags": [
"audit-logs"
]
},
{
"method": "GET",
"path": "/audit_logs/exports/{auditLogExportId}",
"operationId": "AuditLogExportsController_export",
"summary": "Get Export",
"tags": [
"audit-logs"
]
},
{
"method": "POST",
"path": "/auth/challenges/{id}/verify",
"operationId": "AuthenticationChallengesController_verify",
"summary": "Verify Challenge",
"tags": [
"multi-factor-
# --- truncated at 32 KB (72 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/workos/refs/heads/main/json-structure/workos-structure.json