/SecurityRole

Chapter Contents: 

Object introduced with API 3.11.0

Supported Methods

GET /SecurityRole 

Get a list of SecurityRole objects. Filter to avoid huge amounts of data (see Filtering for search parameters).

GET /SecurityRole/{key}

Get a single SecurityRole object.

PUT /SecurityRole/{key} 

Update an existing SecurityRole object. 

POST /SecurityRole 

Create a new SecurityRole object. 

DELETE /SecurityRole/{key} 

Delete a specific SecurityRole  object.

Properties

Property
Type
Length
Mandatory
Description
Comments
roleNameString64Yes  
securityPermissionsArray of /SecurityPermission    
dataControlRoleValuesArray of /DataControlRoleValue    
      

Updated for API version 2.0 using the new required date format yyyy-dd-MMThh:mi:ss to conform ISO 8601, (prior version has date format: yyyy-dd-MM hh:mi:ss)


GET /SecurityRole/345678
{
    "key": 345678,
    "self": "http://localhost:8080/ws/rest/SecurityControl/345678",
 	"securityPermissions": [
        {
            "key": 337003208,
            "self": "http://localhost:8080/ws/rest/SecurityPermission/337003208",
            "endpoint": {
                "key": 337001774,
                "self": "http://localhost:8080/ws/rest/Endpoint/337001774",
                "path": ".",
                "resourceName": "BvsHasBhl",
                "httpMethodType": "PUT",
                "isPrivate": null
            },
            "permissionName": "BvsHasBhl.PUT",
            "permissionType": {
                "key": 335343886,
                "self": "http://localhost:8080/ws/rest/PermissionType/335343886",
                "permissionTypeName": "endpoint"
            },
            "dataloyApp": null
        }
    ]
    "dataControlRoleValues": [
		  {
            "key": 336873833,
            "self": "http://localhost:8080/ws/rest/DataControlRoleValue/336873833",
            "role": {
                "key": 335927922,
                "self": "http://localhost:8080/ws/rest/SecurityRole/335927922"
            },
            "valueType": "Integer",
            "dataControl": {
                "key": 336855818,
                "self": "http://localhost:8080/ws/rest/DataControl/336855818",
                "matcherTarget": null,
                "matcherAttributeTarget": null,
                "objectName": "Document",
                "attribute": "businessPartner.key"
            },
            "value": "20867070"
        }
	],
    "isObjectActive": true,
    "remarks": []
}
 

Top
Back

Related Content

 Expand to see related content

Unknown macro: {dynamiccontentbylabel}