Skip to content
Hugh Jeremy edited this page Mar 27, 2019 · 4 revisions

Documentation > User

A User is a human producer and consumer of data stored by Amatino. When you create an Amatino account at Amatino.io, a User is generated in your name. You can create other Users at will to serve the needs of your application. For example, you might wish to create an Amatino User to associate with each end-user of your application, in order to link financial information stored in Amatino with that end-user.

Users created via the Amatino API cannot login or otherwise interact with the amatino.io website in any way. They are not eligbile to receive customer support from us directly (though you are most welcome to request customer support to assist you with users you create), and don't generate associated discussion forum accounts. You have absolute control over their lifecycle. They can make requests to the Amatino API on their own behalf.

Generally, if you are creating User accounts for your fellow developers, you will want to do so in your billing dashboard. Doing so will allow them to manage their password, post to the discussion forums, and contact us for support. If you are creating Users to manage financial data inside your application, you will want to do so via the Amatino API.

Users and Entities are woven together using permission graphs. Any User may be granted read and or write access to any Account in any Entity, whether they were created in the billing dashboard or via the Amatino API.

If you are on a Fixed Price plan, each additional user you create in the Amatino API will count towards your monthly bill. If you are on a Pay Per Use plan, creating additional Users incurs no direct marginal cost. You can change your plan at any time.

Properties

.id_ - int

The integer identifier of this Amatino user. Unique across all of Amatino.

Example: 572423945834412


.email - Optional[str]

The email address of this User. If the User is a white-label user created via the Amatino API, this value will be None.

Example: clever@cookie.org


.name - Optional[str]

The name of this User. If the User is a white-label user created via the Amatino API, this value may be None.

Example: 'Tony Stark'


.handle - Optional[str]

A nickname for this User. This value will be None.

Example: 'Ironman'

.avatar_url - Optional[str]

The URL of an image representing this User. If the User is a white-label user created via the Amatino API, this value will be None.

Example: None

Methods

classmethod .create() -> User

Return a newly created User.

Parameters

  1. session - Session
  2. secret - str
  3. name - Optional[str]
  4. handle - Optional[str]

Example

elon = User.create(
  session=session,
  secret='very good passphrase',
  name='Elon Musk'
)

classmethod .retrieve() -> User

Return an existing User

Parameters

  1. session - Session
  2. id_ - int

Example

elon = User.retrieve(
  session=sessionl
  id_=8973009721414582153
)

.delete() -> None

Delete this User.

Parameters

None.

Example

elon = User.retrieve(
  session=sessionl
  id_=8973009721414582153
)

elon.delete()

Clone this wiki locally