QR Platform API V1

{
  // User email address
  email: string
  // User password (optional for passwordless)
  password?: string
  // Name of the initial organization
  organizationName?: string
  // Description of the organization
  organizationDescription?: string
  // Redirect URL of the organization
  organizationRedirectUrl?: string
}

{
  // Indicates if passwordless registration was used
  passwordless?: boolean
  // Indicates if a verification email was sent
  emailSent?: boolean
  // Informational message
  message?: string
  // ID of the created organization
  orgId?: string
  // Name of the organization
  organizationName?: string
  // Redirect URL of the organization
  organizationRedirectUrl?: string
  // Description of the organization
  organizationDescription?: string
}

// Bad Request on registration
anyOf: [
  {"$ref":"ValidationErrorMessage"},
  {"$ref":"EmailAlreadyInUseMessage"},
  {"$ref":"EmailSendFailureMessage"},
  {"$ref":"OrganizationCreationFailureMessage"}
]

{
  // User email address (optional)
  email?: string
  // 6-digit verification code (for email/MFA)
  code?: string
  // Verification token (for email links)
  token?: string
  // User password (if setting during verification)
  password?: string
}

{
  // JWT access token upon successful registration verification
  access_token?: string
}

// Bad Request on registration verification
anyOf: [
  {"$ref":"ValidationErrorMessage"},
  {"$ref":"EmailAlreadyVerifiedMessage"}
]

// Unauthorized response message
{
  message: string
}

// User or organization not found
anyOf: [
  {"$ref":"UserNotFoundMessage"},
  {"$ref":"OrganizationNotFoundMessage"}
]

{
  // User email address
  email: string
  // User password (optional for passwordless)
  password?: string
  // Name of the initial organization
  organizationName?: string
  // Description of the organization
  organizationDescription?: string
  // Redirect URL of the organization
  organizationRedirectUrl?: string
}

{
  // Indicates if the verification email was resent
  emailSent?: boolean
}

// Bad Request on resending registration verification
anyOf: [
  {"$ref":"ValidationErrorMessage"},
  {"$ref":"InvalidCredentialsForOperationMessage"},
  {"$ref":"EmailAlreadyVerifiedMessage"},
  {"$ref":"EmailSendFailureMessage"}
]

// User or organization not found
anyOf: [
  {"$ref":"UserNotFoundMessage"},
  {"$ref":"OrganizationNotFoundMessage"}
]

{
  // User email address
  email: string
  // User password (optional for passwordless)
  password?: string
}

{
  // JWT access token (if password provided)
  access_token?: string
  // Indicates if passwordless sign-in is required
  passwordless?: boolean
  // Indicates if a sign-in verification email was sent
  emailSent?: boolean
  // Details of the organization the user signed into
  organization?: {
    // Unique identifier for the organization
    id: string
    // Name of the organization
    name?: string
  }
}

// Bad Request on sign-in
anyOf: [
  {"$ref":"ValidationErrorMessage"},
  {"$ref":"EmailSendFailureMessage"}
]

// Unauthorized response message
{
  message: string
}

// User or organization not found
anyOf: [
  {"$ref":"UserNotFoundMessage"},
  {"$ref":"OrganizationNotFoundMessage"}
]

{
  // User email address (optional)
  email?: string
  // 6-digit verification code (for email/MFA)
  code?: string
  // Verification token (for email links)
  token?: string
  // User password (if setting during verification)
  password?: string
}

{
  // JWT access token upon successful sign-in verification
  access_token?: string
}

// Error response for validation failures
{
  message: string
  errors?: []
}

// Unauthorized response message
{
  message: string
}

// User or organization not found
anyOf: [
  {"$ref":"UserNotFoundMessage"},
  {"$ref":"OrganizationNotFoundMessage"}
]

{
  // User email address
  email: string
  // User password (optional for passwordless)
  password?: string
  // Name of the initial organization
  organizationName?: string
  // Description of the organization
  organizationDescription?: string
  // Redirect URL of the organization
  organizationRedirectUrl?: string
}

{
  // Indicates if the verification email was sent
  emailSent?: boolean
}

// Bad Request on sending email verification
anyOf: [
  {"$ref":"ValidationErrorMessage"},
  {"$ref":"InvalidCredentialsForOperationMessage"},
  {"$ref":"EmailAlreadyVerifiedMessage"},
  {"$ref":"EmailSendFailureMessage"}
]

// User or organization not found
anyOf: [
  {"$ref":"UserNotFoundMessage"},
  {"$ref":"OrganizationNotFoundMessage"}
]

{
  // User email address (optional)
  email?: string
  // 6-digit verification code (for email/MFA)
  code?: string
  // Verification token (for email links)
  token?: string
  // User password (if setting during verification)
  password?: string
}

{
  // Indicates if the email was successfully verified
  verified?: boolean
  // JWT access token upon successful verification
  access_token?: string
}

// Bad Request on email verification
anyOf: [
  {"$ref":"ValidationErrorMessage"},
  {"$ref":"EmailAlreadyVerifiedMessage"}
]

// Unauthorized response message
{
  message: string
}

// User or organization not found
anyOf: [
  {"$ref":"UserNotFoundMessage"},
  {"$ref":"OrganizationNotFoundMessage"}
]

allOf: [
  {"$ref":"UserResponseWithAudit"}
]

// Unauthorized response message
{
  message: string
}

// Member not found, Organization context not found, or Member has no organizations.
anyOf: [
  {"$ref":"UserNotFoundMessage"},
  {"$ref":"OrganizationNotFoundMessage"}
]

{
  // Confirmation message
  message: string
}

// Error response when the user is not signed in or session has expired
{
  message: string
}

// Unauthorized response message
{
  message: string
}

{
  // User email address
  email: string
  // User password (required for authentication)
  password?: string
}

{
  // Success message
  message?: string
}

// Invalid request to reset password.
anyOf: [
  {"$ref":"ValidationErrorMessage"},
  {"$ref":"EmailSendFailureMessage"}
]

// User or organization not found
anyOf: [
  {"$ref":"UserNotFoundMessage"},
  {"$ref":"OrganizationNotFoundMessage"}
]

{
  // User email address
  email: string
  // Password reset token received via email
  token: string
  // New password to set
  newPassword: string
}

{
  // Success message
  message?: string
}

// Invalid request to verify password reset.
anyOf: [
  {"$ref":"ValidationErrorMessage"},
  {"$ref":"PasswordChangeFailedMessage"}
]

// Unauthorized response message
{
  message: string
}

// User or organization not found
anyOf: [
  {"$ref":"UserNotFoundMessage"},
  {"$ref":"OrganizationNotFoundMessage"}
]

{
  // Current user password
  currentPassword: string
  // New password to set
  newPassword: string
}

{
  // Success message
  message?: string
}

// Invalid request to change password.
anyOf: [
  {"$ref":"ValidationErrorMessage"},
  {"$ref":"PasswordChangeFailedMessage"}
]

// Unauthorized response message
{
  message: string
}

// User or organization not found
anyOf: [
  {"$ref":"UserNotFoundMessage"},
  {"$ref":"OrganizationNotFoundMessage"}
]

// Data required to create a new API key
{
  // Name of the role assigned to this API key
  roleName: string
  // Duration for which the key is valid (e.g., "30d", "1y")
  lifetime?: string
  // Descriptive name for the API key
  name: string
}

// Response after creating an API key, including the key value
allOf: [
  {"$ref":"ApiKeyResponse"}
]

// Bad Request when creating API key
anyOf: [
  {"$ref":"ValidationErrorMessage"},
  {"$ref":"ApiKeyNameTakenMessage"},
  {"$ref":"InvalidApiKeyRoleMessage"},
  {"$ref":"InvalidApiKeyLifetimeFormatMessage"},
  {"$ref":"LimitReachedMessage"}
]

// Unauthorized response message
{
  message: string
}

// Forbidden response message
{
  message: string
}

// Indicates that the organization context was not found or is invalid
{
  // The specified organization could not be found or is not accessible
  message: string
}

// Conflict response message
{
  message: string
}

// Limit reached response message
{
  message: string
}

[]

// Unauthorized response message
{
  message: string
}

// Forbidden response message
{
  message: string
}

// Organization not found or no API keys found for the organization.
anyOf: [
  {"$ref":"EmptyArrayResponse"},
  {"$ref":"OrganizationNotFoundMessage"}
]

// API key information with organization details
{
  // Unique identifier for the API key
  id: string
  // ID of the organization this API key belongs to
  orgId: string
  // Name of the role assigned to this API key
  roleName: string
  // Descriptive name for the API key
  name: string
  // Current status of the API key
  status: enum[active, deleted, disabled] //default: active
  // Timestamp when the API key expires
  expiresAt?: string | null
  // Organization information
  organization: {
    // Name of the organization this API key belongs to
    name?: string
  }
  // User who created the resource
  createdByUser?: oneOf: [
    {"$ref":"AuditInfoMember"},
    {"type":"null"}
  ]
  // User who last updated the resource
  updatedByUser?: oneOf: [
    {"$ref":"AuditInfoMember"},
    {"type":"null"}
  ]
  // API key used to create the resource
  createdByApiKey?: oneOf: [
    {"$ref":"AuditInfoApiKey"},
    {"type":"null"}
  ]
  // API key used to last update the resource
  updatedByApiKey?: oneOf: [
    {"$ref":"AuditInfoApiKey"},
    {"type":"null"}
  ]
  // When the resource was created
  createdAt?: anyOf: [
    {"type":"string"},
    {"type":"string"},
    {"type":"null"}
  ]
  // When the resource was last updated
  updatedAt?: anyOf: [
    {"type":"string"},
    {"type":"string"},
    {"type":"null"}
  ]
}

// Unauthorized response message
{
  message: string
}

// Forbidden response message
{
  message: string
}

// API key not found or its organization not found.
anyOf: [
  {"$ref":"ApiKeyNotFoundMessage"},
  {"$ref":"OrganizationNotFoundMessage"}
]

// Data for updating an API key
{
  // New name for the API key
  name: string
  // New expiration date for the API key
  expiresAt?: string | null
}

// API key information with organization details
{
  // Unique identifier for the API key
  id: string
  // ID of the organization this API key belongs to
  orgId: string
  // Name of the role assigned to this API key
  roleName: string
  // Descriptive name for the API key
  name: string
  // Current status of the API key
  status: enum[active, deleted, disabled] //default: active
  // Timestamp when the API key expires
  expiresAt?: string | null
  // Organization information
  organization: {
    // Name of the organization this API key belongs to
    name?: string
  }
  // User who created the resource
  createdByUser?: oneOf: [
    {"$ref":"AuditInfoMember"},
    {"type":"null"}
  ]
  // User who last updated the resource
  updatedByUser?: oneOf: [
    {"$ref":"AuditInfoMember"},
    {"type":"null"}
  ]
  // API key used to create the resource
  createdByApiKey?: oneOf: [
    {"$ref":"AuditInfoApiKey"},
    {"type":"null"}
  ]
  // API key used to last update the resource
  updatedByApiKey?: oneOf: [
    {"$ref":"AuditInfoApiKey"},
    {"type":"null"}
  ]
  // When the resource was created
  createdAt?: anyOf: [
    {"type":"string"},
    {"type":"string"},
    {"type":"null"}
  ]
  // When the resource was last updated
  updatedAt?: anyOf: [
    {"type":"string"},
    {"type":"string"},
    {"type":"null"}
  ]
}

// Bad Request when updating API key
anyOf: [
  {"$ref":"ValidationErrorMessage"},
  {"$ref":"ApiKeyNameTakenMessage"}
]

// Unauthorized response message
{
  message: string
}

// Forbidden response message
{
  message: string
}

// API key to update not found or its organization not found.
anyOf: [
  {"$ref":"ApiKeyNotFoundMessage"},
  {"$ref":"OrganizationNotFoundMessage"}
]

// Generic success response
{
  // Success message
  message: string
}

// Unauthorized response message
{
  message: string
}

// Forbidden response message
{
  message: string
}

// API key to delete not found or its organization not found.
anyOf: [
  {"$ref":"ApiKeyNotFoundMessage"},
  {"$ref":"OrganizationNotFoundMessage"}
]

// Data for changing the status of an API key
{
  // New status for the API key
  status: enum[active, disabled]
}

// API key information with organization details
{
  // Unique identifier for the API key
  id: string
  // ID of the organization this API key belongs to
  orgId: string
  // Name of the role assigned to this API key
  roleName: string
  // Descriptive name for the API key
  name: string
  // Current status of the API key
  status: enum[active, deleted, disabled] //default: active
  // Timestamp when the API key expires
  expiresAt?: string | null
  // Organization information
  organization: {
    // Name of the organization this API key belongs to
    name?: string
  }
  // User who created the resource
  createdByUser?: oneOf: [
    {"$ref":"AuditInfoMember"},
    {"type":"null"}
  ]
  // User who last updated the resource
  updatedByUser?: oneOf: [
    {"$ref":"AuditInfoMember"},
    {"type":"null"}
  ]
  // API key used to create the resource
  createdByApiKey?: oneOf: [
    {"$ref":"AuditInfoApiKey"},
    {"type":"null"}
  ]
  // API key used to last update the resource
  updatedByApiKey?: oneOf: [
    {"$ref":"AuditInfoApiKey"},
    {"type":"null"}
  ]
  // When the resource was created
  createdAt?: anyOf: [
    {"type":"string"},
    {"type":"string"},
    {"type":"null"}
  ]
  // When the resource was last updated
  updatedAt?: anyOf: [
    {"type":"string"},
    {"type":"string"},
    {"type":"null"}
  ]
}

// Bad Request when changing API key status
anyOf: [
  {"$ref":"ValidationErrorMessage"},
  {"$ref":"LimitReachedMessage"}
]

// Unauthorized response message
{
  message: string
}

// Forbidden response message
{
  message: string
}

// API key to change status not found or its organization not found.
anyOf: [
  {"$ref":"ApiKeyNotFoundMessage"},
  {"$ref":"OrganizationNotFoundMessage"}
]

// Organization information with related details
{
  // Unique identifier for the organization
  id: string
  // Name of the organization
  name: string
  // Current plan of the organization
  planName?: string | null
  // Description of the organization
  description?: string | null
  // Redirect URL of the organization
  redirectUrl?: string | null
  // Whether the organization is disabled
  isDisabled?: boolean
  // ID of the user or API key that disabled the organization
  disabledBy?: string | null
  // Timestamp when the organization was disabled
  disabledAt?: anyOf: [
    {"type":"string"},
    {"type":"string"},
    {"type":"null"}
  ]
  // Whether the organization is deleted
  isDeleted?: boolean
  // ID of the user or API key that deleted the organization
  deletedBy?: string | null
  // Timestamp when the organization was deleted
  deletedAt?: anyOf: [
    {"type":"string"},
    {"type":"string"},
    {"type":"null"}
  ]
  // Whether this is the current active organization for the user
  isCurrent?: boolean
  roles?:   {
    // Name of the role
    name: string
    scopes?:     // Scope associated with the role
    string[]
  }[]
  workspaces?:   {
    // Unique identifier for the workspace
    id: string
    // Name of the workspace
    name: string
    // Whether access to this workspace is isRestricted
    isRestricted: boolean
    roles?:     {
      // Name of the role
      name: string
      scopes?:       // Scope associated with the role
      string[]
    }[]
  }[]
  // User who created the resource
  createdByUser?: oneOf: [
    {"$ref":"AuditInfoMember"},
    {"type":"null"}
  ]
  // User who last updated the resource
  updatedByUser?: oneOf: [
    {"$ref":"AuditInfoMember"},
    {"type":"null"}
  ]
  // API key used to create the resource
  createdByApiKey?: oneOf: [
    {"$ref":"AuditInfoApiKey"},
    {"type":"null"}
  ]
  // API key used to last update the resource
  updatedByApiKey?: oneOf: [
    {"$ref":"AuditInfoApiKey"},
    {"type":"null"}
  ]
  // When the resource was created
  createdAt?: anyOf: [
    {"type":"string"},
    {"type":"string"},
    {"type":"null"}
  ]
  // When the resource was last updated
  updatedAt?: anyOf: [
    {"type":"string"},
    {"type":"string"},
    {"type":"null"}
  ]
}

// Unauthorized response message
{
  message: string
}

// Indicates that the organization context was not found or is invalid
{
  // The specified organization could not be found or is not accessible
  message: string
}

// Data for updating an organization
{
  // Name of the organization
  name?: string
  // Description of the organization
  description?: string | null
  // Redirect URL of the organization
  redirectUrl?: string | null
}

// Organization information with related details
{
  // Unique identifier for the organization
  id: string
  // Name of the organization
  name: string
  // Current plan of the organization
  planName?: string | null
  // Description of the organization
  description?: string | null
  // Redirect URL of the organization
  redirectUrl?: string | null
  // Whether the organization is disabled
  isDisabled?: boolean
  // ID of the user or API key that disabled the organization
  disabledBy?: string | null
  // Timestamp when the organization was disabled
  disabledAt?: anyOf: [
    {"type":"string"},
    {"type":"string"},
    {"type":"null"}
  ]
  // Whether the organization is deleted
  isDeleted?: boolean
  // ID of the user or API key that deleted the organization
  deletedBy?: string | null
  // Timestamp when the organization was deleted
  deletedAt?: anyOf: [
    {"type":"string"},
    {"type":"string"},
    {"type":"null"}
  ]
  // Whether this is the current active organization for the user
  isCurrent?: boolean
  roles?:   {
    // Name of the role
    name: string
    scopes?:     // Scope associated with the role
    string[]
  }[]
  workspaces?:   {
    // Unique identifier for the workspace
    id: string
    // Name of the workspace
    name: string
    // Whether access to this workspace is isRestricted
    isRestricted: boolean
    roles?:     {
      // Name of the role
      name: string
      scopes?:       // Scope associated with the role
      string[]
    }[]
  }[]
  // User who created the resource
  createdByUser?: oneOf: [
    {"$ref":"AuditInfoMember"},
    {"type":"null"}
  ]
  // User who last updated the resource
  updatedByUser?: oneOf: [
    {"$ref":"AuditInfoMember"},
    {"type":"null"}
  ]
  // API key used to create the resource
  createdByApiKey?: oneOf: [
    {"$ref":"AuditInfoApiKey"},
    {"type":"null"}
  ]
  // API key used to last update the resource
  updatedByApiKey?: oneOf: [
    {"$ref":"AuditInfoApiKey"},
    {"type":"null"}
  ]
  // When the resource was created
  createdAt?: anyOf: [
    {"type":"string"},
    {"type":"string"},
    {"type":"null"}
  ]
  // When the resource was last updated
  updatedAt?: anyOf: [
    {"type":"string"},
    {"type":"string"},
    {"type":"null"}
  ]
}

// Invalid request to update organization. Check data, permissions, or ensure at least one field is provided for update.
anyOf: [
  {"$ref":"ValidationErrorMessage"},
  {"$ref":"UpdateFieldRequiredMessage"}
]

// Unauthorized response message
{
  message: string
}

// Forbidden response message
{
  message: string
}

// Indicates that the organization context was not found or is invalid
{
  // The specified organization could not be found or is not accessible
  message: string
}

// Data required to create a new organization
{
  // Name of the organization
  name: string
  // Description of the organization
  description?: string
  // Redirect URL of the organization
  redirectUrl?: string | null
}

// Response after creating an organization
{
  // Unique identifier for the organization
  id: string
  // Name of the organization
  name: string
  // Description of the organization
  description?: string | null
  // Redirect URL of the organization
  redirectUrl?: string | null
}

// Error response for validation failures
{
  message: string
  errors?: []
}

// Unauthorized response message
{
  message: string
}

// Conflict response message
{
  message: string
}

{
  // JWT access token upon successful sign-in verification
  access_token?: string
}

// Unauthorized response message
{
  message: string
}

// Target organization for switching not found or is disabled.
anyOf: [
  {"$ref":"OrganizationNotFoundMessage"},
  {"$ref":"OrganizationNotFoundOrDisabledMessage"}
]

// Data required to create a new invitation
{
  // Email address of the person to invite
  email: string
  // Role to assign to the invited user
  roleName: string
  // Optional workspace ID to invite user to a specific workspace
  workspaceId?: string
  // Optional personalized message to include in the invitation
  message?: string | null
}

// Invitation details with audit information
{
  // Unique identifier for the invitation
  id: string
  // Email address of the invited user
  email: string
  // ID of the organization sending the invitation
  orgId: string
  // ID of the specific workspace (if applicable)
  workspaceId?: string | null
  // Role to be assigned upon acceptance
  roleName: string
  // Current status of the invitation
  status: enum[pending, accepted, expired, declined]
  // Personalized message included in the invitation
  message?: string | null
  // When the invitation expires
  expiresAt: anyOf: [
    {"type":"string"},
    {"type":"string"}
  ]
  // Organization information
  organization: {
    // Name of the organization sending the invitation
    name: string
  }
  // Workspace information (if invitation is for a specific workspace)
  workspace?: object | null
  // User who created the resource
  createdByUser?: oneOf: [
    {"$ref":"AuditInfoMember"},
    {"type":"null"}
  ]
  // User who last updated the resource
  updatedByUser?: oneOf: [
    {"$ref":"AuditInfoMember"},
    {"type":"null"}
  ]
  // API key used to create the resource
  createdByApiKey?: oneOf: [
    {"$ref":"AuditInfoApiKey"},
    {"type":"null"}
  ]
  // API key used to last update the resource
  updatedByApiKey?: oneOf: [
    {"$ref":"AuditInfoApiKey"},
    {"type":"null"}
  ]
  // When the resource was created
  createdAt?: anyOf: [
    {"type":"string"},
    {"type":"string"},
    {"type":"null"}
  ]
  // When the resource was last updated
  updatedAt?: anyOf: [
    {"type":"string"},
    {"type":"string"},
    {"type":"null"}
  ]
}

// Invalid request to create invitation.
anyOf: [
  {"$ref":"ValidationErrorMessage"},
  {"$ref":"UserAlreadyHasRoleInOrganizationMessage"}
]

// Unauthorized response message
{
  message: string
}

// Forbidden response message
{
  message: string
}

// Indicates that the organization context was not found or is invalid
{
  // The specified organization could not be found or is not accessible
  message: string
}

// Conflict response message
{
  message: string
}

// Limit reached response message
{
  message: string
}

[]

// Unauthorized response message
{
  message: string
}

// Forbidden response message
{
  message: string
}

// Organization context not found.
anyOf: [
  {"$ref":"EmptyArrayResponse"},
  {"$ref":"OrganizationNotFoundMessage"}
]

// Invitation details with audit information
{
  // Unique identifier for the invitation
  id: string
  // ID of the organization sending the invitation
  orgId: string
  // ID of the specific workspace (if applicable)
  workspaceId?: string | null
  // Role to be assigned upon acceptance
  roleName: string
  // Current status of the invitation
  status: enum[pending, accepted, expired, declined]
  // Personalized message included in the invitation
  message?: string | null
  // When the invitation expires
  expiresAt: anyOf: [
    {"type":"string"},
    {"type":"string"}
  ]
  // Organization information
  organization: {
    // Name of the organization sending the invitation
    name: string
  }
  // Workspace information (if invitation is for a specific workspace)
  workspace?: object | null
  // User who created the resource
  createdByUser?: oneOf: [
    {"$ref":"AuditInfoMember"},
    {"type":"null"}
  ]
  // User who last updated the resource
  updatedByUser?: oneOf: [
    {"$ref":"AuditInfoMember"},
    {"type":"null"}
  ]
  // API key used to create the resource
  createdByApiKey?: oneOf: [
    {"$ref":"AuditInfoApiKey"},
    {"type":"null"}
  ]
  // API key used to last update the resource
  updatedByApiKey?: oneOf: [
    {"$ref":"AuditInfoApiKey"},
    {"type":"null"}
  ]
  // When the resource was created
  createdAt?: anyOf: [
    {"type":"string"},
    {"type":"string"},
    {"type":"null"}
  ]
  // When the resource was last updated
  updatedAt?: anyOf: [
    {"type":"string"},
    {"type":"string"},
    {"type":"null"}
  ]
}[]

// Unauthorized response message
{
  message: string
}

// Forbidden response message
{
  message: string
}

// No invitations found for the current user, or the organization context is invalid.
anyOf: [
  {"$ref":"EmptyArrayResponse"},
  {"$ref":"OrganizationNotFoundMessage"}
]

// Success response message
{
  message: string
}

// Cannot delete invitation due to invalid parameters or business rules.
anyOf: [
  {"$ref":"ValidationErrorMessage"},
  {"$ref":"CannotDeleteAcceptedInvitationMessage"}
]

// Unauthorized response message
{
  message: string
}

// Forbidden response message
{
  message: string
}

// Invitation to delete not found, or its organization not found.
anyOf: [
  {"$ref":"InvitationNotFoundMessage"},
  {"$ref":"OrganizationNotFoundMessage"}
]

// Response after accepting an invitation
{
  // User ID of the newly registered or existing user
  id: string
  // Email address of the user
  email: string
  // Whether the email has been verified
  isEmailVerified: boolean
  // JWT access token for authentication
  access_token: string
}

// Cannot accept invitation due to invalid token, status, or parameters.
anyOf: [
  {"$ref":"ValidationErrorMessage"},
  {"$ref":"InvitationExpiredMessage"},
  {"$ref":"InvitationAlreadyAcceptedMessage"},
  {"$ref":"InvitationAlreadyDeclinedMessage"}
]

// Indicates that the invitation was not found or is invalid
{
  // The specified invitation could not be found or is invalid or the organization is disabled or deleted
  message: string
}

// Success response message
{
  message: string
}

// Cannot decline invitation due to invalid token, status, or parameters.
anyOf: [
  {"$ref":"ValidationErrorMessage"},
  {"$ref":"InvitationExpiredMessage"},
  {"$ref":"InvitationAlreadyAcceptedMessage"},
  {"$ref":"InvitationAlreadyDeclinedMessage"}
]

// Indicates that the invitation was not found or is invalid
{
  // The specified invitation could not be found or is invalid or the organization is disabled or deleted
  message: string
}

// Data required to add a member to an organization
{
  // Email address of the user to add
  email: string
  // Name of the role to assign to the member
  roleName: string
  // Whether to send an invitation email
  sendInvitation?: boolean
}

// Role information with organization details
{
  // Name of the role
  name: string
  scopes?:   string[]
  // Organization the role is associated with
  organization: {
    // Unique identifier for the organization
    id: string
    // Name of the organization
    name?: string
    // Description of the organization
    description?: string | null
  }
}

// Invalid request to add member.
anyOf: [
  {"$ref":"ValidationErrorMessage"},
  {"$ref":"UserAlreadyHasRoleInOrganizationMessage"}
]

// Unauthorized response message
{
  message: string
}

// Forbidden response message
{
  message: string
}

// Member to be added not found (and invitation not sent), or Organization not found.
anyOf: [
  {"$ref":"MemberNotFoundMessage"},
  {"$ref":"MemberOrRoleNotFoundMessage"},
  {"$ref":"OrganizationNotFoundMessage"}
]

// Conflict response message
{
  message: string
}

[]

// Unauthorized response message
{
  message: string
}

// Forbidden response message
{
  message: string
}

// Organization not found, or no members in organization.
anyOf: [
  {"$ref":"EmptyArrayResponse"},
  {"$ref":"OrganizationNotFoundMessage"}
]

// Success response message
{
  message: string
}

// Unauthorized response message
{
  message: string
}

// Forbidden response message
{
  message: string
}

// Member to remove not found in the organization, or Organization not found.
anyOf: [
  {"$ref":"MemberNotFoundMessage"},
  {"$ref":"OrganizationNotFoundMessage"}
]

// Grouped roles for a member
{
  organizationRoles:   // Role in the organization
  {
    // Name of the role
    name: string
    scopes?:     string[]
    // ID of the organization this role is associated with
    orgId: string
  }[]
  workspaceRoles:   // Role in a workspace
  {
    // Name of the role
    name: string
    scopes?:     string[]
    // ID of the workspace this role is associated with
    workspaceId: string
  }[]
}

// Unauthorized response message
{
  message: string
}

// Forbidden response message
{
  message: string
}

// Member not found, Organization not found, or member found but has no roles in this context.
anyOf: [
  {"$ref":"EmptyRolesListResponse"},
  {"$ref":"MemberNotFoundMessage"},
  {"$ref":"OrganizationNotFoundMessage"}
]

// Data required to add a role to a member
{
  // Name of the role to assign
  roleName: string
}

// Role information with organization details
{
  // Name of the role
  name: string
  scopes?:   string[]
  // Organization the role is associated with
  organization: {
    // Unique identifier for the organization
    id: string
    // Name of the organization
    name?: string
    // Description of the organization
    description?: string | null
  }
}

// Invalid request to add role to member.
anyOf: [
  {"$ref":"ValidationErrorMessage"},
  {"$ref":"UserAlreadyHasRoleInOrganizationMessage"}
]

// Unauthorized response message
{
  message: string
}

// Forbidden response message
{
  message: string
}

// Member, Role, or Organization not found.
anyOf: [
  {"$ref":"MemberNotFoundMessage"},
  {"$ref":"MemberOrRoleNotFoundMessage"},
  {"$ref":"OrganizationNotFoundMessage"}
]

// Success response message
{
  message: string
}

// Cannot remove member role due to business rules or invalid parameters.
anyOf: [
  {"$ref":"ValidationErrorMessage"},
  {"$ref":"CannotRemoveOwnOwnerRoleMessage"}
]

// Unauthorized response message
{
  message: string
}

// Forbidden response message
{
  message: string
}

// Member, Role, or Organization not found.
anyOf: [
  {"$ref":"MemberNotFoundMessage"},
  {"$ref":"MemberOrRoleNotFoundMessage"},
  {"$ref":"OrganizationNotFoundMessage"}
]

// Data required to create a new workspace
{
  // Name of the workspace
  name: string
  // Description of the workspace
  description?: string
  // Whether access to this workspace is isRestricted
  isRestricted?: boolean //default: true
}

// Workspace information with audit details
{
  // Unique identifier for the workspace
  id: string
  // Name of the workspace
  name: string
  // Description of the workspace
  description?: string | null
  // Whether access to this workspace is isRestricted
  isRestricted: boolean
  // ID of the organization this workspace belongs to
  orgId: string
  // User who created the resource
  createdByUser?: oneOf: [
    {"$ref":"AuditInfoMember"},
    {"type":"null"}
  ]
  // User who last updated the resource
  updatedByUser?: oneOf: [
    {"$ref":"AuditInfoMember"},
    {"type":"null"}
  ]
  // API key used to create the resource
  createdByApiKey?: oneOf: [
    {"$ref":"AuditInfoApiKey"},
    {"type":"null"}
  ]
  // API key used to last update the resource
  updatedByApiKey?: oneOf: [
    {"$ref":"AuditInfoApiKey"},
    {"type":"null"}
  ]
  // When the resource was created
  createdAt?: anyOf: [
    {"type":"string"},
    {"type":"string"},
    {"type":"null"}
  ]
  // When the resource was last updated
  updatedAt?: anyOf: [
    {"type":"string"},
    {"type":"string"},
    {"type":"null"}
  ]
}