JOC API

/iam/account/permissions

POST

Returns the permissions for this account like they would be if login in with the given account name

Parameters in the POST body schema

Name	Type	Description	Example
`identityServiceName`	required, string	The name of the idendityService that should be considered for this call	myService
`accountName`	required, string	The name of the account	myAccount
`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.
`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": "Account Filter",
    "$schema": "http://json-schema.org/draft-04/schema#",
    "javaType": "com.sos.joc.model.security.accounts.AccountFilter",
    "type": "object",
    "required": [
        "accountName",
        "identityServiceName"
    ],
    "properties": {
        "identityServiceName": {
            "type": "string",
            "pattern": "^[^<>]*$",
            "maxLength": 255,
            "minLength": 1
        },
        "accountName": {
            "type": "string",
            "pattern": "^[^<>]*$",
            "maxLength": 255,
            "minLength": 1
        },
        "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": " Permissions", "$schema": "http://json-schema.org/draft-04/schema#", "javaType": "com.sos.joc.model.security.configuration.permissions.Permissions", "type": "object", "properties": { "roles": { "type": "array", "uniqueItems": true, "items": { "type": "string" } }, "joc": { "javaType": "com.sos.joc.model.security.configuration.permissions.JocPermissions", "type": "object", "properties": { "getLog": { "type": "boolean", "default": false }, "administration": { "javaType": "com.sos.joc.model.security.configuration.permissions.joc.Administration", "type": "object", "properties": { "accounts": { "javaType": "com.sos.joc.model.security.configuration.permissions.joc.admin.Accounts", "type": "object", "properties": { "view": { "type": "boolean", "default": false }, "manage": { "type": "boolean", "default": false } }, "additionalProperties": false }, "settings": { "javaType": "com.sos.joc.model.security.configuration.permissions.joc.admin.Settings", "type": "object", "properties": { "view": { "type": "boolean", "default": false }, "manage": { "type": "boolean", "default": false } }, "additionalProperties": false }, "controllers": { "javaType": "com.sos.joc.model.security.configuration.permissions.joc.admin.Controllers", "type": "object", "properties": { "view": { "type": "boolean", "default": false }, "manage": { "type": "boolean", "default": false } }, "additionalProperties": false }, "certificates": { "javaType": "com.sos.joc.model.security.configuration.permissions.joc.admin.Certificates", "type": "object", "properties": { "view": { "type": "boolean", "default": false }, "manage": { "type": "boolean", "default": false } }, "additionalProperties": false }, "customization": { "javaType": "com.sos.joc.model.security.configuration.permissions.joc.admin.Customization", "type": "object", "properties": { "view": { "type": "boolean", "default": false }, "manage": { "type": "boolean", "default": false }, "share": { "description": "share/makePrvate", "type": "boolean", "default": false } }, "additionalProperties": false } }, "additionalProperties": false }, "cluster": { "javaType": "com.sos.joc.model.security.configuration.permissions.joc.Cluster", "type": "object", "properties": { "manage": { "type": "boolean", "default": false } }, "additionalProperties": false }, "inventory": { "javaType": "com.sos.joc.model.security.configuration.permissions.joc.Inventory", "type": "object", "properties": { "view": { "type": "boolean", "default": false }, "manage": { "description": "edit/restore/assign documentation", "type": "boolean", "default": false }, "deploy": { "description": "publishing depoyables and releasables", "type": "boolean", "default": false } }, "additionalProperties": false }, "calendars": { "javaType": "com.sos.joc.model.security.configuration.permissions.joc.Calendars", "type": "object", "properties": { "view": { "type": "boolean", "default": false } }, "additionalProperties": false }, "documentations": { "javaType": "com.sos.joc.model.security.configuration.permissions.joc.Documentations", "type": "object", "properties": { "view": { "description": "show/export", "type": "boolean", "default": false }, "manage": { "type": "boolean", "default": false } }, "additionalProperties": false }, "auditLog": { "javaType": "com.sos.joc.model.security.configuration.permissions.joc.AuditLog", "type": "object", "properties": { "view": { "type": "boolean", "default": false } }, "additionalProperties": false }, "dailyPlan": { "javaType": "com.sos.joc.model.security.configuration.permissions.joc.DailyPlan", "type": "object", "properties": { "view": { "description": "show tab, planned orders, history", "type": "boolean", "default": false }, "manage": { "description": "create daily plan, delete submissions", "type": "boolean", "default": false } }, "additionalProperties": false }, "fileTransfer": { "javaType": "com.sos.joc.model.security.configuration.permissions.joc.FileTransfer", "type": "object", "properties": { "view": { "description": "show history, configuration tab", "type": "boolean", "default": false }, "manage": { "type": "boolean", "default": false } }, "additionalProperties": false }, "notification": { "javaType": "com.sos.joc.model.security.configuration.permissions.joc.Notification", "type": "object", "properties": { "view": { "description": "configuration tab", "type": "boolean", "default": false }, "manage": { "type": "boolean", "default": false } }, "additionalProperties": false }, "others": { "javaType": "com.sos.joc.model.security.configuration.permissions.joc.Others", "type": "object", "properties": { "view": { "description": "configuration tab", "type": "boolean", "default": false }, "manage": { "type": "boolean", "default": false } }, "additionalProperties": false } }, "additionalProperties": false }, "controllerDefaults": { "javaType": "com.sos.joc.model.security.configuration.permissions.ControllerPermissions", "type": "object", "properties": { "view": { "type": "boolean", "default": false }, "restart": { "type": "boolean", "default": false }, "terminate": { "type": "boolean", "default": false }, "getLog": { "type": "boolean", "default": false }, "switchOver": { "type": "boolean", "default": false }, "deployments": { "javaType": "com.sos.joc.model.security.configuration.permissions.controller.Deployments", "type": "object", "properties": { "view": { "description": "show deployment history", "type": "boolean", "default": false }, "deploy": { "description": "add/update/remove releasable and deployable objects", "type": "boolean", "default": false } }, "additionalProperties": false }, "orders": { "javaType": "com.sos.joc.model.security.configuration.permissions.controller.Orders", "type": "object", "properties": { "view": { "description": "show order/task widget, overview, order/task history", "type": "boolean", "default": false }, "create": { "description": "add, generate, submit", "type": "boolean", "default": false }, "cancel": { "type": "boolean", "default": false }, "suspendResume": { "description": "suspend, resume", "type": "boolean", "default": false }, "modify": { "type": "boolean", "default": true }, "managePositions": { "description": "skip, unskip, stop, unstop workflow jobs and add/modify order with special start-/endposition", "type": "boolean", "default": true } }, "additionalProperties": false }, "agents": { "javaType": "com.sos.joc.model.security.configuration.permissions.controller.Agents", "type": "object", "properties": { "view": { "description": "show resource tab 'agents'", "type": "boolean", "default": false } }, "additionalProperties": false }, "noticeBoards": { "javaType": "com.sos.joc.model.security.configuration.permissions.controller.NoticeBoards", "type": "object", "properties": { "view": { "description": "show resource tab 'notice boards'", "type": "boolean", "default": true }, "post": { "description": "post notice", "type": "boolean", "default": false }, "delete": { "description": "delete notice", "type": "boolean", "default": false } }, "additionalProperties": false }, "locks": { "javaType": "com.sos.joc.model.security.configuration.permissions.controller.Locks", "type": "object", "properties": { "view": { "description": "show resource tab 'locks'", "type": "boolean", "default": true } }, "additionalProperties": false }, "workflows": { "javaType": "com.sos.joc.model.security.configuration.permissions.controller.Workflows", "type": "object", "properties": { "view": { "description": "show tab", "type": "boolean", "default": false } }, "additionalProperties": false } }, "additionalProperties": false }, "controllers": { "javaType": "com.sos.joc.model.security.configuration.permissions.Controllers", "type": "object", "additionalProperties": { "javaType": "com.sos.joc.model.security.configuration.permissions.ControllerPermissions", "type": "object", "properties": { "view": { "type": "boolean", "default": false }, "restart": { "type": "boolean", "default": false }, "terminate": { "type": "boolean", "default": false }, "getLog": { "type": "boolean", "default": false }, "switchOver": { "type": "boolean", "default": false }, "deployments": { "javaType": "com.sos.joc.model.security.configuration.permissions.controller.Deployments", "type": "object", "properties": { "view": { "description": "show deployment history", "type": "boolean", "default": false }, "deploy": { "description": "add/update/remove releasable and deployable objects", "type": "boolean", "default": false } }, "additionalProperties": false }, "orders": { "javaType": "com.sos.joc.model.security.configuration.permissions.controller.Orders", "type": "object", "properties": { "view": { "description": "show order/task widget, overview, order/task history", "type": "boolean", "default": false }, "create": { "description": "add, generate, submit", "type": "boolean", "default": false }, "cancel": { "type": "boolean", "default": false }, "suspendResume": { "description": "suspend, resume", "type": "boolean", "default": false }, "modify": { "type": "boolean", "default": true }, "managePositions": { "description": "skip, unskip, stop, unstop workflow jobs and add/modify order with special start-/endposition", "type": "boolean", "default": true } }, "additionalProperties": false }, "agents": { "javaType": "com.sos.joc.model.security.configuration.permissions.controller.Agents", "type": "object", "properties": { "view": { "description": "show resource tab 'agents'", "type": "boolean", "default": false } }, "additionalProperties": false }, "noticeBoards": { "javaType": "com.sos.joc.model.security.configuration.permissions.controller.NoticeBoards", "type": "object", "properties": { "view": { "description": "show resource tab 'notice boards'", "type": "boolean", "default": true }, "post": { "description": "post notice", "type": "boolean", "default": false }, "delete": { "description": "delete notice", "type": "boolean", "default": false } }, "additionalProperties": false }, "locks": { "javaType": "com.sos.joc.model.security.configuration.permissions.controller.Locks", "type": "object", "properties": { "view": { "description": "show resource tab 'locks'", "type": "boolean", "default": true } }, "additionalProperties": false }, "workflows": { "javaType": "com.sos.joc.model.security.configuration.permissions.controller.Workflows", "type": "object", "properties": { "view": { "description": "show tab", "type": "boolean", "default": false } }, "additionalProperties": false } }, "additionalProperties": false } } }, "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 '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	'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": "permissions failed!" } } { "deliveryDate": "2016-05-05T21:13:35Z", "surveyDate": "2016-05-05T21:13:33Z", "error": { "code": "JOC-420", "message": "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 }