Users

users

UserId

Bases: str

Unique ID of a user.

UserTokenId

Bases: str

Unique ID of a user token.

UserToken

Bases: str

User token.

UserSessionId

Bases: str

User session ID.

UserSessionToken

Bases: str

User session token.

QueryUsersAction

Bases: BaseModel

Query the users of the instance.

QueryUsersOutput

Bases: BaseModel

Output of querying the users of the instance.

users class-attribute instance-attribute

users = Field(description='List of users.')

QueryUsersItem

Bases: BaseModel

User item.

user_id class-attribute instance-attribute

user_id = Field(
    description="ID of the user.",
    validation_alias="userId",
    serialization_alias="userId",
)

email class-attribute instance-attribute

email = Field(description='Email of the user.')

display_name class-attribute instance-attribute

display_name = Field(
    default=None,
    description="Name of the user.",
    validation_alias="displayName",
    serialization_alias="displayName",
)

is_admin class-attribute instance-attribute

is_admin = Field(
    description="Whether the user is an instance admin.",
    validation_alias="isAdmin",
    serialization_alias="isAdmin",
)

GetUserDetailsAction

Bases: BaseModel

Get information about a user.

user_id class-attribute instance-attribute

user_id = Field(
    description="ID of the user.",
    validation_alias="userId",
    serialization_alias="userId",
)

GetUserDetailsOutput

Bases: BaseModel

Information about the user.

user_id class-attribute instance-attribute

user_id = Field(
    description="ID of the user.",
    validation_alias="userId",
    serialization_alias="userId",
)

email class-attribute instance-attribute

email = Field(description='Email of the user.')

display_name class-attribute instance-attribute

display_name = Field(
    default=None,
    description="Name of the user.",
    validation_alias="displayName",
    serialization_alias="displayName",
)

is_admin class-attribute instance-attribute

is_admin = Field(
    description="Whether the user is an instance admin.",
    validation_alias="isAdmin",
    serialization_alias="isAdmin",
)

CreateUserAction

Bases: BaseModel

Create a new user.

email class-attribute instance-attribute

email = Field(description='Email of the user.')

display_name class-attribute instance-attribute

display_name = Field(
    default=None,
    description="Name of the user.",
    validation_alias="displayName",
    serialization_alias="displayName",
)

password class-attribute instance-attribute

password = Field(
    default=None, description="Password of the user."
)

is_admin class-attribute instance-attribute

is_admin = Field(
    default=None,
    description="Whether the user is an instance admin.",
    validation_alias="isAdmin",
    serialization_alias="isAdmin",
)

CreateUserSuccess

Bases: BaseModel

User was created successfully.

user_id class-attribute instance-attribute

user_id = Field(
    description="ID of the user.",
    validation_alias="userId",
    serialization_alias="userId",
)

DeleteUserAction

Bases: BaseModel

Delete a user.

user_id class-attribute instance-attribute

user_id = Field(
    description="ID of the user to delete.",
    validation_alias="userId",
    serialization_alias="userId",
)

SetUserDisplayNameAction

Bases: BaseModel

Set the display name of a user.

user_id class-attribute instance-attribute

user_id = Field(
    description="ID of the user to update.",
    validation_alias="userId",
    serialization_alias="userId",
)

display_name class-attribute instance-attribute

display_name = Field(
    description="New name of the user.",
    validation_alias="displayName",
    serialization_alias="displayName",
)

SetUserPasswordAction

Bases: BaseModel

Set the password of a user.

user_id class-attribute instance-attribute

user_id = Field(
    description="ID of the user.",
    validation_alias="userId",
    serialization_alias="userId",
)

password class-attribute instance-attribute

password = Field(description='New password of the user.')

SetUserIsAdminAction

Bases: BaseModel

Set whether the user is an instance administrator.

user_id class-attribute instance-attribute

user_id = Field(
    description="ID of the user.",
    validation_alias="userId",
    serialization_alias="userId",
)

is_admin class-attribute instance-attribute

is_admin = Field(
    description="Whether the user is an instance administrator.",
    validation_alias="isAdmin",
    serialization_alias="isAdmin",
)

ResetUserPasswordAction

Bases: BaseModel

Reset the password of a user.

This will send an email to the user with a link to reset their password.

email class-attribute instance-attribute

email = Field(description='Email of the user.')

CompleteUserPasswordResetAction

Bases: BaseModel

Complete the password reset of a user.

reset_token class-attribute instance-attribute

reset_token = Field(
    description="Token to use for password reset.",
    validation_alias="resetToken",
    serialization_alias="resetToken",
)

password class-attribute instance-attribute

password = Field(description='New password of the user.')

QueryUserTokensAction

Bases: BaseModel

Query the tokens of a user.

user_id class-attribute instance-attribute

user_id = Field(
    description="ID of the user.",
    validation_alias="userId",
    serialization_alias="userId",
)

QueryUserTokensOutput

Bases: BaseModel

Output of querying the tokens of a user.

tokens class-attribute instance-attribute

tokens = Field(description='List of user tokens.')

QueryUserTokensItem

Bases: BaseModel

User token item.

token_id class-attribute instance-attribute

token_id = Field(
    description="ID of the token.",
    validation_alias="tokenId",
    serialization_alias="tokenId",
)

created_at class-attribute instance-attribute

created_at = Field(
    description="Creation date of the token.",
    validation_alias="createdAt",
    serialization_alias="createdAt",
)

name class-attribute instance-attribute

name = Field(default=None, description="Name of the token.")

QueryUserOrganizationsAction

Bases: BaseModel

Query the organizations of a user.

user_id class-attribute instance-attribute

user_id = Field(
    description="ID of the user.",
    validation_alias="userId",
    serialization_alias="userId",
)

QueryUserOrganizationsOutput

Bases: BaseModel

Output of querying the organizations of a user.

organizations class-attribute instance-attribute

organizations = Field(description='List of organizations.')

QueryUserOrganizationsItem

Bases: BaseModel

Organization item.

organization_id class-attribute instance-attribute

organization_id = Field(
    description="ID of the organization.",
    validation_alias="organizationId",
    serialization_alias="organizationId",
)

name class-attribute instance-attribute

name = Field(description='Name of the organization.')

requires_subscription class-attribute instance-attribute

requires_subscription = Field(
    description="Whether the organization requires a paid subscription.",
    validation_alias="requiresSubscription",
    serialization_alias="requiresSubscription",
)

subscription_plan_name class-attribute instance-attribute

subscription_plan_name = Field(
    default=None,
    description="Name of the active subscription plan, if any.",
    validation_alias="subscriptionPlanName",
    serialization_alias="subscriptionPlanName",
)

QueryUserOrganizationInvitationsAction

Bases: BaseModel

Query the organization invitations of a user.

user_id class-attribute instance-attribute

user_id = Field(
    description="ID of the user.",
    validation_alias="userId",
    serialization_alias="userId",
)

QueryUserOrganizationInvitationsOutput

Bases: BaseModel

Output of querying the organization invitations of a user.

invitations class-attribute instance-attribute

invitations = Field(
    description="List of organization invitations."
)

QueryUserOrganizationInvitationsItem

Bases: BaseModel

Organization invitation item.

invitation_id class-attribute instance-attribute

invitation_id = Field(
    description="ID of the invitation.",
    validation_alias="invitationId",
    serialization_alias="invitationId",
)

organization class-attribute instance-attribute

organization = Field(
    description="Information about the organization."
)

QueryUserOrganizationInvitationsItemOrganization

Bases: BaseModel

Organization invitation item organization.

organization_id class-attribute instance-attribute

organization_id = Field(
    description="ID of the organization.",
    validation_alias="organizationId",
    serialization_alias="organizationId",
)

name class-attribute instance-attribute

name = Field(description='Name of the organization.')

QueryUserSessionsAction

Bases: BaseModel

Query the sessions of a user.

user_id class-attribute instance-attribute

user_id = Field(
    description="ID of the user.",
    validation_alias="userId",
    serialization_alias="userId",
)

QueryUserSessionsOutput

Bases: BaseModel

Output of querying the sessions of a user.

sessions class-attribute instance-attribute

sessions = Field(description='List of user sessions.')

UserSession

Bases: BaseModel

User session.

session_id class-attribute instance-attribute

session_id = Field(
    description="ID of the session.",
    validation_alias="sessionId",
    serialization_alias="sessionId",
)

created_at class-attribute instance-attribute

created_at = Field(
    description="Creation date of the session.",
    validation_alias="createdAt",
    serialization_alias="createdAt",
)

expires_at class-attribute instance-attribute

expires_at = Field(
    description="Expiration date of the session.",
    validation_alias="expiresAt",
    serialization_alias="expiresAt",
)

user_agent class-attribute instance-attribute

user_agent = Field(
    description="User agent of the session.",
    validation_alias="userAgent",
    serialization_alias="userAgent",
)

AuthenticateWithUserTokenAction

Bases: BaseModel

Authenticate a user with a token.

token class-attribute instance-attribute

token = Field(description='Token.')

AuthenticateWithUserTokenSuccess

Bases: BaseModel

Authentication with user token has been successful.

user_id class-attribute instance-attribute

user_id = Field(
    description="ID of the user.",
    validation_alias="userId",
    serialization_alias="userId",
)

actor class-attribute instance-attribute

actor = Field(
    description="Resulting actor to use for further actions."
)

AuthenticateWithSessionTokenAction

Bases: BaseModel

Authenticate a user with a session token.

token class-attribute instance-attribute

token = Field(description='Session token.')

AuthenticateWithSessionTokenSuccess

Bases: BaseModel

Authentication with session token has been successful.

user_id class-attribute instance-attribute

user_id = Field(
    description="ID of the user.",
    validation_alias="userId",
    serialization_alias="userId",
)

session_id class-attribute instance-attribute

session_id = Field(
    description="ID of the session.",
    validation_alias="sessionId",
    serialization_alias="sessionId",
)

actor class-attribute instance-attribute

actor = Field(
    description="Resulting actor to use for further actions."
)

GetDevicePermissionsAction

Bases: BaseModel

Check the permissions of a user for a given device.

user_id class-attribute instance-attribute

user_id = Field(
    description="ID of the user.",
    validation_alias="userId",
    serialization_alias="userId",
)

device_id class-attribute instance-attribute

device_id = Field(
    description="ID of the device.",
    validation_alias="deviceId",
    serialization_alias="deviceId",
)

GetDevicePermissionsOutput

Bases: BaseModel

Output of checking the permissions of a user for a given device.

has_access class-attribute instance-attribute

has_access = Field(
    description="Whether the user has access to the device.",
    validation_alias="hasAccess",
    serialization_alias="hasAccess",
)

CreateUserTokenAction

Bases: BaseModel

Create a user token.

user_id class-attribute instance-attribute

user_id = Field(
    description="ID of the user.",
    validation_alias="userId",
    serialization_alias="userId",
)

name class-attribute instance-attribute

name = Field(default=None, description="Name of the token.")

CreateUserTokenOutput

Bases: BaseModel

Output of creating a user token.

token_id class-attribute instance-attribute

token_id = Field(
    description="ID of the token.",
    validation_alias="tokenId",
    serialization_alias="tokenId",
)

token class-attribute instance-attribute

token = Field(description='Token.')

DeleteUserTokenAction

Bases: BaseModel

Delete a user token.

token_id class-attribute instance-attribute

token_id = Field(
    description="ID of the token.",
    validation_alias="tokenId",
    serialization_alias="tokenId",
)

InitiateUserSessionAction

Bases: BaseModel

Initiate a user session.

email class-attribute instance-attribute

email = Field(description='Email address of the user.')

password class-attribute instance-attribute

password = Field(description='Password of the user.')

user_agent class-attribute instance-attribute

user_agent = Field(
    description="User agent of the session.",
    validation_alias="userAgent",
    serialization_alias="userAgent",
)

valid_for_secs class-attribute instance-attribute

valid_for_secs = Field(
    default=None,
    description="Number of seconds the session should be valid for.\n\nDefaults to 86400 (1 day).",
    validation_alias="validForSecs",
    serialization_alias="validForSecs",
)

InitiateUserSessionSuccess

Bases: BaseModel

Session was created successfully.

user_id class-attribute instance-attribute

user_id = Field(
    description="ID of the user.",
    validation_alias="userId",
    serialization_alias="userId",
)

session_id class-attribute instance-attribute

session_id = Field(
    description="ID of the session.",
    validation_alias="sessionId",
    serialization_alias="sessionId",
)

session_token class-attribute instance-attribute

session_token = Field(
    description="Session token.",
    validation_alias="sessionToken",
    serialization_alias="sessionToken",
)

TerminateUserSessionAction

Bases: BaseModel

Terminate a user session.

session_id class-attribute instance-attribute

session_id = Field(
    description="ID of the session.",
    validation_alias="sessionId",
    serialization_alias="sessionId",
)

CleanupExpiredUserSessionsAction

Bases: BaseModel

Cleanup expired user sessions.

RegisterUserAction

Bases: BaseModel

Register a new user with an email and password.

display_name class-attribute instance-attribute

display_name = Field(
    default=None,
    description="Name of the user.",
    validation_alias="displayName",
    serialization_alias="displayName",
)

email class-attribute instance-attribute

email = Field(description='Email address of the user.')

password class-attribute instance-attribute

password = Field(description='Password of the user.')

consented_to_terms class-attribute instance-attribute

consented_to_terms = Field(
    description="Indicates whether the user has consented to the terms and conditions.\n\nThis must be `true` to register a user.",
    validation_alias="consentedToTerms",
    serialization_alias="consentedToTerms",
)

consented_to_marketing class-attribute instance-attribute

consented_to_marketing = Field(
    default=None,
    description="Indicates whether the user has consented to marketing communications.",
    validation_alias="consentedToMarketing",
    serialization_alias="consentedToMarketing",
)

UserRegistration

Bases: BaseModel

User registration.

status class-attribute instance-attribute

status = Field(description='Registration status.')

message class-attribute instance-attribute

message = Field(
    default=None,
    description="Optional message to show to the user.",
)

created_at class-attribute instance-attribute

created_at = Field(
    description="Timestamp when the registration was created.",
    validation_alias="createdAt",
    serialization_alias="createdAt",
)

ResendRegistrationEmailAction

Bases: BaseModel

email class-attribute instance-attribute

email = Field(description='Email address of the user.')

CompleteRegistrationAction

Bases: BaseModel

Complete the registration of a user.

activation_token class-attribute instance-attribute

activation_token = Field(
    description="Token to use for account activation.",
    validation_alias="activationToken",
    serialization_alias="activationToken",
)

AcceptOrganizationInvitationAction

Bases: BaseModel

Accept a organization invitation.

invitation_id class-attribute instance-attribute

invitation_id = Field(
    description="ID of the invitation.",
    validation_alias="invitationId",
    serialization_alias="invitationId",
)

CreateUserOutput_Created

Bases: CreateUserSuccess

result class-attribute instance-attribute

result = 'Created'

CreateUserOutput_EmailAlreadyExists

Bases: BaseModel

result class-attribute instance-attribute

result = 'EmailAlreadyExists'

CreateUserOutput

CreateUserOutput = Annotated[
    CreateUserOutput_Created
    | CreateUserOutput_EmailAlreadyExists,
    Discriminator("result"),
]

CompleteUserPasswordResetOutput_Completed

Bases: BaseModel

result class-attribute instance-attribute

result = 'Completed'

CompleteUserPasswordResetOutput_InvalidToken

Bases: BaseModel

result class-attribute instance-attribute

result = 'InvalidToken'

CompleteUserPasswordResetOutput

CompleteUserPasswordResetOutput = Annotated[
    CompleteUserPasswordResetOutput_Completed
    | CompleteUserPasswordResetOutput_InvalidToken,
    Discriminator("result"),
]

AuthenticateWithUserTokenOutput_Invalid

Bases: BaseModel

result class-attribute instance-attribute

result = 'Invalid'

AuthenticateWithUserTokenOutput_Authenticated

Bases: AuthenticateWithUserTokenSuccess

result class-attribute instance-attribute

result = 'Authenticated'

AuthenticateWithUserTokenOutput

AuthenticateWithUserTokenOutput = Annotated[
    AuthenticateWithUserTokenOutput_Invalid
    | AuthenticateWithUserTokenOutput_Authenticated,
    Discriminator("result"),
]

AuthenticateWithSessionTokenOutput_Invalid

Bases: BaseModel

result class-attribute instance-attribute

result = 'Invalid'

AuthenticateWithSessionTokenOutput_Authenticated

Bases: AuthenticateWithSessionTokenSuccess

result class-attribute instance-attribute

result = 'Authenticated'

AuthenticateWithSessionTokenOutput

AuthenticateWithSessionTokenOutput = Annotated[
    AuthenticateWithSessionTokenOutput_Invalid
    | AuthenticateWithSessionTokenOutput_Authenticated,
    Discriminator("result"),
]

InitiateUserSessionOutput_InvalidCredentials

Bases: BaseModel

result class-attribute instance-attribute

result = 'InvalidCredentials'

InitiateUserSessionOutput_Created

Bases: InitiateUserSessionSuccess

result class-attribute instance-attribute

result = 'Created'

InitiateUserSessionOutput

InitiateUserSessionOutput = Annotated[
    InitiateUserSessionOutput_InvalidCredentials
    | InitiateUserSessionOutput_Created,
    Discriminator("result"),
]

RegisterUserOutput_Created

Bases: UserRegistration

result class-attribute instance-attribute

result = 'Created'

RegisterUserOutput_Pending

Bases: UserRegistration

result class-attribute instance-attribute

result = 'Pending'

RegisterUserOutput_EmailAlreadyExists

Bases: BaseModel

result class-attribute instance-attribute

result = 'EmailAlreadyExists'

RegisterUserOutput

RegisterUserOutput = Annotated[
    RegisterUserOutput_Created
    | RegisterUserOutput_Pending
    | RegisterUserOutput_EmailAlreadyExists,
    Discriminator("result"),
]

UserRegistrationStatus_Pending

Bases: BaseModel

tag class-attribute instance-attribute

tag = 'Pending'

UserRegistrationStatus_Waiting

Bases: BaseModel

tag class-attribute instance-attribute

tag = 'Waiting'

UserRegistrationStatus_Completed

Bases: BaseModel

tag class-attribute instance-attribute

tag = 'Completed'

UserRegistrationStatus_Failed

Bases: BaseModel

tag class-attribute instance-attribute

tag = 'Failed'

UserRegistrationStatus

UserRegistrationStatus = Annotated[
    UserRegistrationStatus_Pending
    | UserRegistrationStatus_Waiting
    | UserRegistrationStatus_Completed
    | UserRegistrationStatus_Failed,
    Discriminator("tag"),
]

CompleteRegistrationOutput_Completed

Bases: BaseModel

result class-attribute instance-attribute

result = 'Completed'

CompleteRegistrationOutput_Failed

Bases: BaseModel

result class-attribute instance-attribute

result = 'Failed'

CompleteRegistrationOutput

CompleteRegistrationOutput = Annotated[
    CompleteRegistrationOutput_Completed
    | CompleteRegistrationOutput_Failed,
    Discriminator("result"),
]