roboto.domain.orgs.org_operations

Module Contents

BindEmailDomainRequest

class roboto.domain.orgs.org_operations.BindEmailDomainRequest(/, **data)#

Bases: pydantic.BaseModel

Request payload to bind an email domain to an organization.

Parameters

data Any

Attributes

BindEmailDomainRequest.email_domain

email_domain str #

Email domain to bind (e.g., “example.com”).

CreateOrgRequest

class roboto.domain.orgs.org_operations.CreateOrgRequest(/, **data)#

Bases: pydantic.BaseModel

Request payload to create an organization.

Parameters

data Any

Attributes

CreateOrgRequest.bind_email_domain

bind_email_domain bool = False #

Whether to automatically bind the creator’s email domain to this organization.

CreateOrgRequest.data_region

data_region roboto.regionalization.RobotoRegion #

AWS region where the organization’s data will be stored.

CreateOrgRequest.name

name str #

Unique name for the organization.

InviteUserRequest

class roboto.domain.orgs.org_operations.InviteUserRequest(/, **data)#

Bases: pydantic.BaseModel

Request payload to invite a user to an organization.

Parameters

data Any

Attributes

InviteUserRequest.invited_user_id

invited_user_id str #

Unique identifier for the user to invite.

ModifyRoleForUserRequest

class roboto.domain.orgs.org_operations.ModifyRoleForUserRequest(/, **data)#

Bases: pydantic.BaseModel

Request payload to modify the role for a user in an organization.

Parameters

data Any

Attributes

ModifyRoleForUserRequest.role_name

role_name roboto.domain.orgs.org_records.OrgRoleName #

Role to assign to the user.

ModifyRoleForUserRequest.user_id

user_id str #

Unique identifier for the user.

OrgRecordUpdates

class roboto.domain.orgs.org_operations.OrgRecordUpdates(/, **data)#

Bases: pydantic.BaseModel

Payload containing organization field updates.

Parameters

data Any

Attributes

OrgRecordUpdates.name

name str | None = None #

Updated name for the organization.

OrgRecordUpdates.status

status roboto.domain.orgs.org_records.OrgStatus | None = None #

Updated status for the organization.

RemoveUserFromOrgRequest

class roboto.domain.orgs.org_operations.RemoveUserFromOrgRequest(/, **data)#

Bases: pydantic.BaseModel

Request payload to remove a user from an organization.

Parameters

data Any

Attributes

RemoveUserFromOrgRequest.user_id

user_id str #

Unique identifier for the user to remove.

UpdateOrgRequest

class roboto.domain.orgs.org_operations.UpdateOrgRequest(/, **data)#

Bases: pydantic.BaseModel

Request payload to update an organization.

Parameters

data Any

Attributes

UpdateOrgRequest.updates

updates OrgRecordUpdates #

Organization field updates to apply.

UpdateOrgUserRequest

class roboto.domain.orgs.org_operations.UpdateOrgUserRequest(/, **data)#

Bases: pydantic.BaseModel

Request payload to update an organization user’s roles.

Parameters

data Any

Attributes

UpdateOrgUserRequest.add_roles

add_roles list[roboto.domain.orgs.org_records.OrgRoleName] | None = None #

Roles to add to the user.

UpdateOrgUserRequest.check_some_updates_present()

check_some_updates_present()#

Return type

UpdateOrgUserRequest

Attributes

UpdateOrgUserRequest.remove_roles

remove_roles list[roboto.domain.orgs.org_records.OrgRoleName] | None = None #

Roles to remove from the user.