Sign in

v1

latestOpenAPI 3.1.02026-07-24153164.0 KB
user-back-office-pam-user-controller

Register New User

Registers a new user within your organization on the TECS Platform.

Flow Overview:

  • Calls Useraccountws.Preregister consumer API.
  • Generates an email confirmation code and link.
  • Sends a confirmation email to the user.

Input Parameters:

  • firstName (optional): User's first name.
  • lastName (optional): User's last name.
  • email (mandatory, unique): User's email address.
  • dateOfBirth (optional): User's date of birth (format: dd.MM.yyyy).
  • street1 (optional): Primary address line.
  • street2 (optional): Secondary address line.
  • city (optional): User's city.
  • country (optional): User's country.
  • zip (optional): User's postal code.
  • salutation (optional): User's salutation (e.g., Mr., Ms.).
  • phone (optional): User's phone number.
  • identificationNumber (optional): User's identification number.
  • passportNumber (optional): User's passport number.
  • driverLicenceNumber (optional): User's driver's license number.
  • state (optional): User's state or region.
  • login (optional, unique): User login identifier.

Required Role:

  • BO_USERMANAGEMENT_REGISTER_USER

Authentication: Supports both Basic (Base64 encoded credentials: ID:password) and Bearer token authentication.

post/registerUser

Headers

Authorizationstring required

Authorization header using either: - Bearer token (e.g., "Bearer <token>") - Basic authentication (e.g., "Basic <Base64 encoded credentials>")

Request body

firstNamestring

User's first name.

lastNamestring

User's last name.

emailstring email required

User's email address (must be unique).

dateOfBirthstring

User's date of birth (expected format: dd.MM.yyyy).

street1string

Primary address line.

street2string

Secondary address line.

citystring

City where the user resides.

countrystring

User's country.

zipstring

Postal code.

salutationstring

User's salutation (e.g., Mr., Ms.).

phonestring

User's phone number.

identificationNumberstring

User's identification number.

passportNumberstring

User's passport number.

driverLicenceNumberstring

User's driver's license number.

statestring

User's state or region.

loginstring

User login identifier (should be unique).

modulestring

Module identifier (if applicable).

consumerLanguagestring

Preferred language for the user (e.g., 'en').

Example request

{
  "firstName": "UserName",
  "lastName": "UserSurname",
  "email": "user@mail.com",
  "dateOfBirth": "01.01.2000",
  "street1": "Potsdamer",
  "street2": "13",
  "city": "Berlin",
  "country": "Germany",
  "zip": "10783",
  "salutation": "Mr.",
  "phone": "+4991199009926",
  "identificationNumber": "19574328625",
  "passportNumber": "VH488314",
  "driverLicenceNumber": "DC357158",
  "state": "Berlin",
  "login": "userlogin",
  "module": "pam",
  "consumerLanguage": "en"
}

Response

User registered successfully.

responseCodeinteger

Response code (0 indicates success; non-zero indicates an error).

responseMessagestring

Human-readable response message.

consumerIdstring

User login or unique user identifier.

Example response

{
  "responseMessage": "OK",
  "consumerId": "userlogin"
}