External SoD API documentation version v1
http://example.com/ExtSODServices/
/externalSoD
Check if the entitlement present SoD risks, according to two distinct list entitlements: a list of entitlements to be added and a list of entitlements to be removed
Check if the input entitlement present SoD risks
post /externalSoD/risk/entitlement/{name}
Check if the entitlement present SoD risks, according to two distinct list entitlements: a list of entitlements to be added and a list of entitlements to be removed
URI Parameters
- name: required (string)
the entitlement name
Query Parameters
- functionality_type: (string)
the entitlement functionality type
- application_name: (string)
the entitlement application name
- type: (string)
the entitlement type
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-03/schema",
"type": "object",
"required": true,
"properties": {
"listEntitlements2Add": {
"type": "array",
"items": [
{
"type": "object",
"properties": {
"name": {
"type": "string"
},
"functionality_type": {
"type": "string"
},
"application_name": {
"type": "string"
},
"type": {
"type": "number"
}
}
}
]
},
"listEntitlements2Rem": {
"type": "array",
"items": [
{
"type": "object",
"properties": {
"name": {
"type": "string"
},
"functionality_type": {
"type": "string"
},
"application_name": {
"type": "string"
},
"type": {
"type": "number"
}
}
}
]
}
}
}Example:
{
"listEntitlements2Add" : [
{
"name" : "str1234" ,
"application_name" : "str1234" ,
"type" : 123 ,
"functionality_type" : "str1234"
} , {
"name" : "str1234" ,
"application_name" : "str1234" ,
"type" : 123 ,
"functionality_type" : "str1234"
}
] ,
"listEntitlements2Rem" : [
{
"name" : "str1234" ,
"application_name" : "str1234" ,
"type" : 123 ,
"functionality_type" : "str1234"
} , {
"name" : "str1234" ,
"application_name" : "str1234" ,
"type" : 123 ,
"functionality_type" : "str1234"
}
]
}HTTP status code 200
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-03/schema",
"type": "array",
"required": true,
"items": [
{
"type": "object",
"properties": {
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"riskLevel": {
"enum": [
"LOW",
"MEDIUM",
"HIGH"
]
},
"riskType_name": {
"type": "string"
},
"activities": {
"type": "array",
"items": [
{
"type": "object",
"properties": {
"name": {
"type": "string"
},
"code": {
"type": "string"
},
"description": {
"type": "string"
},
"path": {
"type": "string"
},
"riskHier": {
"type": "boolean"
},
"entitlementDetail": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"functionality_type": {
"type": "string"
},
"application_name": {
"type": "string"
},
"type": {
"type": "number"
}
}
},
"relatedPermissions": {
"type": "array",
"items": [
{
"type": "object",
"properties": {
"name": {
"type": "string"
},
"functionality_type": {
"type": "string"
},
"application_name": {
"type": "string"
},
"type": {
"type": "number"
}
}
}
]
}
}
}
]
}
}
}
]
}HTTP status code 500
The service has generated an internal server error which can be expressed by one of the following strings:
UNEXPECTED_ERROR = Generic internal server error
SAPGRC_UNREACHABLE = SAP GRC is unreachable
SAPGRC_ERROR = SAP GRC has generated an error
JSON_PARSE_ERROR = The received JSON object is not well formed
HTTP status code 501
The service hasn't been implemented
get /externalSoD/risk/entitlement/{name}
Check if the input entitlement presents SoD risks
URI Parameters
- name: required (string)
the entitlement name
Query Parameters
- functionality_type: (string)
the entitlement functionality type
- application_name: (string)
the entitlement application name
- type: (string)
the entitlement type
HTTP status code 200
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-03/schema",
"type": "array",
"required": true,
"items": [
{
"type": "object",
"properties": {
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"riskLevel": {
"enum": [
"LOW",
"MEDIUM",
"HIGH"
]
},
"riskType_name": {
"type": "string"
},
"activities": {
"type": "array",
"items": [
{
"type": "object",
"properties": {
"name": {
"type": "string"
},
"code": {
"type": "string"
},
"description": {
"type": "string"
},
"path": {
"type": "string"
},
"riskHier": {
"type": "boolean"
},
"entitlementDetail": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"functionality_type": {
"type": "string"
},
"application_name": {
"type": "string"
},
"type": {
"type": "number"
}
}
},
"relatedPermissions": {
"type": "array",
"items": [
{
"type": "object",
"properties": {
"name": {
"type": "string"
},
"functionality_type": {
"type": "string"
},
"application_name": {
"type": "string"
},
"type": {
"type": "number"
}
}
}
]
}
}
}
]
}
}
}
]
}HTTP status code 500
The service has generated an internal server error which can be expressed by one of the following strings:
UNEXPECTED_ERROR = Generic internal server error
SAPGRC_UNREACHABLE = SAP GRC is unreachable
SAPGRC_ERROR = SAP GRC has generated an error
HTTP status code 501
The service hasn't been implemented
Check if the entitlements can generate a set of SoD risks
post /externalSoD/risk/entitlements
Check if the entitlements can generate a set of SoD risks
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-03/schema",
"type": "array",
"required": true,
"items": [
{
"type": "object",
"properties": {
"name": {
"type": "string"
},
"functionality_type": {
"type": "string"
},
"application_name": {
"type": "string"
},
"type": {
"type": "number"
}
}
}
]
}Example:
[
{
"name" : "str1234" ,
"functionality_type" : "str1234" ,
"application_name" : "str1234" ,
"type" : 123
} , {
"name" : "str1234" ,
"functionality_type" : "str1234" ,
"application_name" : "str1234" ,
"type" : 123
}
]HTTP status code 200
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-03/schema",
"type": "array",
"required": true,
"items": [
{
"type": "object",
"properties": {
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"riskLevel": {
"enum": [
"LOW",
"MEDIUM",
"HIGH"
]
},
"riskType_name": {
"type": "string"
},
"activities": {
"type": "array",
"items": [
{
"type": "object",
"properties": {
"name": {
"type": "string"
},
"code": {
"type": "string"
},
"description": {
"type": "string"
},
"path": {
"type": "string"
},
"riskHier": {
"type": "boolean"
},
"entitlementDetail": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"functionality_type": {
"type": "string"
},
"application_name": {
"type": "string"
},
"type": {
"type": "number"
}
}
},
"relatedPermissions": {
"type": "array",
"items": [
{
"type": "object",
"properties": {
"name": {
"type": "string"
},
"functionality_type": {
"type": "string"
},
"application_name": {
"type": "string"
},
"type": {
"type": "number"
}
}
}
]
}
}
}
]
}
}
}
]
}HTTP status code 500
The service has generated an internal server error which can be expressed by one of the following strings:
UNEXPECTED_ERROR = Generic internal server error
SAPGRC_UNREACHABLE = SAP GRC is unreachable
SAPGRC_ERROR = SAP GRC has generated an error
JSON_PARSE_ERROR = The received JSON object is not well formed
HTTP status code 501
The service hasn't been implemented
Check if the group presents SoD risks related to a list of entitlements to be added
Check if the group presents SoD risks
post /externalSoD/risk/group/{ouCode}
Check if the group presents SoD risks related to a list of entitlements to be added
URI Parameters
- ouCode: required (string)
the group code
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-03/schema",
"type": "array",
"required": true,
"items": [
{
"type": "object",
"properties": {
"name": {
"type": "string"
},
"functionality_type": {
"type": "string"
},
"application_name": {
"type": "string"
},
"type": {
"type": "number"
}
}
}
]
}Example:
[
{
"name" : "str1234" ,
"functionality_type" : "str1234" ,
"application_name" : "str1234" ,
"type" : 123
} , {
"name" : "str1234" ,
"functionality_type" : "str1234" ,
"application_name" : "str1234" ,
"type" : 123
}
]HTTP status code 200
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-03/schema",
"type": "array",
"required": true,
"items": [
{
"type": "object",
"properties": {
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"riskLevel": {
"enum": [
"LOW",
"MEDIUM",
"HIGH"
]
},
"riskType_name": {
"type": "string"
},
"activities": {
"type": "array",
"items": [
{
"type": "object",
"properties": {
"name": {
"type": "string"
},
"code": {
"type": "string"
},
"description": {
"type": "string"
},
"path": {
"type": "string"
},
"riskHier": {
"type": "boolean"
},
"entitlementDetail": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"functionality_type": {
"type": "string"
},
"application_name": {
"type": "string"
},
"type": {
"type": "number"
}
}
},
"relatedPermissions": {
"type": "array",
"items": [
{
"type": "object",
"properties": {
"name": {
"type": "string"
},
"functionality_type": {
"type": "string"
},
"application_name": {
"type": "string"
},
"type": {
"type": "number"
}
}
}
]
}
}
}
]
}
}
}
]
}HTTP status code 500
The service has generated an internal server error which can be expressed by one of the following strings:
UNEXPECTED_ERROR = Generic internal server error
SAPGRC_UNREACHABLE = SAP GRC is unreachable
SAPGRC_ERROR = SAP GRC has generated an error
JSON_PARSE_ERROR = The received JSON object is not well formed
HTTP status code 501
The service hasn't been implemented
get /externalSoD/risk/group/{ouCode}
Check if the group presents SoD risks
URI Parameters
- ouCode: required (string)
the group code
HTTP status code 200
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-03/schema",
"type": "array",
"required": true,
"items": [
{
"type": "object",
"properties": {
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"riskLevel": {
"enum": [
"LOW",
"MEDIUM",
"HIGH"
]
},
"riskType_name": {
"type": "string"
},
"activities": {
"type": "array",
"items": [
{
"type": "object",
"properties": {
"name": {
"type": "string"
},
"code": {
"type": "string"
},
"description": {
"type": "string"
},
"path": {
"type": "string"
},
"riskHier": {
"type": "boolean"
},
"entitlementDetail": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"functionality_type": {
"type": "string"
},
"application_name": {
"type": "string"
},
"type": {
"type": "number"
}
}
},
"relatedPermissions": {
"type": "array",
"items": [
{
"type": "object",
"properties": {
"name": {
"type": "string"
},
"functionality_type": {
"type": "string"
},
"application_name": {
"type": "string"
},
"type": {
"type": "number"
}
}
}
]
}
}
}
]
}
}
}
]
}HTTP status code 500
The service has generated an internal server error which can be expressed by one of the following strings:
UNEXPECTED_ERROR = Generic internal server error
SAPGRC_UNREACHABLE = SAP GRC is unreachable
SAPGRC_ERROR = SAP GRC has generated an error
HTTP status code 501
The service hasn't been implemented
Check if the user presents SoD risks related to a list of entitlements to be added and a list of entitlements to be removed
Check if the user presents SoD risks
post /externalSoD/risk/user/{userid}
Check if the user presents SoD risks related to a list of entitlements to be added and a list of entitlements to be removed
URI Parameters
- userid: required (string)
the user code
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-03/schema",
"type": "object",
"required": true,
"properties": {
"listEntitlements2Add": {
"type": "array",
"items": [
{
"type": "object",
"properties": {
"name": {
"type": "string"
},
"functionality_type": {
"type": "string"
},
"application_name": {
"type": "string"
},
"type": {
"type": "number"
}
}
}
]
},
"listEntitlements2Rem": {
"type": "array",
"items": [
{
"type": "object",
"properties": {
"name": {
"type": "string"
},
"functionality_type": {
"type": "string"
},
"application_name": {
"type": "string"
},
"type": {
"type": "number"
}
}
}
]
}
}
}Example:
{
"listEntitlements2Add" : [
{
"name" : "str1234" ,
"functionality_type" : "str1234" ,
"application_name" : "str1234" ,
"type" : 123
} , {
"name" : "str1234" ,
"functionality_type" : "str1234" ,
"application_name" : "str1234" ,
"type" : 123
}
] ,
"listEntitlements2Rem" : [
{
"name" : "str1234" ,
"functionality_type" : "str1234" ,
"application_name" : "str1234" ,
"type" : 123
} , {
"name" : "str1234" ,
"functionality_type" : "str1234" ,
"application_name" : "str1234" ,
"type" : 123
}
]
}HTTP status code 200
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-03/schema",
"type": "array",
"required": true,
"items": [
{
"type": "object",
"properties": {
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"riskLevel": {
"enum": [
"LOW",
"MEDIUM",
"HIGH"
]
},
"riskType_name": {
"type": "string"
},
"activities": {
"type": "array",
"items": [
{
"type": "object",
"properties": {
"name": {
"type": "string"
},
"code": {
"type": "string"
},
"description": {
"type": "string"
},
"path": {
"type": "string"
},
"riskHier": {
"type": "boolean"
},
"entitlementDetail": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"functionality_type": {
"type": "string"
},
"application_name": {
"type": "string"
},
"type": {
"type": "number"
}
}
},
"relatedPermissions": {
"type": "array",
"items": [
{
"type": "object",
"properties": {
"name": {
"type": "string"
},
"functionality_type": {
"type": "string"
},
"application_name": {
"type": "string"
},
"type": {
"type": "number"
}
}
}
]
}
}
}
]
}
}
}
]
}HTTP status code 500
The service has generated an internal server error which can be expressed by one of the following strings:
UNEXPECTED_ERROR = Generic internal server error
SAPGRC_UNREACHABLE = SAP GRC is unreachable
SAPGRC_ERROR = SAP GRC has generated an error
JSON_PARSE_ERROR = The received JSON object is not well formed
HTTP status code 501
The service hasn't been implemented
get /externalSoD/risk/user/{userid}
Check if the user has a SoD risks
URI Parameters
- userid: required (string)
the user code
HTTP status code 200
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-03/schema",
"type": "array",
"required": true,
"items": [
{
"type": "object",
"properties": {
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"riskLevel": {
"enum": [
"LOW",
"MEDIUM",
"HIGH"
]
},
"riskType_name": {
"type": "string"
},
"activities": {
"type": "array",
"items": [
{
"type": "object",
"properties": {
"name": {
"type": "string"
},
"code": {
"type": "string"
},
"description": {
"type": "string"
},
"path": {
"type": "string"
},
"riskHier": {
"type": "boolean"
},
"entitlementDetail": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"functionality_type": {
"type": "string"
},
"application_name": {
"type": "string"
},
"type": {
"type": "number"
}
}
},
"relatedPermissions": {
"type": "array",
"items": [
{
"type": "object",
"properties": {
"name": {
"type": "string"
},
"functionality_type": {
"type": "string"
},
"application_name": {
"type": "string"
},
"type": {
"type": "number"
}
}
}
]
}
}
}
]
}
}
}
]
}HTTP status code 500
The service has generated an internal server error which can be expressed by one of the following strings:
UNEXPECTED_ERROR = Generic internal server error
SAPGRC_UNREACHABLE = SAP GRC is unreachable
SAPGRC_ERROR = SAP GRC has generated an error
HTTP status code 501
The service hasn't been implemented
Check if the user presents SoD risks related to a list of entitlements to be added and a list of entitlements to be removed
post /externalSoD/risk/user/{userid}/full
Check if the user presents SoD risks related to a list of entitlements to be added and a list of entitlements to be removed
URI Parameters
- userid: required (string)
the user code
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-03/schema",
"type": "object",
"required": true,
"properties": {
"listEntitlements2Add": {
"type": "array",
"items": [
{
"type": "object",
"properties": {
"name": {
"type": "string"
},
"functionality_type": {
"type": "string"
},
"application_name": {
"type": "string"
},
"type": {
"type": "number"
}
}
}
]
},
"listEntitlements2Rem": {
"type": "array",
"items": [
{
"type": "object",
"properties": {
"name": {
"type": "string"
},
"functionality_type": {
"type": "string"
},
"application_name": {
"type": "string"
},
"type": {
"type": "number"
}
}
}
]
}
}
}Example:
{
"listEntitlements2Add" : [
{
"name" : "str1234" ,
"functionality_type" : "str1234" ,
"application_name" : "str1234" ,
"type" : 123
} , {
"name" : "str1234" ,
"functionality_type" : "str1234" ,
"application_name" : "str1234" ,
"type" : 123
}
] ,
"listEntitlements2Rem" : [
{
"name" : "str1234" ,
"functionality_type" : "str1234" ,
"application_name" : "str1234" ,
"type" : 123
} , {
"name" : "str1234" ,
"functionality_type" : "str1234" ,
"application_name" : "str1234" ,
"type" : 123
}
]
}HTTP status code 200
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-03/schema",
"type": "object",
"required": true,
"properties": {
"currentRisk": {
"type": "array",
"items": [
{
"type": "object",
"properties": {
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"riskLevel": {
"enum": [
"LOW",
"MEDIUM",
"HIGH"
]
},
"riskType_name": {
"type": "string"
},
"activities": {
"type": "array",
"items": [
{
"type": "object",
"properties": {
"name": {
"type": "string"
},
"code": {
"type": "string"
},
"description": {
"type": "string"
},
"path": {
"type": "string"
},
"riskHier": {
"type": "boolean"
},
"entitlementDetail": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"functionality_type": {
"type": "string"
},
"application_name": {
"type": "string"
},
"type": {
"type": "number"
}
}
},
"relatedPermissions": {
"type": "array",
"items": [
{
"type": "object",
"properties": {
"name": {
"type": "string"
},
"functionality_type": {
"type": "string"
},
"application_name": {
"type": "string"
},
"type": {
"type": "number"
}
}
}
]
}
}
}
]
}
}
}
]
},
"afterRisk": {
"type": "array",
"items": [
{
"type": "object",
"properties": {
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"riskLevel": {
"enum": [
"LOW",
"MEDIUM",
"HIGH"
]
},
"riskType_name": {
"type": "string"
},
"activities": {
"type": "array",
"items": [
{
"type": "object",
"properties": {
"name": {
"type": "string"
},
"code": {
"type": "string"
},
"description": {
"type": "string"
},
"path": {
"type": "string"
},
"riskHier": {
"type": "boolean"
},
"entitlementDetail": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"functionality_type": {
"type": "string"
},
"application_name": {
"type": "string"
},
"type": {
"type": "number"
}
}
},
"relatedPermissions": {
"type": "array",
"items": [
{
"type": "object",
"properties": {
"name": {
"type": "string"
},
"functionality_type": {
"type": "string"
},
"application_name": {
"type": "string"
},
"type": {
"type": "number"
}
}
}
]
}
}
}
]
}
}
}
]
},
"deltaRisk": {
"type": "array",
"items": [
{
"type": "object",
"properties": {
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"riskLevel": {
"enum": [
"LOW",
"MEDIUM",
"HIGH"
]
},
"riskType_name": {
"type": "string"
},
"activities": {
"type": "array",
"items": [
{
"type": "object",
"properties": {
"name": {
"type": "string"
},
"code": {
"type": "string"
},
"description": {
"type": "string"
},
"path": {
"type": "string"
},
"riskHier": {
"type": "boolean"
},
"entitlementDetail": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"functionality_type": {
"type": "string"
},
"application_name": {
"type": "string"
},
"type": {
"type": "number"
}
}
},
"relatedPermissions": {
"type": "array",
"items": [
{
"type": "object",
"properties": {
"name": {
"type": "string"
},
"functionality_type": {
"type": "string"
},
"application_name": {
"type": "string"
},
"type": {
"type": "number"
}
}
}
]
}
}
}
]
}
}
}
]
},
"deletedRisk": {
"type": "array",
"items": [
{
"type": "object",
"properties": {
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"riskLevel": {
"enum": [
"LOW",
"MEDIUM",
"HIGH"
]
},
"riskType_name": {
"type": "string"
},
"activities": {
"type": "array",
"items": [
{
"type": "object",
"properties": {
"name": {
"type": "string"
},
"code": {
"type": "string"
},
"description": {
"type": "string"
},
"path": {
"type": "string"
},
"riskHier": {
"type": "boolean"
},
"entitlementDetail": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"functionality_type": {
"type": "string"
},
"application_name": {
"type": "string"
},
"type": {
"type": "number"
}
}
},
"relatedPermissions": {
"type": "array",
"items": [
{
"type": "object",
"properties": {
"name": {
"type": "string"
},
"functionality_type": {
"type": "string"
},
"application_name": {
"type": "string"
},
"type": {
"type": "number"
}
}
}
]
}
}
}
]
}
}
}
]
}
}
}HTTP status code 500
The service has generated an internal server error which can be expressed by one of the following strings:
UNEXPECTED_ERROR = Generic internal server error
SAPGRC_UNREACHABLE = SAP GRC is unreachable
SAPGRC_ERROR = SAP GRC has generated an error
JSON_PARSE_ERROR = The received JSON object is not well formed
HTTP status code 501
The service hasn't been implemented