steps.api.cloud_objects.cloud_user

Attributes

SYMBOLS
ALPHABET
CHAR_REPLACE_MAP

Classes

User	User class representing a user in the cloud system.

Module Contents

steps.api.cloud_objects.cloud_user.SYMBOLS = '*.!@#$%^&(){}[]:;<>,.?/~_+-=|\\'

steps.api.cloud_objects.cloud_user.ALPHABET = 'abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789*.!@#$%^&(){}[]:;<>,.?/~_+-=|\\'

steps.api.cloud_objects.cloud_user.CHAR_REPLACE_MAP

class steps.api.cloud_objects.cloud_user.User(first_name: str = '', last_name: str = '', user_id: int = -1, email: str = '', password: str = '', platform_ids: list[str] = [], is_admin: bool = False, priority: int = 2, company_id: int = None, **kwargs)

Bases: steps.api.cloud_objects.cloud_base.ACloudObject

User class representing a user in the cloud system.

This class handles all user-related operations including user creation, authentication, token management, and CRUD operations.

Parameters:

• first_name – User’s first name

• last_name – User’s last name

• user_id – User’s ID (defaults to -1 for new users)

• email – User’s email address

• password – User’s password

• platform_ids – List of platform IDs the user has access to

• is_admin – Whether the user has admin privileges

• priority – User’s priority level (default: 2)

• company_id – User’s company ID

• kwargs – Additional attributes to set on the user

EMAIL_KEY = 'email'

PASSWORD_KEY = 'password'

FIRST_NAME_KEY = 'first_name'

LAST_NAME_KEY = 'last_name'

PLATFORM_IDS_KEY = 'platform_ids'

IS_ADMIN_KEY = 'is_admin'

COMPANY_ID_KEY = 'company_id'

PRIORITY_KEY = 'priority'

classmethod get_object_name() → str

classmethod get_endpoint() → str

classmethod get_api(context: steps.api.utils.CloudContext) → steps.api.utils.Api

classmethod get_token_method() → str

get_token(token_type: steps.api.cloud_objects.cloud_base.TokenType) → None

Get a token of the specified type for this user.

Parameters:

token_type – Type of token to retrieve

Returns:

Token string for the requested token type

Raises:

NotImplementedError – If the token type is not supported

first_name: str = ''

last_name: str = ''

email: str = ''

password: str = ''

user_id: int

is_admin: bool = False

priority: int = 2

company_id: int = None

platform_ids: list[str] = []

job_tokens: list[steps.api.cloud_objects.cloud_token.JobToken] = []

login_token: steps.api.cloud_objects.cloud_token.LoginToken

api_key: steps.api.cloud_objects.cloud_token.ApiKey = None

keys() → list[str]

generate_data() → None

Generate email and password data for this user.

Creates a standardized email based on first and last name, and generates a secure random password that meets complexity requirements.

create(context: steps.api.utils.CloudContext, user: User) → None

Create this user in the cloud.

Parameters:

• context – Cloud context for API configuration

• user – User providing authentication for the creation

Raises:

• RuntimeError – If user creation fails

• AssertionError – If trying to create an admin user

read(context: steps.api.utils.CloudContext, user=None) → dict[str]

Read this user’s information from the cloud.

Parameters:

• context – Cloud context for API configuration

• user – User providing authentication (defaults to self)

Returns:

Dictionary with user data from response

Raises:

• RuntimeError – If reading user data fails

• AssertionError – If the user has not been created yet

update(context: steps.api.utils.CloudContext, user, update_dict: dict[str]) → None

Update this user’s information in the cloud.

Parameters:

• context – Cloud context for API configuration

• user – User providing authentication (defaults to self)

• update_dict – Dictionary with fields to update

Raises:

• RuntimeError – If updating user data fails

• AssertionError – If the user has not been created yet

delete(context: steps.api.utils.CloudContext, user: User) → None

Delete this user from the cloud.

Parameters:

• context – Cloud context for API configuration

• user – User providing authentication

Raises:

• RuntimeError – If deleting the user fails

• AssertionError – If the user has not been created or is an admin

log(context: steps.api.utils.CloudContext) → None

Login the user and obtain a login token.

Parameters:

context – Cloud context for API configuration

Raises:

AssertionError – If the user is not an admin and hasn’t been created

create_job_token(context: steps.api.utils.CloudContext, token_dict: dict[str]) → None

Create a job token for this user.

Parameters:

• context – Cloud context for API configuration

• token_dict – Dictionary with token parameters

Raises:

AssertionError – If the user hasn’t been created

create_api_key(context: steps.api.utils.CloudContext, api_key_dict: dict[str]) → None

Create an API key for this user.

Parameters:

• context – Cloud context for API configuration

• api_key_dict – Dictionary with API key parameters

Raises:

AssertionError – If the user hasn’t been created

classmethod list_all(context: steps.api.utils.CloudContext, admin: User) → list[User]

List all users in the cloud.

Parameters:

• context – Cloud context for API configuration

• admin – Admin user providing authentication

Returns:

List of User objects

Raises:

• RuntimeError – If listing users fails

• AssertionError – If the authenticating user is not an admin