Role API
{ urn:com.soa.role.api } RoleAPI
The Roles API service provides operations for managing users in roles in a scope of a Resource(Business).
Note: All of these operations take the Resouce ID as a parameter. For example Business ID. To find out what the Business ID is for your installation, you can run the GET /api/properties operation (TenantBusinessID parameter in the response).
POST/rolesaddRole
Creates a new Role
Request:
POST /api/roles HTTP/1.1
Content-Type: application/json or application/vnd.soa.v83+json
Accept: application/json or application/vnd.soa.v83+json
Sample Request Body (application/json):
{
"roleName" : "TestRole",
"rolePrivileges":[
{
"type": "api",
"deny": "false",
"actions" : ["FullControl"]
},
{
"type": "group",
"deny": "false",
"actions": ["Read", "Add", "Modify", "Delete"]
}
]
}
Response:
HTTP/1.1 200 OK
{
"roleName" : "TestRole",
}
Parameters
Accepts application/json application/vnd.soa.v81+json application/xml application/vnd.soa.v81+xml application/vnd.soa.v83+json application/vnd.soa.v83+xml
Name
Type
Description
Model
body
entity
addRole
addRole {
rolePrivilege {
roleName( string )
rolePrivileges( Collection of rolePrivilege )
}
rolePrivilege {
deny( boolean, required )
type( string )
actions( Collection of string )
}
Reponse
Produces application/jsonapplication/vnd.soa.v81+jsonapplication/xmlapplication/vnd.soa.v81+xmlapplication/vnd.soa.v83+jsonapplication/vnd.soa.v83+xml
Status Code
Reason
Model
200
Success
anyType
GET/roles/{resourceID}getRoles
Returns the roles available in the system.
Request:
GET /api/roles/{ResourceDN} HTTP/1.1
Content-Type: application/json or application/vnd.soa.v83+json
Accept: application/json or application/vnd.soa.v83+json
Response:
HTTP/1.1 200 OK
[{
"roleName" : "2FA-exempt users",
"resourceID" : "tenantbusiness.eap",
"Link" : {
"rel" : "self",
"href" : "http://{hostname}/api/roles/{ResourceDN}/2FA-exempt%20users"
}
}, {
"roleName" : "API Administrator",
"resourceID" : "tenantbusiness.eap",
"Link" : {
"rel" : "self",
"href" : "http://{hostname}/api/roles/{ResourceDN}/API%20Administrator"
}
}, {
"roleName" : "API Developer",
"resourceID" : "tenantbusiness.eap",
"Link" : {
"rel" : "self",
"href" : "http://{hostname}/api/roles/{ResourceDN}/API%20Developer"
}
},
{
"roleName" : "Tenant Manager",
"resourceID" : "tenantbusiness.eap",
"Link" : {
"rel" : "self",
"href" : http://{hostname}/api/roles/{ResourceDN}/Tenant%20Manager"
}
} ]
Parameters
Name
Type
Description
Model
resourceID
path
Parameter for DN of Business or API or App
string
Reponse
Produces application/jsonapplication/vnd.soa.v81+jsonapplication/xmlapplication/vnd.soa.v81+xmlapplication/vnd.soa.v83+jsonapplication/vnd.soa.v83+xml
Status Code
Reason
Model
200
Success
anyType
DELETE/roles/{roleName}deleteRole
Deletes a role
Request:
DELETE /api/roles/{roleName} HTTP/1.1
Content-Type: */*
Accept: text/plain
Response:
HTTP/1.1 200 OK
TestRole
Parameters
Accepts */*
Name
Type
Description
Model
roleName
path
Role Name
string
Reponse
Produces text/plain
Status Code
Reason
Model
200
Success
string
PUT/roles/{resourceID}/{roleName}updateUsersAssignedToRole
Replaces users assigned to a role.
Request:
PUT /api/roles/{ResourceDN}/{roleName} HTTP/1.1
Content-Type: application/json or application/vnd.soa.v83+json
Accept: application/json or application/vnd.soa.v83+json
Sample Request Body (application/json):
{
"users":[
{
"userID": "d3f5e5b3-8f63-41ad-a990-be6aaa1cb07d.eap"
},
{
"userID": "be327b61-789e-4fae-a165-a34010635fab.eap"
}
]
}
Response:
HTTP/1.1 200 OK
{
"roleName" : "Guest",
"resourceID" : "tenantbusiness.eap",
"users" : [ {
"userID" : "d3f5e5b3-8f63-41ad-a990-be6aaa1cb07d.eap",
"fullName" : "admin eap"
}, {
"userID" : "be327b61-789e-4fae-a165-a34010635fab.eap",
"fullName" : "Stephan Poachman"
} ],
"Link" : {
"rel" : "self",
"href" : "http://localhost:9900/api/roles/tenantbusiness.eap/Guest"
}
}
Parameters
Accepts application/json application/vnd.soa.v81+json application/xml application/vnd.soa.v81+xml application/vnd.soa.v83+json application/vnd.soa.v83+xml
Name
Type
Description
Model
resourceID
path
Parameter for DN of Business or API or App
string
roleName
path
Role Name
string
body
entity
roleUsers
roleUsers {}
Reponse
Produces application/jsonapplication/vnd.soa.v81+jsonapplication/xmlapplication/vnd.soa.v81+xmlapplication/vnd.soa.v83+jsonapplication/vnd.soa.v83+xml
Status Code
Reason
Model
200
Success
anyType
GET/roles/{resourceID}/{roleName}getRole
Returns the information about a given business type including its avatar.
Request:
GET /api/roles/{ResourceDN}/{roleName} HTTP/1.1
Content-Type: application/json or application/vnd.soa.v83+json
Accept: application/json or application/vnd.soa.v83+json
Response:
HTTP/1.1 200 OK
{
"roleName" : "{RoleName}",
"resourceID" : "{ResourceDN}",
"users" : [ {
"userID" : "d3f5e5b3-8f63-41ad-a990-be6aaa1cb07d.eap",
"fullName" : "admin eap"
}, {
"userID" : "be327b61-789e-4fae-a165-a34010635fab.eap",
"fullName" : "Stephan Poachman"
} ],
"Link" : {
"rel" : "self",
"href" : "http://{hostName}/api/roles/{ResourceDN}/{RoleName}"
}
}
Parameters
Name
Type
Description
Model
resourceID
path
Parameter for DN of Business or API or App
string
roleName
path
Role name
string
Reponse
Produces application/jsonapplication/vnd.soa.v81+jsonapplication/xmlapplication/vnd.soa.v81+xmlapplication/vnd.soa.v83+jsonapplication/vnd.soa.v83+xml
Status Code
Reason
Model
200
Success
anyType