Login Message

This chapter focuses on the message showing in Squash TM Login Page.

Get login message

A GET to /login-message returns the login message.

HTTP request

GET /api/rest/latest/login-message HTTP/1.1
Accept: application/json
Host: localhost:8080

HTTP response

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 70

{
  "_type" : "login-message",
  "message" : "<h1>login Message<h1>"
}

Response fields

Path Type Description

_type

String

the type of the entity

message

String

the message to show on the login page of Squash TM

Modify login message

A PATCH to /login-message modifies the login message.

HTTP request

PATCH /api/rest/latest/login-message HTTP/1.1
Content-Type: application/json
Accept: application/json
Content-Length: 41
Host: localhost:8080

{
  "message" : "<h1>login Message<h1>"
}

Request fields

Path Type Description

message

String

the message to show on the login page of Squash TM (mandatory)

HTTP response

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 70

{
  "_type" : "login-message",
  "message" : "<h1>login Message<h1>"
}

Response fields

Path Type Description

_type

String

the type of the entity

message

String

the message to show on the login page of Squash TM