JOC API

/authentication/auth/store (Roles and Permissions)

POST

Stores accounts, roles, permission to Identity Service

Parameters in the POST body schema

Name	Type	Description	Example
`identityServiceName`	required; string	The name of the idendityService	myService
`roles`	required, array	An array with roles that should be created or changed. If the role does not exist, it will be created. Otherwise it will be updated. Each Role have a name, folders and permissions
`folders`	required, array	An array with folders that can be accessed. The folders are "joc" folders or "controllers" folders. Each folder defines the folder and whether it is recursiv.	[ "folders": { "joc": [ { "folder": "/test", "recursive": true, } ], "controllers": { "test": [ { "folder": "/Defaults", "recursive": true }, { "folder": "/EmptyFolder", "recursive": true } ] } } ]
`permissions`	required, array	An array with permissions The permissions are devided into permissions for JOC and for controllers. There may be one section for each individuell controller. Each permission have a path as an identifier and whether this permission is excluded or included.	[ "permissions": { "joc": [ { "path": "sos:products:joc:administration:accounts", "excluded": false }, { "path": "sos:products:joc:administration:customization", "excluded": false },... "controllerDefaults": [ { "path": "sos:products:controller:view", "excluded": false }, "controllers": { "test": [ { "path": "sos:products:controller:terminate", "excluded": false }, ]
`auditLog`	optional, object	Object that contains `comment`, `timeSpent` and `ticketLink`.	{ "comment":"Operational requirement!", "timeSpent":2 }
`comment`	optional, string	Field in `auditLog` to comment this action, e.g. the reason.
`timeSpent`	optional, integer	Field in `auditLog` to enter the time spent in minutes.	5
`ticketLink`	optional, string	Field in `auditLog` to enter a link to a corresponding ticket.

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.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
        },
        "main": {
            "type": "array",
            "items": {
                "type": "object",
                "javaType": "com.sos.joc.model.security.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.SecurityConfigurationAccount",
                "required": [
                    "account"
                ],
                "properties": {
                    "account": {
                        "type": "string"
                    },
                    "password": {
                        "type": "string"
                    },
                    "hashedPassword": {
                        "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.permissions.SecurityConfigurationRoles",
            "type": "object",
            "additionalProperties": {
                "javaType": "com.sos.joc.model.security.permissions.SecurityConfigurationRole",
                "type": "object",
                "properties": {
                    "folders": {
                        "javaType": "com.sos.joc.model.security.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.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.IniPermissions",
                        "type": "object",
                        "properties": {
                            "joc": {
                                "type": "array",
                                "items": {
                                    "javaType": "com.sos.joc.model.security.permissions.IniPermission",
                                    "type": "object",
                                    "required": [
                                        "path"
                                    ],
                                    "properties": {
                                        "path": {
                                            "type": "string",
                                            "pattern": "^[^<>]*$",
                                            "maxLength": 255
                                        },
                                        "excluded": {
                                            "type": "boolean"
                                        }
                                    },
                                    "additionalProperties": false
                                }
                            },
                            "controllerDefaults": {
                                "type": "array",
                                "items": {
                                    "javaType": "com.sos.joc.model.security.permissions.IniPermission",
                                    "type": "object",
                                    "required": [
                                        "path"
                                    ],
                                    "properties": {
                                        "path": {
                                            "type": "string",
                                            "pattern": "^[^<>]*$",
                                            "maxLength": 255
                                        },
                                        "excluded": {
                                            "type": "boolean"
                                        }
                                    },
                                    "additionalProperties": false
                                }
                            },
                            "controllers": {
                                "javaType": "com.sos.joc.model.security.permissions.IniControllers",
                                "type": "object",
                                "additionalProperties": {
                                    "type": "array",
                                    "items": {
                                        "javaType": "com.sos.joc.model.security.permissions.IniPermission",
                                        "type": "object",
                                        "required": [
                                            "path"
                                        ],
                                        "properties": {
                                            "path": {
                                                "type": "string",
                                                "pattern": "^[^<>]*$",
                                                "maxLength": 255
                                            },
                                            "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	Confirm store (Roles and Permissions) successfully	application/json model \| example { "title": "ok answer", "$schema": "http://json-schema.org/draft-04/schema#", "javaType": "com.sos.joc.model.common.Ok", "type": "object", "required": [ "deliveryDate", "ok" ], "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" }, "ok": { "type": "boolean" } } } { "deliveryDate": "2020-05-05T21:13:35Z", "ok": true } { "deliveryDate": "2020-05-05T21:13:35Z", "ok": true }
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 'store (Roles and Permissions)'	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	'store (Roles and Permissions)' 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": "store (Roles and Permissions) failed!" } } { "deliveryDate": "2016-05-05T21:13:35Z", "surveyDate": "2016-05-05T21:13:33Z", "error": { "code": "JOC-420", "message": "store (Roles and Permissions) 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 }