JOC API

/iam/identityservices

POST

Returns a collection of Identity Services

Parameters in the POST body schema

Name	Type	Description	Example	Default
`identityServiceName`	optional, string	The name of the idendityService	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": "IdentityService Filter",
    "$schema": "http://json-schema.org/draft-04/schema#",
    "javaType": "com.sos.joc.model.security.identityservice.IdentityServiceFilter",
    "type": "object",
    "properties": {
        "identityServiceName": {
            "type": "string",
            "pattern": "^[^<>]*$",
            "maxLength": 255
        },
        "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": "Identiy Services", "$schema": "http://json-schema.org/draft-04/schema#", "javaType": "com.sos.joc.model.security.identityservice.IdentityServices", "type": "object", "properties": { "deliveryDate": { "description": "Value is UTC timestamp in ISO 8601 YYYY-MM-DDThh:mm:ss.sZ or empty", "type": "string", "format": "date-time" }, "identityServiceItems": { "type": "array", "items": { "javaType": "com.sos.joc.model.security.identityservice.IdentityService", "type": "object", "required": [ "identityServiceName", "serviceAuthenticationScheme" ], "properties": { "identityServiceType": { "javaType": "com.sos.joc.model.security.identityservice.IdentityServiceTypes", "type": "string", "enum": [ "UNKNOWN", "VAULT", "VAULT-JOC", "VAULT-JOC-ACTIVE", "KEYCLOAK", "KEYCLOAK-JOC", "LDAP", "LDAP-JOC", "JOC" ] }, "identityServiceName": { "type": "string", "pattern": "^[^<>]$", "maxLength": 255, "minLength": 1 }, "serviceAuthenticationScheme": { "javaType": "com.sos.joc.model.security.identityservice.IdentityServiceAuthenticationScheme", "type": "string", "enum": [ "SINGLE-FACTOR", "TWO-FACTOR" ] }, "ordering": { "type": "integer", "minimum": 0 }, "disabled": { "description": "controls if the object is disabled", "type": "boolean", "default": false }, "singleFactorCert": { "description": "Identity Service allows logon via certificate", "type": "boolean", "default": false }, "singleFactorPwd": { "description": "Identity Service allows login via user account/password", "type": "boolean", "default": false }, "required": { "description": "controls if the identity service is required", "type": "boolean", "default": 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 } }, "identityServiceTypes": { "type": "array", "items": { "javaType": "com.sos.joc.model.security.identityservice.IdentityServiceTypes", "type": "string", "enum": [ "UNKNOWN", "VAULT", "VAULT-JOC", "VAULT-JOC-ACTIVE", "KEYCLOAK", "KEYCLOAK-JOC", "LDAP", "LDAP-JOC", "JOC" ] } } }, "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 'identityservices'	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	'identityservices' 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": "identityservices failed!" } } { "deliveryDate": "2016-05-05T21:13:35Z", "surveyDate": "2016-05-05T21:13:33Z", "error": { "code": "JOC-420", "message": "identityservices 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 }