RPC API documentation v34.4.0

Add User as a manager to SecurityTeam

Example URL

https://[hostname]/krb/rpc/json/securityTeamsManager/addAdmin

• see URL structure

Example params

{ "securityTeam" : 38 , "user" : 49 }

• see Passing params

Example response

null

• see Return values
• see HTTP return codes

Add group as a manager to SecurityTeam

Example URL

https://[hostname]/krb/rpc/json/securityTeamsManager/addAdmin

• see URL structure

Example params

{ "securityTeam" : 29 , "group" : 39 }

• see Passing params

Example response

null

• see Return values
• see HTTP return codes

Add user to blacklist of given SecurityTeam

Example URL

https://[hostname]/krb/rpc/json/securityTeamsManager/addUserToBlacklist

• see URL structure

Example params

{ "securityTeam" : 79 , "user" : 50 }

• see Passing params

Example response

null

• see Return values
• see HTTP return codes

Create SecurityTeam. SecurityTeam object must contain name which must match [-_a-zA-z0-9.]+ and not be longer than 128 characters. Parameter description is optional. Other parameters are ignored.

Example URL

https://[hostname]/krb/rpc/json/securityTeamsManager/createSecurityTeam

• see URL structure

Example params

{ "securityTeam" : { "name" : "My_new_security-team2" } }

• see Passing params

Example response

{ "id" : 924 , "name" : "CSIRT" , "description" : "My CSIRT" }

• see Return values
• see HTTP return codes

Create SecurityTeam.

Example URL

https://[hostname]/krb/rpc/json/securityTeamsManager/createSecurityTeam

• see URL structure

Example params

{ "name" : "My_new_security-team2" , "description" : "text" }

• see Passing params

Example response

{ "id" : 924 , "name" : "CSIRT" , "description" : "My CSIRT" }

• see Return values
• see HTTP return codes

Delete SecurityTeam by its id. If force is true team is deleted even if it has some users on blacklist or is assigned to some facility.

Example URL

https://[hostname]/krb/rpc/json/securityTeamsManager/deleteSecurityTeam

• see URL structure

Example params

{ "securityTeam" : 6 , "force" : true }

• see Passing params

Example response

null

• see Return values
• see HTTP return codes

Delete SecurityTeam by its id. If team has any users on blacklist or is assigned some facility, it is not deleted.

Example URL

https://[hostname]/krb/rpc/json/securityTeamsManager/deleteSecurityTeam

• see URL structure

Example params

{ "securityTeam" : 21 }

• see Passing params

Example response

null

• see Return values
• see HTTP return codes

Get all SecurityTeam groups of admins.

Example URL

https://[hostname]/krb/rpc/json/securityTeamsManager/getAdminGroups

• see URL structure

Example params

{ "securityTeam" : 33 }

• see Passing params

Example response

[ { "id" : 1061 , "name" : "My group" , "shortName" : "My group" , "description" : "My testing group" , "parentGroupId" : null , "voId" : 201 , "uuid" : "31e1014b-e994-4cb2-b238-e32aeef87670" , "beanName" : "Group" } , {...} , {...} ]

• see Return values
• see HTTP return codes

Get all managers (members) of SecurityTeam by its id.

Example URL

https://[hostname]/krb/rpc/json/securityTeamsManager/getAdmins

• see URL structure

Example params

{ "securityTeam" : 14 }

• see Passing params

Example response

[ { "firstName" : "Some" , "lastName" : "Body" , "middleName" : null , "titleBefore" : "Mgr." , "titleAfter" : null , "serviceUser" : false , "sponsoredUser" : false , "specificUser" : false , "majorSpecificType" : "NORMAL" , "id" : 34 , "uuid" : "5e5a02dd-f991-4706-a428-69c3ea6c5ce8" , "beanName" : "User" } , {...} , {...} ]

• see Return values
• see HTTP return codes

Get managers of SecurityTeam by its id. and indirect)

Example URL

https://[hostname]/krb/rpc/json/securityTeamsManager/getAdmins

• see URL structure

Example params

{ "securityTeam" : 46 , "onlyDirectAdmins" : true }

• see Passing params

Example response

[ { "firstName" : "Some" , "lastName" : "Body" , "middleName" : null , "titleBefore" : "Mgr." , "titleAfter" : null , "serviceUser" : false , "sponsoredUser" : false , "specificUser" : false , "majorSpecificType" : "NORMAL" , "id" : 34 , "uuid" : "5e5a02dd-f991-4706-a428-69c3ea6c5ce8" , "beanName" : "User" } , {...} , {...} ]

• see Return values
• see HTTP return codes

List all SecurityTeams in Perun.

Example URL

https://[hostname]/krb/rpc/json/securityTeamsManager/getAllSecurityTeams

• see URL structure

Example response

[ { "id" : 924 , "name" : "CSIRT" , "description" : "My CSIRT" } , {...} , {...} ]

• see Return values
• see HTTP return codes

Get blacklisted users on selected Facility. List is a union of all blacklists of SecurityTeams assigned to selected Facility.

Example URL

https://[hostname]/krb/rpc/json/securityTeamsManager/getBlacklist

• see URL structure

Example params

{ "facility" : 87 }

• see Passing params

Example response

[ { "firstName" : "Some" , "lastName" : "Body" , "middleName" : null , "titleBefore" : "Mgr." , "titleAfter" : null , "serviceUser" : false , "sponsoredUser" : false , "specificUser" : false , "majorSpecificType" : "NORMAL" , "id" : 34 , "uuid" : "5e5a02dd-f991-4706-a428-69c3ea6c5ce8" , "beanName" : "User" } , {...} , {...} ]

• see Return values
• see HTTP return codes

Get users blacklisted by selected SecurityTeam.

Example URL

https://[hostname]/krb/rpc/json/securityTeamsManager/getBlacklist

• see URL structure

Example params

{ "securityTeam" : 92 }

• see Passing params

Example response

[ { "firstName" : "Some" , "lastName" : "Body" , "middleName" : null , "titleBefore" : "Mgr." , "titleAfter" : null , "serviceUser" : false , "sponsoredUser" : false , "specificUser" : false , "majorSpecificType" : "NORMAL" , "id" : 34 , "uuid" : "5e5a02dd-f991-4706-a428-69c3ea6c5ce8" , "beanName" : "User" } , {...} , {...} ]

• see Return values
• see HTTP return codes

Get blacklisted users on selected Facility. List consists of Pairs. Left is a item from union of all blacklists of SecurityTeams assigned to selected Facility and right item is a description why the user is on the blacklist.

Example URL

https://[hostname]/krb/rpc/json/securityTeamsManager/getBlacklistWithDescription

• see URL structure

Example params

{ "facility" : 20 }

• see Passing params

Example response

[ { "left" : { "firstName" : "Some" , "lastName" : "Body" , "middleName" : null , "titleBefore" : "Mgr." , "titleAfter" : null , "serviceUser" : false , "sponsoredUser" : false , "specificUser" : false , "majorSpecificType" : "NORMAL" , "id" : 34 , "uuid" : "5e5a02dd-f991-4706-a428-69c3ea6c5ce8" , "beanName" : "User" } , "right" : "Some reason" } , {...} , {...} ]

• see Return values
• see HTTP return codes

Get users blacklisted by selected SecurityTeam with a description why the users are on the blacklist.

Example URL

https://[hostname]/krb/rpc/json/securityTeamsManager/getBlacklistWithDescription

• see URL structure

Example params

{ "securityTeam" : 22 }

• see Passing params

Example response

[ { "left" : { "firstName" : "Some" , "lastName" : "Body" , "middleName" : null , "titleBefore" : "Mgr." , "titleAfter" : null , "serviceUser" : false , "sponsoredUser" : false , "specificUser" : false , "majorSpecificType" : "NORMAL" , "id" : 34 , "uuid" : "5e5a02dd-f991-4706-a428-69c3ea6c5ce8" , "beanName" : "User" } , "right" : "Some reason" } , {...} , {...} ]

• see Return values
• see HTTP return codes

Get existing SecurityTeam by id.

Example URL

https://[hostname]/krb/rpc/json/securityTeamsManager/getSecurityTeamById

• see URL structure

Example params

{ "id" : 0 }

• see Passing params

Example response

{ "id" : 924 , "name" : "CSIRT" , "description" : "My CSIRT" }

• see Return values
• see HTTP return codes

List SecurityTeams your are member of or all for PerunAdmin.

Example URL

https://[hostname]/krb/rpc/json/securityTeamsManager/getSecurityTeams

• see URL structure

Example response

[ { "id" : 924 , "name" : "CSIRT" , "description" : "My CSIRT" } , {...} , {...} ]

• see Return values
• see HTTP return codes

Remove User as a manager from SecurityTeam.

Example URL

https://[hostname]/krb/rpc/json/securityTeamsManager/removeAdmin

• see URL structure

Example params

{ "securityTeam" : 26 , "user" : 6 }

• see Passing params

Example response

null

• see Return values
• see HTTP return codes

Remove group as a manager from SecurityTeam.

Example URL

https://[hostname]/krb/rpc/json/securityTeamsManager/removeAdmin

• see URL structure

Example params

{ "securityTeam" : 29 , "group" : 66 }

• see Passing params

Example response

null

• see Return values
• see HTTP return codes

Remove user from blacklist of given SecurityTeam

Example URL

https://[hostname]/krb/rpc/json/securityTeamsManager/removeUserFromBlacklist

• see URL structure

Example params

{ "securityTeam" : 44 , "user" : 23 }

• see Passing params

Example response

null

• see Return values
• see HTTP return codes

Update existing SecurityTeam name and description by teams id. Name must be <= 128 and must be unique.

Example URL

https://[hostname]/krb/rpc/json/securityTeamsManager/updateSecurityTeam

• see URL structure

Example params

{ "securityTeam" : { "id" : 924 , "name" : "CSIRT" , "description" : "My CSIRT" } }

• see Passing params

Example response

{ "id" : 924 , "name" : "CSIRT" , "description" : "My CSIRT" }

• see Return values
• see HTTP return codes