JOC API

/configuration/login

GET

Send custom logo settings and default profile account if configured

Request

Name	Description	Example	Type	Constraints	Default

Responses

Code	Description	Headers	Body
200			application/json model \| example { "title": "login", "$schema": "http://json-schema.org/draft-04/schema#", "javaType": "com.sos.joc.model.configuration.Login", "type": "object", "properties": { "defaultProfileAccount": { "type": "string", "pattern": "^[^<>]$", "maxLength": 255 }, "enableRememberMe": { "type": "boolean" }, "customLogo": { "javaType": "com.sos.joc.model.configuration.LoginLogo", "type": "object", "required": [ "name" ], "properties": { "name": { "type": "string", "pattern": "^[^<>]$", "maxLength": 255 }, "height": { "type": "string", "pattern": "^[^<>]*$", "maxLength": 255 }, "position": { "javaType": "com.sos.joc.model.configuration.LoginLogoPosition", "type": "string", "enum": [ "TOP", "BOTTOM" ] } } } } } { "defaultProfileAccount": "root", "customLogo": { "name": "myLogo.png", "height": "100%", "position": "BOTTOM" } } { "defaultProfileAccount": "root", "customLogo": { "name": "myLogo.png", "height": "100%", "position": "BOTTOM" } }

Code

Description

Headers

Body

200

application/json

model | example

{
    "title": "login",
    "$schema": "http://json-schema.org/draft-04/schema#",
    "javaType": "com.sos.joc.model.configuration.Login",
    "type": "object",
    "properties": {
        "defaultProfileAccount": {
            "type": "string",
            "pattern": "^[^<>]*$",
            "maxLength": 255
        },
        "enableRememberMe": {
            "type": "boolean"
        },
        "customLogo": {
            "javaType": "com.sos.joc.model.configuration.LoginLogo",
            "type": "object",
            "required": [
                "name"
            ],
            "properties": {
                "name": {
                    "type": "string",
                    "pattern": "^[^<>]*$",
                    "maxLength": 255
                },
                "height": {
                    "type": "string",
                    "pattern": "^[^<>]*$",
                    "maxLength": 255
                },
                "position": {
                    "javaType": "com.sos.joc.model.configuration.LoginLogoPosition",
                    "type": "string",
                    "enum": [
                        "TOP",
                        "BOTTOM"
                    ]
                }
            }
        }
    }
}

{ "defaultProfileAccount": "root", "customLogo": { "name": "myLogo.png", "height": "100%", "position": "BOTTOM" } }

{
    "defaultProfileAccount": "root",
    "customLogo": {
        "name": "myLogo.png",
        "height": "100%",
        "position": "BOTTOM"
    }
}

POST