Users#

User Definition#

A User in Dioptra represents an account which provides access to other resources (entrypoints, plugins, jobs, experiments, etc.).

User Attributes#

This section describes the attributes that define a User.

Required Attributes#

  • Username: (string) The name of the user. Used for authentication.

  • Password: (string) A password for the user. Used for authentication.

  • Email: (string) The email address of the user.

System-Managed State#

  • ID: (integer) Unique identifier assigned upon creation.

  • Groups: (List of Group IDs) List of groups that the user is in. Determines access to resources. Each user is in the Public Group by default.

  • Created On: (timestamp) When the User was created.

  • Last Modified On: (timestamp) When the User was last modified.

  • Last Login On: (timestamp) When the User last logged in.

  • Password Expires On: (timestamp) When the User’s password will expire.

Registration Interfaces#

Users can be created programmatically via the Python Client or the REST API. They can also be created through the web interface .

Using Python Client#

Create a User

UsersCollectionClient.create(username: str, email: str, password: str) → dioptra.client.users.T[source]#

Creates a Dioptra user.

Parameters

  • username – The username of the new user.

  • email – The email address of the new user.

  • password – The password to set for the new user.

Returns

The response from the Dioptra API.

Using REST API#

Users can be created directly via the HTTP API.

Create Users

See the POST /api/v1/users endpoint documentation for payload requirements.

See Also#