Skip to main content
POST
Create customer session

Headers

X-Forwarded-For
string
required
Example:

"127.0.0.1"

X-Tenant-ID
string
required
Example:

"tenant-demo-001"

sec-ch-ua-platform
string
X-Forwarded-From
string
required

Client source identifier

Example:

"client-app"

platform
string
required

Client platform

Example:

"mobile"

deviceId
string
required

Device identifier

Example:

"device-demo-001"

Path Parameters

customerId
string<uuid>
required
Example:

"00000000-0000-0000-0000-000000000000"

userId
string<uuid>
required
Example:

"00000000-0000-0000-0000-000000000000"

Body

application/json

Create individual session request

username
string

Username used for customer login

Example:

"customer.login.123456@example.test"

password
string

Customer password for session creation

Example:

"SecurePass123!"

tenantKey
string

Tenant key credential used by auth service

Example:

"a1B2c3D4e5F6g7H8i9J0kLmNopQr"

tenantSecret
string

Tenant secret credential used by auth service

Example:

"s3Cr3tKeyXyZpQwErTyUiOpAsDfGh"

credentialType
string

Credential type for alternative auth flows

Example:

"PASSWORD"

value
string

Credential value used with credentialType-based auth

Example:

"customer.login.123456@example.test"

tenantId
string

Tenant UUID for session context

Example:

"11111111-2222-4333-8444-555555555555"

Response

Session created

Standard API response wrapper with session in data

code
integer<int32>

HTTP-style status code

Example:

200

data
object

Session tokens and metadata

message
string

Result message

Example:

"Success"