Headers
API key for network authentication
Body
Information about user and devices that they use to connect. If displayName is provided, the user's display name is updated as well.
If userId doesn't exist, a new user will be created.
authToken needs to be passed when network option is set to secure.
accessToken expires in 30 days by default.
Unique identifier for the user. Cannot start with 'ADMIN_' or 'DELETED_' prefixes.
1 - 50
Unique identifier for the device
1 - 150
Optional device information for analytics and debugging
User's display name (optional, will update user if provided)
100
User's profile handle (optional, will update user if provided)
100
Authentication token from /api/v3/authentication/token or /api/v4/authentication/token (required for secure networks)
1 - 100
Response
Session Information with access token and user data
JWT access token for API authentication
Token issuance timestamp
Token expiration timestamp
User information array
User roles array
Associated files array
Date of the last cache purge
Type of user (e.g., signed-in, visitor, bot)
signed-in
, visitor
, bot
"signed-in"