JOC API

/authentication/auth

POST

Reads accounts, roles permissions from Identity Service

Parameters in the POST body schema

Name	Type	Description	Example	Default
`identityServiceName`	required, string	The name of the idendityService that should be considered for this call	myService

Request

Name

Description

Example

Type

Constraints

Default

Headers

X-Access-Token*

Request requires authentication!

550e8400-e29b-11d4-a716-446655440000

string

Body

application/json

model | example

{
    "title": "Authentication configuration",
    "$schema": "http://json-schema.org/draft-04/schema#",
    "javaType": "com.sos.joc.model.security.configuration.SecurityConfiguration",
    "type": "object",
    "required": [
        "identityServiceName"
    ],
    "properties": {
        "deliveryDate": {
            "description": "Value is UTC timestamp in ISO 8601 YYYY-MM-DDThh:mm:ss.sZ or empty",
            "type": "string",
            "format": "date-time"
        },
        "identityServiceName": {
            "type": "string",
            "pattern": "^[^<>]*$",
            "maxLength": 255,
            "minLength": 1
        },
        "main": {
            "type": "array",
            "items": {
                "type": "object",
                "javaType": "com.sos.joc.model.security.configuration.SecurityConfigurationMainEntry",
                "required": [
                    "entryName",
                    "entryValue"
                ],
                "properties": {
                    "entryName": {
                        "type": "string"
                    },
                    "entryValue": {
                        "type": "array",
                        "items": {
                            "type": "string"
                        }
                    },
                    "entryComment": {
                        "type": "array",
                        "items": {
                            "type": "string"
                        }
                    }
                },
                "additionalProperties": false
            }
        },
        "accounts": {
            "type": "array",
            "items": {
                "type": "object",
                "javaType": "com.sos.joc.model.security.configuration.SecurityConfigurationAccount",
                "required": [
                    "accountName"
                ],
                "properties": {
                    "accountName": {
                        "type": "string"
                    },
                    "password": {
                        "type": "string"
                    },
                    "repeatedPassword": {
                        "type": "string"
                    },
                    "oldPassword": {
                        "type": "string"
                    },
                    "forcePasswordChange": {
                        "description": "controls if the account is forced to change the password",
                        "type": "boolean",
                        "default": false
                    },
                    "disabled": {
                        "description": "controls if the object is disabled",
                        "type": "boolean",
                        "default": false
                    },
                    "identityServiceId": {
                        "type": "number",
                        "format": "utc-millisec",
                        "minimum": 0
                    },
                    "roles": {
                        "type": "array",
                        "items": {
                            "type": "string"
                        }
                    }
                },
                "additionalProperties": false
            }
        },
        "profiles": {
            "type": "array",
            "items": {
                "type": "object",
                "javaType": "com.sos.joc.model.configuration.Profile",
                "properties": {
                    "account": {
                        "type": "string"
                    },
                    "lastLogin": {
                        "description": "Value is UTC timestamp in ISO 8601 YYYY-MM-DDThh:mm:ss.sZ or empty",
                        "type": "string",
                        "format": "date-time"
                    }
                },
                "additionalProperties": false
            }
        },
        "roles": {
            "javaType": "com.sos.joc.model.security.configuration.SecurityConfigurationRoles",
            "type": "object",
            "additionalProperties": {
                "javaType": "com.sos.joc.model.security.configuration.SecurityConfigurationRole",
                "type": "object",
                "properties": {
                    "folders": {
                        "javaType": "com.sos.joc.model.security.configuration.permissions.SecurityConfigurationFolders",
                        "type": "object",
                        "properties": {
                            "joc": {
                                "type": "array",
                                "items": {
                                    "type": "object",
                                    "javaType": "com.sos.joc.model.common.Folder",
                                    "required": [
                                        "folder"
                                    ],
                                    "properties": {
                                        "folder": {
                                            "description": "absolute path of an object.",
                                            "type": "string",
                                            "pattern": "^(/|(/[^/\\\\<>?:\"|*]+)+)$",
                                            "maxLength": 255,
                                            "minLength": 1
                                        },
                                        "recursive": {
                                            "type": "boolean",
                                            "default": true
                                        }
                                    },
                                    "additionalProperties": false
                                }
                            },
                            "controllers": {
                                "javaType": "com.sos.joc.model.security.configuration.permissions.ControllerFolders",
                                "type": "object",
                                "additionalProperties": {
                                    "type": "array",
                                    "items": {
                                        "type": "object",
                                        "javaType": "com.sos.joc.model.common.Folder",
                                        "required": [
                                            "folder"
                                        ],
                                        "properties": {
                                            "folder": {
                                                "description": "absolute path of an object.",
                                                "type": "string",
                                                "pattern": "^(/|(/[^/\\\\<>?:\"|*]+)+)$",
                                                "maxLength": 255,
                                                "minLength": 1
                                            },
                                            "recursive": {
                                                "type": "boolean",
                                                "default": true
                                            }
                                        },
                                        "additionalProperties": false
                                    }
                                }
                            }
                        },
                        "additionalProperties": false
                    },
                    "permissions": {
                        "javaType": "com.sos.joc.model.security.configuration.permissions.IniPermissions",
                        "type": "object",
                        "properties": {
                            "joc": {
                                "type": "array",
                                "items": {
                                    "javaType": "com.sos.joc.model.security.configuration.permissions.IniPermission",
                                    "type": "object",
                                    "required": [
                                        "permissionPath"
                                    ],
                                    "properties": {
                                        "permissionPath": {
                                            "type": "string",
                                            "pattern": "^[^<>]*$",
                                            "maxLength": 255,
                                            "minLength": 1
                                        },
                                        "excluded": {
                                            "type": "boolean"
                                        }
                                    },
                                    "additionalProperties": false
                                }
                            },
                            "controllerDefaults": {
                                "type": "array",
                                "items": {
                                    "javaType": "com.sos.joc.model.security.configuration.permissions.IniPermission",
                                    "type": "object",
                                    "required": [
                                        "permissionPath"
                                    ],
                                    "properties": {
                                        "permissionPath": {
                                            "type": "string",
                                            "pattern": "^[^<>]*$",
                                            "maxLength": 255,
                                            "minLength": 1
                                        },
                                        "excluded": {
                                            "type": "boolean"
                                        }
                                    },
                                    "additionalProperties": false
                                }
                            },
                            "controllers": {
                                "javaType": "com.sos.joc.model.security.configuration.permissions.IniControllers",
                                "type": "object",
                                "additionalProperties": {
                                    "type": "array",
                                    "items": {
                                        "javaType": "com.sos.joc.model.security.configuration.permissions.IniPermission",
                                        "type": "object",
                                        "required": [
                                            "permissionPath"
                                        ],
                                        "properties": {
                                            "permissionPath": {
                                                "type": "string",
                                                "pattern": "^[^<>]*$",
                                                "maxLength": 255,
                                                "minLength": 1
                                            },
                                            "excluded": {
                                                "type": "boolean"
                                            }
                                        },
                                        "additionalProperties": false
                                    }
                                }
                            }
                        },
                        "additionalProperties": false
                    }
                },
                "additionalProperties": false
            }
        },
        "auditLog": {
            "javaType": "com.sos.joc.model.audit.AuditParams",
            "type": "object",
            "properties": {
                "comment": {
                    "type": "string",
                    "pattern": "^[^<>]*$",
                    "maxLength": 255
                },
                "timeSpent": {
                    "type": "integer",
                    "minimum": 0
                },
                "ticketLink": {
                    "type": "string",
                    "pattern": "^[^<>]*$",
                    "maxLength": 255
                }
            }
        }
    },
    "additionalProperties": false
}

Responses

Code	Description	Body
200		application/json model \| example { "title": "Authentication configuration", "$schema": "http://json-schema.org/draft-04/schema#", "javaType": "com.sos.joc.model.security.configuration.SecurityConfiguration", "type": "object", "required": [ "identityServiceName" ], "properties": { "deliveryDate": { "description": "Value is UTC timestamp in ISO 8601 YYYY-MM-DDThh:mm:ss.sZ or empty", "type": "string", "format": "date-time" }, "identityServiceName": { "type": "string", "pattern": "^[^<>]$", "maxLength": 255, "minLength": 1 }, "main": { "type": "array", "items": { "type": "object", "javaType": "com.sos.joc.model.security.configuration.SecurityConfigurationMainEntry", "required": [ "entryName", "entryValue" ], "properties": { "entryName": { "type": "string" }, "entryValue": { "type": "array", "items": { "type": "string" } }, "entryComment": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false } }, "accounts": { "type": "array", "items": { "type": "object", "javaType": "com.sos.joc.model.security.configuration.SecurityConfigurationAccount", "required": [ "accountName" ], "properties": { "accountName": { "type": "string" }, "password": { "type": "string" }, "repeatedPassword": { "type": "string" }, "oldPassword": { "type": "string" }, "forcePasswordChange": { "description": "controls if the account is forced to change the password", "type": "boolean", "default": false }, "disabled": { "description": "controls if the object is disabled", "type": "boolean", "default": false }, "identityServiceId": { "type": "number", "format": "utc-millisec", "minimum": 0 }, "roles": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false } }, "profiles": { "type": "array", "items": { "type": "object", "javaType": "com.sos.joc.model.configuration.Profile", "properties": { "account": { "type": "string" }, "lastLogin": { "description": "Value is UTC timestamp in ISO 8601 YYYY-MM-DDThh:mm:ss.sZ or empty", "type": "string", "format": "date-time" } }, "additionalProperties": false } }, "roles": { "javaType": "com.sos.joc.model.security.configuration.SecurityConfigurationRoles", "type": "object", "additionalProperties": { "javaType": "com.sos.joc.model.security.configuration.SecurityConfigurationRole", "type": "object", "properties": { "folders": { "javaType": "com.sos.joc.model.security.configuration.permissions.SecurityConfigurationFolders", "type": "object", "properties": { "joc": { "type": "array", "items": { "type": "object", "javaType": "com.sos.joc.model.common.Folder", "required": [ "folder" ], "properties": { "folder": { "description": "absolute path of an object.", "type": "string", "pattern": "^(/\|(/[^/\\\\<>?:\"\|]+)+)$", "maxLength": 255, "minLength": 1 }, "recursive": { "type": "boolean", "default": true } }, "additionalProperties": false } }, "controllers": { "javaType": "com.sos.joc.model.security.configuration.permissions.ControllerFolders", "type": "object", "additionalProperties": { "type": "array", "items": { "type": "object", "javaType": "com.sos.joc.model.common.Folder", "required": [ "folder" ], "properties": { "folder": { "description": "absolute path of an object.", "type": "string", "pattern": "^(/\|(/[^/\\\\<>?:\"\|]+)+)$", "maxLength": 255, "minLength": 1 }, "recursive": { "type": "boolean", "default": true } }, "additionalProperties": false } } } }, "additionalProperties": false }, "permissions": { "javaType": "com.sos.joc.model.security.configuration.permissions.IniPermissions", "type": "object", "properties": { "joc": { "type": "array", "items": { "javaType": "com.sos.joc.model.security.configuration.permissions.IniPermission", "type": "object", "required": [ "permissionPath" ], "properties": { "permissionPath": { "type": "string", "pattern": "^[^<>]$", "maxLength": 255, "minLength": 1 }, "excluded": { "type": "boolean" } }, "additionalProperties": false } }, "controllerDefaults": { "type": "array", "items": { "javaType": "com.sos.joc.model.security.configuration.permissions.IniPermission", "type": "object", "required": [ "permissionPath" ], "properties": { "permissionPath": { "type": "string", "pattern": "^[^<>]$", "maxLength": 255, "minLength": 1 }, "excluded": { "type": "boolean" } }, "additionalProperties": false } }, "controllers": { "javaType": "com.sos.joc.model.security.configuration.permissions.IniControllers", "type": "object", "additionalProperties": { "type": "array", "items": { "javaType": "com.sos.joc.model.security.configuration.permissions.IniPermission", "type": "object", "required": [ "permissionPath" ], "properties": { "permissionPath": { "type": "string", "pattern": "^[^<>]$", "maxLength": 255, "minLength": 1 }, "excluded": { "type": "boolean" } }, "additionalProperties": false } } } }, "additionalProperties": false } }, "additionalProperties": false } }, "auditLog": { "javaType": "com.sos.joc.model.audit.AuditParams", "type": "object", "properties": { "comment": { "type": "string", "pattern": "^[^<>]$", "maxLength": 255 }, "timeSpent": { "type": "integer", "minimum": 0 }, "ticketLink": { "type": "string", "pattern": "^[^<>]$", "maxLength": 255 } } } }, "additionalProperties": false }
401	Unauthorized!	application/json model \| example { "title": "authentication", "$schema": "http://json-schema.org/draft-04/schema#", "type": "object", "required": [ "isAuthenticated" ], "properties": { "user": { "type": "string" }, "accessToken": { "type": "string" }, "message": { "type": "string" }, "role": { "type": "string" }, "isAuthenticated": { "type": "boolean" }, "isPermitted": { "type": "boolean", "default": false }, "sessionTimeout": { "type": "integer", "default": 1800 }, "enableTouch": { "type": "boolean", "default": true } } } { "user": "root", "message": "Oops!", "isAuthenticated": false, "isPermitted": false } { "user": "root", "message": "Oops!", "isAuthenticated": false, "isPermitted": false }
403	Forbidden! The user doesn't have sufficient permissions for 'auth'	application/json model \| example { "title": "authentication", "$schema": "http://json-schema.org/draft-04/schema#", "type": "object", "required": [ "isAuthenticated" ], "properties": { "user": { "type": "string" }, "accessToken": { "type": "string" }, "message": { "type": "string" }, "role": { "type": "string" }, "isAuthenticated": { "type": "boolean" }, "isPermitted": { "type": "boolean", "default": false }, "sessionTimeout": { "type": "integer", "default": 1800 }, "enableTouch": { "type": "boolean", "default": true } } } { "user": "root", "message": "You don't have sufficient permissions for ...", "role": "all", "isAuthenticated": true, "isPermitted": false } { "user": "root", "message": "You don't have sufficient permissions for ...", "role": "all", "isAuthenticated": true, "isPermitted": false }
420	'auth' failed!	application/json model \| example { "title": "error object with delivery date", "$schema": "http://json-schema.org/draft-04/schema#", "javaType": "com.sos.joc.model.common.Err420", "type": "object", "required": [ "deliveryDate", "error" ], "properties": { "deliveryDate": { "description": "Value is UTC timestamp in ISO 8601 YYYY-MM-DDThh:mm:ss.sZ or empty", "type": "string", "format": "date-time" }, "surveyDate": { "description": "Value is UTC timestamp in ISO 8601 YYYY-MM-DDThh:mm:ss.sZ or empty", "type": "string", "format": "date-time" }, "error": { "javaType": "com.sos.joc.model.common.Err", "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } { "deliveryDate": "2016-05-05T21:13:35Z", "surveyDate": "2016-05-05T21:13:33Z", "error": { "code": "JOC-420", "message": "auth failed!" } } { "deliveryDate": "2016-05-05T21:13:35Z", "surveyDate": "2016-05-05T21:13:33Z", "error": { "code": "JOC-420", "message": "auth failed!" } }
440	Login Timeout! The client's session has expired and must log in again.	application/json model \| example { "title": "authentication", "$schema": "http://json-schema.org/draft-04/schema#", "type": "object", "required": [ "isAuthenticated" ], "properties": { "user": { "type": "string" }, "accessToken": { "type": "string" }, "message": { "type": "string" }, "role": { "type": "string" }, "isAuthenticated": { "type": "boolean" }, "isPermitted": { "type": "boolean", "default": false }, "sessionTimeout": { "type": "integer", "default": 1800 }, "enableTouch": { "type": "boolean", "default": true } } } { "user": "root", "message": "Session has expired. Please log in again", "role": "all", "isAuthenticated": false, "isPermitted": false } { "user": "root", "message": "Session has expired. Please log in again", "role": "all", "isAuthenticated": false, "isPermitted": false }