sfgboxapi

UserRegister

**Requires Authentication**
Required role:	Admin

The following routes are available for this service:
POST	/userregister

import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class UserAuth:
    id: int = 0
    user_name: Optional[str] = None
    email: Optional[str] = None
    primary_email: Optional[str] = None
    phone_number: Optional[str] = None
    first_name: Optional[str] = None
    last_name: Optional[str] = None
    display_name: Optional[str] = None
    company: Optional[str] = None
    birth_date: Optional[datetime.datetime] = None
    birth_date_raw: Optional[str] = None
    address: Optional[str] = None
    address2: Optional[str] = None
    city: Optional[str] = None
    state: Optional[str] = None
    country: Optional[str] = None
    culture: Optional[str] = None
    full_name: Optional[str] = None
    gender: Optional[str] = None
    language: Optional[str] = None
    mail_address: Optional[str] = None
    nickname: Optional[str] = None
    postal_code: Optional[str] = None
    time_zone: Optional[str] = None
    salt: Optional[str] = None
    password_hash: Optional[str] = None
    digest_ha1_hash: Optional[str] = None
    roles: Optional[List[str]] = None
    permissions: Optional[List[str]] = None
    created_date: datetime.datetime = datetime.datetime(1, 1, 1)
    modified_date: datetime.datetime = datetime.datetime(1, 1, 1)
    invalid_login_attempts: int = 0
    last_login_attempt: Optional[datetime.datetime] = None
    locked_date: Optional[datetime.datetime] = None
    recovery_token: Optional[str] = None
    ref_id: Optional[int] = None
    ref_id_str: Optional[str] = None
    meta: Optional[Dict[str, str]] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class UserRegister:
    # @Validate(Validator="Email")
    e_mail: Optional[str] = None

    # @Validate(Validator="[NotNull,NotEmpty]")
    first_name: Optional[str] = None

    # @Validate(Validator="[NotNull,NotEmpty]")
    last_name: Optional[str] = None

    # @Validate(Validator="[NotNull,NotEmpty]")
    password: Optional[str] = None

    confirm_password: Optional[str] = None
    roles: Optional[List[str]] = None
    response_status: Optional[ResponseStatus] = None

Python UserRegister DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other

HTTP + OTHER

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /userregister HTTP/1.1 
Host: api.sfgtec.com 
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length

{"eMail":"String","firstName":"String","lastName":"String","password":"String","confirmPassword":"String","roles":["String"],"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}

HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

{"id":0,"userName":"String","email":"String","primaryEmail":"String","phoneNumber":"String","firstName":"String","lastName":"String","displayName":"String","company":"String","birthDate":"\/Date(-62135596800000-0000)\/","birthDateRaw":"String","address":"String","address2":"String","city":"String","state":"String","country":"String","culture":"String","fullName":"String","gender":"String","language":"String","mailAddress":"String","nickname":"String","postalCode":"String","timeZone":"String","salt":"String","passwordHash":"String","digestHa1Hash":"String","roles":["String"],"permissions":["String"],"createdDate":"\/Date(-62135596800000-0000)\/","modifiedDate":"\/Date(-62135596800000-0000)\/","invalidLoginAttempts":0,"lastLoginAttempt":"\/Date(-62135596800000-0000)\/","lockedDate":"\/Date(-62135596800000-0000)\/","recoveryToken":"String","refId":0,"refIdStr":"String","meta":{"String":"String"}}