Adds a Facility admin.
Parameter name | Data type | Description |
---|---|---|
facilityName | String | Facility name |
user | int | User id |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
void |
Example URL
https://[hostname]/krb/rpc/json/facilitiesManager/addAdmin
Example params
{ "facilityName" : "text" , "user" : 15 }
Example response
null
Adds a group administrator to the Facility.
Parameter name | Data type | Description |
---|---|---|
facilityName | String | Facility name |
authorizedGroup | int | Group id |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
void |
Example URL
https://[hostname]/krb/rpc/json/facilitiesManager/addAdmin
Example params
{ "facilityName" : "text" , "authorizedGroup" : 96 }
Example response
null
Adds a Facility admin.
Parameter name | Data type | Description |
---|---|---|
facility | int | Facility id |
user | int | User id |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
void |
Example URL
https://[hostname]/krb/rpc/json/facilitiesManager/addAdmin
Example params
{ "facility" : 48 , "user" : 4 }
Example response
null
Adds a group administrator to the Facility.
Parameter name | Data type | Description |
---|---|---|
facility | int | Facility id |
authorizedGroup | int | Group id |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
void |
Example URL
https://[hostname]/krb/rpc/json/facilitiesManager/addAdmin
Example params
{ "facility" : 70 , "authorizedGroup" : 61 }
Example response
null
Adds host to a Facility.
Parameter name | Data type | Description |
---|---|---|
hostname | String | Hostname |
facilityName | String | Facility name |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
Host | Host with id set. |
Example URL
https://[hostname]/krb/rpc/json/facilitiesManager/addHost
Example params
{ "hostname" : "text" , "facilityName" : "text" }
Example response
{ "id" : 523 , "hostname" : "host1.host.cz" }
Adds host to a Facility.
Parameter name | Data type | Description |
---|---|---|
hostname | String | Hostname |
facility | int | Facility id |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
Host | Host with id set. |
Example URL
https://[hostname]/krb/rpc/json/facilitiesManager/addHost
Example params
{ "hostname" : "text" , "facility" : 90 }
Example response
{ "id" : 523 , "hostname" : "host1.host.cz" }
Adds hosts to the Facility.
Parameter name | Data type | Description |
---|---|---|
hostnames | List<String> | Host names |
facilityName | String | Facility name |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
List<Host> | Hosts with id 's set. |
Example URL
https://[hostname]/krb/rpc/json/facilitiesManager/addHosts
Example params
{ "hostnames" : [ "text" , "text" ] , "facilityName" : "text" }
Example response
[ { "id" : 523 , "hostname" : "host1.host.cz" } , {...} , {...} ]
Adds hosts to the Facility.
Parameter name | Data type | Description |
---|---|---|
hostnames | List<String> | Host names |
facility | int | Facility id |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
List<Host> | Hosts with id 's set. |
Example URL
https://[hostname]/krb/rpc/json/facilitiesManager/addHosts
Example params
{ "hostnames" : [ "text" , "text" ] , "facility" : 51 }
Example response
[ { "id" : 523 , "hostname" : "host1.host.cz" } , {...} , {...} ]
Add owner of a facility.
Parameter name | Data type | Description |
---|---|---|
facilityName | String | Facility name |
ownerName | String | Owner name |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
void |
Example URL
https://[hostname]/krb/rpc/json/facilitiesManager/addOwner
Example params
{ "facilityName" : "text" , "ownerName" : "text" }
Example response
null
Add owner of a facility.
Parameter name | Data type | Description |
---|---|---|
facilityName | String | Facility name |
owner | int | Owner id |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
void |
Example URL
https://[hostname]/krb/rpc/json/facilitiesManager/addOwner
Example params
{ "facilityName" : "text" , "owner" : 94 }
Example response
null
Add owner of a facility.
Parameter name | Data type | Description |
---|---|---|
facility | int | Facility id |
ownerName | String | Owner name |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
void |
Example URL
https://[hostname]/krb/rpc/json/facilitiesManager/addOwner
Example params
{ "facility" : 4 , "ownerName" : "text" }
Example response
null
Add owner of a facility.
Parameter name | Data type | Description |
---|---|---|
facility | int | Facility id |
owner | int | Owner id |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
void |
Example URL
https://[hostname]/krb/rpc/json/facilitiesManager/addOwner
Example params
{ "facility" : 10 , "owner" : 78 }
Example response
null
Add owners of a facility.
Parameter name | Data type | Description |
---|---|---|
facilityName | String | Facility name |
ownerNames | List<String> | Owner name |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
void |
Example URL
https://[hostname]/krb/rpc/json/facilitiesManager/addOwners
Example params
{ "facilityName" : "text" , "ownerNames" : [ "text" , "text" ] }
Example response
null
Add owners of a facility.
Parameter name | Data type | Description |
---|---|---|
facilityName | String | Facility name |
owners | List<int> | Owner id |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
void |
Example URL
https://[hostname]/krb/rpc/json/facilitiesManager/addOwners
Example params
{ "facilityName" : "text" , "owners" : {...} }
Example response
null
Add owners of a facility.
Parameter name | Data type | Description |
---|---|---|
facility | int | Facility id |
ownerNames | List<String> | Owner name |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
void |
Example URL
https://[hostname]/krb/rpc/json/facilitiesManager/addOwners
Example params
{ "facility" : 34 , "ownerNames" : [ "text" , "text" ] }
Example response
null
Add owners of a facility.
Parameter name | Data type | Description |
---|---|---|
facility | int | Facility id |
owners | List<int> | Owner id |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
void |
Example URL
https://[hostname]/krb/rpc/json/facilitiesManager/addOwners
Example params
{ "facility" : 68 , "owners" : {...} }
Example response
null
Assign given security team to given facility (means the facility trusts the security team)
Parameter name | Data type | Description |
---|---|---|
facilityName | String | Facility name |
securityTeam | int | SecurityTeam id |
Thrown exception | Description |
---|---|
FacilityNotExistsException | When Facility with given name doesn't exists. |
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
SecurityTeamAlreadyAssignedException | When SecurityTeam with given id is already assigned. |
SecurityTeamNotExistsException | When SecurityTeam with given id doesn't exists. |
Return type | Description |
---|---|
void |
Example URL
https://[hostname]/krb/rpc/json/facilitiesManager/assignSecurityTeam
Example params
{ "facilityName" : "text" , "securityTeam" : 5 }
Example response
null
Assign given security team to given facility (means the facility trusts the security team)
Parameter name | Data type | Description |
---|---|---|
facility | int | Facility id |
securityTeam | int | SecurityTeam id |
Thrown exception | Description |
---|---|
FacilityNotExistsException | When Facility with given id doesn't exists. |
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
SecurityTeamAlreadyAssignedException | When SecurityTeam with given id is already assigned. |
SecurityTeamNotExistsException | When SecurityTeam with given id doesn't exists. |
Return type | Description |
---|---|
void |
Example URL
https://[hostname]/krb/rpc/json/facilitiesManager/assignSecurityTeam
Example params
{ "facility" : 45 , "securityTeam" : 94 }
Example response
null
Copy attributes (settings) from source facility to destination facility. You must be facility manager of both.
Parameter name | Data type | Description |
---|---|---|
srcFacilityName | String | facility name |
destFacilityName | String | facility name |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
void |
Example URL
https://[hostname]/krb/rpc/json/facilitiesManager/copyAttributes
Example params
{ "srcFacilityName" : "text" , "destFacilityName" : "text" }
Example response
null
Copy attributes (settings) from source facility to destination facility. You must be facility manager of both.
Parameter name | Data type | Description |
---|---|---|
srcFacility | int | facility id |
destFacilityName | String | facility name |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
void |
Example URL
https://[hostname]/krb/rpc/json/facilitiesManager/copyAttributes
Example params
{ "srcFacility" : 48 , "destFacilityName" : "text" }
Example response
null
Copy attributes (settings) from source facility to destination facility. You must be facility manager of both.
Parameter name | Data type | Description |
---|---|---|
srcFacilityName | String | facility name |
destFacility | int | facility id |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
void |
Example URL
https://[hostname]/krb/rpc/json/facilitiesManager/copyAttributes
Example params
{ "srcFacilityName" : "text" , "destFacility" : 33 }
Example response
null
Copy attributes (settings) from source facility to destination facility. You must be facility manager of both.
Parameter name | Data type | Description |
---|---|---|
srcFacility | int | facility id |
destFacility | int | facility id |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
void |
Example URL
https://[hostname]/krb/rpc/json/facilitiesManager/copyAttributes
Example params
{ "srcFacility" : 21 , "destFacility" : 91 }
Example response
null
Copy managers from source facility to destination facility. You must be facility manager of both.
Parameter name | Data type | Description |
---|---|---|
srcFacilityName | String | facility name |
destFacilityName | String | facility name |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
void |
Example URL
https://[hostname]/krb/rpc/json/facilitiesManager/copyManagers
Example params
{ "srcFacilityName" : "text" , "destFacilityName" : "text" }
Example response
null
Copy managers from source facility to destination facility. You must be facility manager of both.
Parameter name | Data type | Description |
---|---|---|
srcFacility | int | facility id |
destFacilityName | String | facility name |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
void |
Example URL
https://[hostname]/krb/rpc/json/facilitiesManager/copyManagers
Example params
{ "srcFacility" : 39 , "destFacilityName" : "text" }
Example response
null
Copy managers from source facility to destination facility. You must be facility manager of both.
Parameter name | Data type | Description |
---|---|---|
srcFacilityName | String | facility name |
destFacility | int | facility id |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
void |
Example URL
https://[hostname]/krb/rpc/json/facilitiesManager/copyManagers
Example params
{ "srcFacilityName" : "text" , "destFacility" : 16 }
Example response
null
Copy managers from source facility to destination facility. You must be facility manager of both.
Parameter name | Data type | Description |
---|---|---|
srcFacility | int | facility id |
destFacility | int | facility id |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
void |
Example URL
https://[hostname]/krb/rpc/json/facilitiesManager/copyManagers
Example params
{ "srcFacility" : 65 , "destFacility" : 25 }
Example response
null
Copy owners from source facility to destination facility. You must be facility manager of both.
Parameter name | Data type | Description |
---|---|---|
srcFacilityName | String | facility name |
destFacilityName | String | facility name |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
void |
Example URL
https://[hostname]/krb/rpc/json/facilitiesManager/copyOwners
Example params
{ "srcFacilityName" : "text" , "destFacilityName" : "text" }
Example response
null
Copy owners from source facility to destination facility. You must be facility manager of both.
Parameter name | Data type | Description |
---|---|---|
srcFacility | int | facility id |
destFacilityName | String | facility name |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
void |
Example URL
https://[hostname]/krb/rpc/json/facilitiesManager/copyOwners
Example params
{ "srcFacility" : 96 , "destFacilityName" : "text" }
Example response
null
Copy owners from source facility to destination facility. You must be facility manager of both.
Parameter name | Data type | Description |
---|---|---|
srcFacilityName | String | facility name |
destFacility | int | facility id |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
void |
Example URL
https://[hostname]/krb/rpc/json/facilitiesManager/copyOwners
Example params
{ "srcFacilityName" : "text" , "destFacility" : 37 }
Example response
null
Copy owners from source facility to destination facility. You must be facility manager of both.
Parameter name | Data type | Description |
---|---|---|
srcFacility | int | facility id |
destFacility | int | facility id |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
void |
Example URL
https://[hostname]/krb/rpc/json/facilitiesManager/copyOwners
Example params
{ "srcFacility" : 97 , "destFacility" : 95 }
Example response
null
Creates a facility. Caller is automatically set as facility manager. Facility Object must contain name which can contain only a-Z0-9.-_ and space characters. Parameter description is optional. Other parameters are ignored.
Parameter name | Data type | Description |
---|---|---|
facility | Facility | JSON object |
Thrown exception | Description |
---|---|
ConsentHubExistsException | if consent hub with facility name exists |
FacilityExistsException | if facility already exists |
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
Facility | Created Facility object |
Example URL
https://[hostname]/krb/rpc/json/facilitiesManager/createFacility
Example params
{ "facility" : { "name" : "the best-facility_7" } }
Example response
{ "id" : 24 , "name" : "host.facility.cz" , "description" : "is optional" , "beanName" : "Facility" }
Creates a facility. Caller is automatically set as facility manager.
Parameter name | Data type | Description |
---|---|---|
name | String | name of a facility - can contain only a-Z0-9.-_ and space characters. |
description | String | description of a facility |
Thrown exception | Description |
---|---|
ConsentHubExistsException | if consent hub with facility name exists |
FacilityExistsException | if facility already exists |
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
Facility | Created Facility object |
Example URL
https://[hostname]/krb/rpc/json/facilitiesManager/createFacility
Example params
{ "name" : "the best-facility_7" , "description" : "A description with information." }
Example response
{ "id" : 24 , "name" : "host.facility.cz" , "description" : "is optional" , "beanName" : "Facility" }
Deletes a facility.
Parameter name | Data type | Description |
---|---|---|
facilityName | String | Facility name |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
void |
Example URL
https://[hostname]/krb/rpc/json/facilitiesManager/deleteFacility
Example params
{ "facilityName" : "text" }
Example response
null
Deletes a facility.
Parameter name | Data type | Description |
---|---|---|
facilityName | String | Facility name |
force | Boolean | if true deletes all constrains of facility before deleting facility |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
void |
Example URL
https://[hostname]/krb/rpc/json/facilitiesManager/deleteFacility
Example params
{ "facilityName" : "text" , "force" : {...} }
Example response
null
Deletes a facility.
Parameter name | Data type | Description |
---|---|---|
facility | int | Facility id |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
void |
Example URL
https://[hostname]/krb/rpc/json/facilitiesManager/deleteFacility
Example params
{ "facility" : 19 }
Example response
null
Deletes a facility.
Parameter name | Data type | Description |
---|---|---|
facility | int | Facility id |
force | Boolean | if true deletes all constrains of facility before deleting facility |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
void |
Example URL
https://[hostname]/krb/rpc/json/facilitiesManager/deleteFacility
Example params
{ "facility" : 7 , "force" : {...} }
Example response
null
Get all Facility group admins.
Parameter name | Data type | Description |
---|---|---|
facilityName | String | Facility name |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
List<Group> | admins |
Example URL
https://[hostname]/krb/rpc/json/facilitiesManager/getAdminGroups
Example params
{ "facilityName" : "text" }
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" } , {...} , {...} ]
Get all Facility group admins.
Parameter name | Data type | Description |
---|---|---|
facility | int | Facility id |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
List<Group> | admins |
Example URL
https://[hostname]/krb/rpc/json/facilitiesManager/getAdminGroups
Example params
{ "facility" : 15 }
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" } , {...} , {...} ]
Get list of all facility administrators for supported role and given facility. If some group is administrator of the given group, all VALID members are included in the list. If onlyDirectAdmins is == true, return only direct admins of the group for supported role. Supported roles: FacilityAdmin
Parameter name | Data type | Description |
---|---|---|
facilityName | String | Facility name |
onlyDirectAdmins | boolean | if true, get only direct facility administrators (if false, get both direct and indirect) |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
List<User> | list of all facility administrators of the given facility for supported role |
Example URL
https://[hostname]/krb/rpc/json/facilitiesManager/getAdmins
Example params
{ "facilityName" : "text" , "onlyDirectAdmins" : true }
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" } , {...} , {...} ]
Get all Facility admins.
Parameter name | Data type | Description |
---|---|---|
facilityName | String | Facility name |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
List<User> | List of Users who are admins in the facility. |
Example URL
https://[hostname]/krb/rpc/json/facilitiesManager/getAdmins
Example params
{ "facilityName" : "text" }
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" } , {...} , {...} ]
Get list of all facility administrators for supported role and given facility. If some group is administrator of the given group, all VALID members are included in the list. If onlyDirectAdmins is == true, return only direct admins of the group for supported role. Supported roles: FacilityAdmin
Parameter name | Data type | Description |
---|---|---|
facility | int | Facility id |
onlyDirectAdmins | boolean | if true, get only direct facility administrators (if false, get both direct and indirect) |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
List<User> | list of all facility administrators of the given facility for supported role |
Example URL
https://[hostname]/krb/rpc/json/facilitiesManager/getAdmins
Example params
{ "facility" : 28 , "onlyDirectAdmins" : true }
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" } , {...} , {...} ]
Get all Facility admins.
Parameter name | Data type | Description |
---|---|---|
facility | int | Facility id |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
List<User> | List of Users who are admins in the facility. |
Example URL
https://[hostname]/krb/rpc/json/facilitiesManager/getAdmins
Example params
{ "facility" : 40 }
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" } , {...} , {...} ]
Get all assigned groups on Facility.
Parameter name | Data type | Description |
---|---|---|
facilityName | String | Facility name |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
List<Group> | assigned groups |
Example URL
https://[hostname]/krb/rpc/json/facilitiesManager/getAllowedGroups
Example params
{ "facilityName" : "text" }
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" } , {...} , {...} ]
Get all assigned groups on Facility filtered by VO.
Parameter name | Data type | Description |
---|---|---|
facilityName | String | Facility name |
vo | int | Vo id to filter groups by |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
List<Group> | assigned groups |
Example URL
https://[hostname]/krb/rpc/json/facilitiesManager/getAllowedGroups
Example params
{ "facilityName" : "text" , "vo" : 80 }
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" } , {...} , {...} ]
Get all assigned groups on Facility filtered by Service.
Parameter name | Data type | Description |
---|---|---|
facilityName | String | Facility name |
service | int | Service id to filter groups by |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
List<Group> | assigned groups |
Example URL
https://[hostname]/krb/rpc/json/facilitiesManager/getAllowedGroups
Example params
{ "facilityName" : "text" , "service" : 12 }
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" } , {...} , {...} ]
Get all assigned groups on Facility filtered by VO and Service.
Parameter name | Data type | Description |
---|---|---|
facilityName | String | Facility name |
vo | int | Vo id to filter groups by |
service | int | Service id to filter groups by |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
List<Group> | assigned groups |
Example URL
https://[hostname]/krb/rpc/json/facilitiesManager/getAllowedGroups
Example params
{ "facilityName" : "text" , "vo" : 74 , "service" : 35 }
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" } , {...} , {...} ]
Get all assigned groups on Facility.
Parameter name | Data type | Description |
---|---|---|
facility | int | Facility id |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
List<Group> | assigned groups |
Example URL
https://[hostname]/krb/rpc/json/facilitiesManager/getAllowedGroups
Example params
{ "facility" : 44 }
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" } , {...} , {...} ]
Get all assigned groups on Facility filtered by VO.
Parameter name | Data type | Description |
---|---|---|
facility | int | Facility id |
vo | int | Vo id to filter groups by |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
List<Group> | assigned groups |
Example URL
https://[hostname]/krb/rpc/json/facilitiesManager/getAllowedGroups
Example params
{ "facility" : 44 , "vo" : 15 }
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" } , {...} , {...} ]
Get all assigned groups on Facility filtered by Service.
Parameter name | Data type | Description |
---|---|---|
facility | int | Facility id |
service | int | Service id to filter groups by |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
List<Group> | assigned groups |
Example URL
https://[hostname]/krb/rpc/json/facilitiesManager/getAllowedGroups
Example params
{ "facility" : 88 , "service" : 13 }
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" } , {...} , {...} ]
Get all assigned groups on Facility filtered by VO and Service.
Parameter name | Data type | Description |
---|---|---|
facility | int | Facility id |
vo | int | Vo id to filter groups by |
service | int | Service id to filter groups by |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
List<Group> | assigned groups |
Example URL
https://[hostname]/krb/rpc/json/facilitiesManager/getAllowedGroups
Example params
{ "facility" : 72 , "vo" : 40 , "service" : 30 }
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" } , {...} , {...} ]
Get all assigned RichGroups on Facility with specified set of attributes.
Parameter name | Data type | Description |
---|---|---|
facilityName | String | Facility name |
attrNames | List<String> | Attribute names |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
List<RichGroup> | assigned groups |
Example URL
https://[hostname]/krb/rpc/json/facilitiesManager/getAllowedRichGroupsWithAttributes
Example params
{ "facilityName" : "text" , "attrNames" : [ "urn:perun:group:attribute-def:core:name" , "urn:perun:group:attribute-def:def:synchronizationEnabled" ] }
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" : "RichGroup" , "attributes" : [ { "value" : null , "type" : "java.lang.String" , "entity" : "group" , "namespace" : "urn:perun:group:attribute-def:def" , "friendlyName" : "synchronizationEnabled" , "writable" : true , "baseFriendlyName" : "synchronizationEnabled" , "friendlyNameParameter" : "" , "unique" : false , "displayName" : "Synchronization enabled" , "description" : "Enables group synchronization from external source." , "id" : 103 , "beanName" : "Attribute" } ] } , {...} , {...} ]
Get all assigned RichGroups on Facility filtered by VO with specified set of attributes.
Parameter name | Data type | Description |
---|---|---|
facilityName | String | Facility name |
vo | int | Vo id to filter groups by |
attrNames | List<String> | Attribute names |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
List<RichGroup> | assigned groups |
Example URL
https://[hostname]/krb/rpc/json/facilitiesManager/getAllowedRichGroupsWithAttributes
Example params
{ "facilityName" : "text" , "vo" : 9 , "attrNames" : [ "urn:perun:group:attribute-def:core:name" , "urn:perun:group:attribute-def:def:synchronizationEnabled" ] }
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" : "RichGroup" , "attributes" : [ { "value" : null , "type" : "java.lang.String" , "entity" : "group" , "namespace" : "urn:perun:group:attribute-def:def" , "friendlyName" : "synchronizationEnabled" , "writable" : true , "baseFriendlyName" : "synchronizationEnabled" , "friendlyNameParameter" : "" , "unique" : false , "displayName" : "Synchronization enabled" , "description" : "Enables group synchronization from external source." , "id" : 103 , "beanName" : "Attribute" } ] } , {...} , {...} ]
Get all assigned RichGroups on Facility filtered by Service with specified set of attributes.
Parameter name | Data type | Description |
---|---|---|
facilityName | String | Facility name |
service | int | Service id to filter groups by |
attrNames | List<String> | Attribute names |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
List<RichGroup> | assigned groups |
Example URL
https://[hostname]/krb/rpc/json/facilitiesManager/getAllowedRichGroupsWithAttributes
Example params
{ "facilityName" : "text" , "service" : 3 , "attrNames" : [ "urn:perun:group:attribute-def:core:name" , "urn:perun:group:attribute-def:def:synchronizationEnabled" ] }
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" : "RichGroup" , "attributes" : [ { "value" : null , "type" : "java.lang.String" , "entity" : "group" , "namespace" : "urn:perun:group:attribute-def:def" , "friendlyName" : "synchronizationEnabled" , "writable" : true , "baseFriendlyName" : "synchronizationEnabled" , "friendlyNameParameter" : "" , "unique" : false , "displayName" : "Synchronization enabled" , "description" : "Enables group synchronization from external source." , "id" : 103 , "beanName" : "Attribute" } ] } , {...} , {...} ]
Get all assigned RichGroups on Facility filtered by VO and Service with specified set of attributes.
Parameter name | Data type | Description |
---|---|---|
facilityName | String | Facility name |
vo | int | Vo id to filter groups by |
service | int | Service id to filter groups by |
attrNames | List<String> | Attribute names |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
List<RichGroup> | assigned groups |
Example URL
https://[hostname]/krb/rpc/json/facilitiesManager/getAllowedRichGroupsWithAttributes
Example params
{ "facilityName" : "text" , "vo" : 79 , "service" : 40 , "attrNames" : [ "urn:perun:group:attribute-def:core:name" , "urn:perun:group:attribute-def:def:synchronizationEnabled" ] }
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" : "RichGroup" , "attributes" : [ { "value" : null , "type" : "java.lang.String" , "entity" : "group" , "namespace" : "urn:perun:group:attribute-def:def" , "friendlyName" : "synchronizationEnabled" , "writable" : true , "baseFriendlyName" : "synchronizationEnabled" , "friendlyNameParameter" : "" , "unique" : false , "displayName" : "Synchronization enabled" , "description" : "Enables group synchronization from external source." , "id" : 103 , "beanName" : "Attribute" } ] } , {...} , {...} ]
Get all assigned RichGroups on Facility with specified set of attributes.
Parameter name | Data type | Description |
---|---|---|
facility | int | Facility id |
attrNames | List<String> | Attribute names |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
List<RichGroup> | assigned groups |
Example URL
https://[hostname]/krb/rpc/json/facilitiesManager/getAllowedRichGroupsWithAttributes
Example params
{ "facility" : 33 , "attrNames" : [ "urn:perun:group:attribute-def:core:name" , "urn:perun:group:attribute-def:def:synchronizationEnabled" ] }
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" : "RichGroup" , "attributes" : [ { "value" : null , "type" : "java.lang.String" , "entity" : "group" , "namespace" : "urn:perun:group:attribute-def:def" , "friendlyName" : "synchronizationEnabled" , "writable" : true , "baseFriendlyName" : "synchronizationEnabled" , "friendlyNameParameter" : "" , "unique" : false , "displayName" : "Synchronization enabled" , "description" : "Enables group synchronization from external source." , "id" : 103 , "beanName" : "Attribute" } ] } , {...} , {...} ]
Get all assigned RichGroups on Facility filtered by VO with specified set of attributes.
Parameter name | Data type | Description |
---|---|---|
facility | int | Facility id |
vo | int | Vo id to filter groups by |
attrNames | List<String> | Attribute names |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
List<RichGroup> | assigned groups |
Example URL
https://[hostname]/krb/rpc/json/facilitiesManager/getAllowedRichGroupsWithAttributes
Example params
{ "facility" : 85 , "vo" : 95 , "attrNames" : [ "urn:perun:group:attribute-def:core:name" , "urn:perun:group:attribute-def:def:synchronizationEnabled" ] }
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" : "RichGroup" , "attributes" : [ { "value" : null , "type" : "java.lang.String" , "entity" : "group" , "namespace" : "urn:perun:group:attribute-def:def" , "friendlyName" : "synchronizationEnabled" , "writable" : true , "baseFriendlyName" : "synchronizationEnabled" , "friendlyNameParameter" : "" , "unique" : false , "displayName" : "Synchronization enabled" , "description" : "Enables group synchronization from external source." , "id" : 103 , "beanName" : "Attribute" } ] } , {...} , {...} ]
Get all assigned RichGroups on Facility filtered by Service with specified set of attributes.
Parameter name | Data type | Description |
---|---|---|
facility | int | Facility id |
service | int | Service id to filter groups by |
attrNames | List<String> | Attribute names |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
List<RichGroup> | assigned groups |
Example URL
https://[hostname]/krb/rpc/json/facilitiesManager/getAllowedRichGroupsWithAttributes
Example params
{ "facility" : 78 , "service" : 36 , "attrNames" : [ "urn:perun:group:attribute-def:core:name" , "urn:perun:group:attribute-def:def:synchronizationEnabled" ] }
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" : "RichGroup" , "attributes" : [ { "value" : null , "type" : "java.lang.String" , "entity" : "group" , "namespace" : "urn:perun:group:attribute-def:def" , "friendlyName" : "synchronizationEnabled" , "writable" : true , "baseFriendlyName" : "synchronizationEnabled" , "friendlyNameParameter" : "" , "unique" : false , "displayName" : "Synchronization enabled" , "description" : "Enables group synchronization from external source." , "id" : 103 , "beanName" : "Attribute" } ] } , {...} , {...} ]
Get all assigned RichGroups on Facility filtered by VO and Service with specified set of attributes.
Parameter name | Data type | Description |
---|---|---|
facility | int | Facility id |
vo | int | Vo id to filter groups by |
service | int | Service id to filter groups by |
attrNames | List<String> | Attribute names |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
List<RichGroup> | assigned groups |
Example URL
https://[hostname]/krb/rpc/json/facilitiesManager/getAllowedRichGroupsWithAttributes
Example params
{ "facility" : 10 , "vo" : 89 , "service" : 2 , "attrNames" : [ "urn:perun:group:attribute-def:core:name" , "urn:perun:group:attribute-def:def:synchronizationEnabled" ] }
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" : "RichGroup" , "attributes" : [ { "value" : null , "type" : "java.lang.String" , "entity" : "group" , "namespace" : "urn:perun:group:attribute-def:def" , "friendlyName" : "synchronizationEnabled" , "writable" : true , "baseFriendlyName" : "synchronizationEnabled" , "friendlyNameParameter" : "" , "unique" : false , "displayName" : "Synchronization enabled" , "description" : "Enables group synchronization from external source." , "id" : 103 , "beanName" : "Attribute" } ] } , {...} , {...} ]
Return all users which can use this facility
Parameter name | Data type | Description |
---|---|---|
facilityName | String | Facility name |
vo | int | VO id , if provided, filter out users who aren't in specific VO |
service | int | Service id , if provided, filter out users who aren't allowed to use the service on the facility |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
List<User> | list of allowed users |
Example URL
https://[hostname]/krb/rpc/json/facilitiesManager/getAllowedUsers
Example params
{ "facilityName" : "text" , "vo" : 79 , "service" : 54 }
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" } , {...} , {...} ]
Return all users which can use this facility
Parameter name | Data type | Description |
---|---|---|
facility | int | Facility id |
vo | int | VO id , if provided, filter out users who aren't in specific VO |
service | int | Service id , if provided, filter out users who aren't allowed to use the service on the facility |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
List<User> | list of allowed users |
Example URL
https://[hostname]/krb/rpc/json/facilitiesManager/getAllowedUsers
Example params
{ "facility" : 2 , "vo" : 83 , "service" : 9 }
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" } , {...} , {...} ]
Return all VO which can use a facility. (VO must have the resource which belongs to this facility.)
Parameter name | Data type | Description |
---|---|---|
facilityName | String | Facility name |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
List<Vo> | List of VOs |
Example URL
https://[hostname]/krb/rpc/json/facilitiesManager/getAllowedVos
Example params
{ "facilityName" : "text" }
Example response
[ { "id" : 123 , "name" : "My testing VO" , "shortName" : "test_vo" , "beanName" : "Vo" } , {...} , {...} ]
Return all VO which can use a facility. (VO must have the resource which belongs to this facility.)
Parameter name | Data type | Description |
---|---|---|
facility | int | Facility id |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
List<Vo> | List of VOs |
Example URL
https://[hostname]/krb/rpc/json/facilitiesManager/getAllowedVos
Example params
{ "facility" : 46 }
Example response
[ { "id" : 123 , "name" : "My testing VO" , "shortName" : "test_vo" , "beanName" : "Vo" } , {...} , {...} ]
Get facilities where the service is defined..
Parameter name | Data type | Description |
---|---|---|
service | int | Service id |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
List<Facility> | Assigned facilities |
Example URL
https://[hostname]/krb/rpc/json/facilitiesManager/getAssignedFacilities
Example params
{ "service" : 90 }
Example response
[ { "id" : 24 , "name" : "host.facility.cz" , "description" : "is optional" , "beanName" : "Facility" } , {...} , {...} ]
Get facilities which are assigned to a Group (via resource).
Parameter name | Data type | Description |
---|---|---|
group | int | Group id |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
List<Facility> | Assigned facilities |
Example URL
https://[hostname]/krb/rpc/json/facilitiesManager/getAssignedFacilities
Example params
{ "group" : 52 }
Example response
[ { "id" : 24 , "name" : "host.facility.cz" , "description" : "is optional" , "beanName" : "Facility" } , {...} , {...} ]
Get facilities which have the member access on.
Parameter name | Data type | Description |
---|---|---|
member | int | Member id |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
List<Facility> | Assigned facilities |
Example URL
https://[hostname]/krb/rpc/json/facilitiesManager/getAssignedFacilities
Example params
{ "member" : 76 }
Example response
[ { "id" : 24 , "name" : "host.facility.cz" , "description" : "is optional" , "beanName" : "Facility" } , {...} , {...} ]
Get facilities which have the user access on.
Parameter name | Data type | Description |
---|---|---|
user | int | User id |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
List<Facility> | Assigned facilities |
Example URL
https://[hostname]/krb/rpc/json/facilitiesManager/getAssignedFacilities
Example params
{ "user" : 3 }
Example response
[ { "id" : 24 , "name" : "host.facility.cz" , "description" : "is optional" , "beanName" : "Facility" } , {...} , {...} ]
Returns all resources assigned to a facility.
Parameter name | Data type | Description |
---|---|---|
facilityName | String | Facility name |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
List<Resource> | Resources |
Example URL
https://[hostname]/krb/rpc/json/facilitiesManager/getAssignedResources
Example params
{ "facilityName" : "text" }
Example response
[ { "id" : 493 , "name" : "host1.host.cz" , "description" : "ROOT access to host1.host.cz" , "facilityId" : 24 , "voId" : 21 , "uuid" : "542d676f-99b2-4d1c-bc80-a46fd7f34e62" , "beanName" : "Resource" } , {...} , {...} ]
Returns all resources assigned to a facility.
Parameter name | Data type | Description |
---|---|---|
facility | int | Facility id |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
List<Resource> | Resources |
Example URL
https://[hostname]/krb/rpc/json/facilitiesManager/getAssignedResources
Example params
{ "facility" : 30 }
Example response
[ { "id" : 493 , "name" : "host1.host.cz" , "description" : "ROOT access to host1.host.cz" , "facilityId" : 24 , "voId" : 21 , "uuid" : "542d676f-99b2-4d1c-bc80-a46fd7f34e62" , "beanName" : "Resource" } , {...} , {...} ]
Returns resources with specific service assigned to the facility.
Parameter name | Data type | Description |
---|---|---|
facility | int | Facility id |
service | int | Service id |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
List<Resource> | Resources |
Example URL
https://[hostname]/krb/rpc/json/facilitiesManager/getAssignedResourcesByAssignedService
Example params
{ "facility" : 22 , "service" : 17 }
Example response
[ { "id" : 493 , "name" : "host1.host.cz" , "description" : "ROOT access to host1.host.cz" , "facilityId" : 24 , "voId" : 21 , "uuid" : "542d676f-99b2-4d1c-bc80-a46fd7f34e62" , "beanName" : "Resource" } , {...} , {...} ]
Returns all rich resources assigned to a facility with VO property filled.
Parameter name | Data type | Description |
---|---|---|
facilityName | String | Facility name |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
List<RichResource> | Resources |
Example URL
https://[hostname]/krb/rpc/json/facilitiesManager/getAssignedRichResources
Example params
{ "facilityName" : "text" }
Example response
[ { "id" : 493 , "name" : "host1.host.cz" , "description" : "ROOT access to host1.host.cz" , "facilityId" : 24 , "voId" : 123 , "uuid" : "542d676f-99b2-4d1c-bc80-a46fd7f34e62" , "beanName" : "RichResource" , "vo" : { "id" : 123 , "name" : "My testing VO" , "shortName" : "test_vo" , "beanName" : "Vo" }, "facility" : { "id" : 24 , "name" : "host.facility.cz" , "description" : "is optional" , "beanName" : "Facility" } , "resourceTags" : [ { "id" : 3 , "tagName" : "comp_cluster" , "voId" : 123 , "beanName" : "ResourceTag" } , {...} , {...} ] } , {...} , {...} ]
Returns all rich resources assigned to a facility with VO property filled.
Parameter name | Data type | Description |
---|---|---|
facility | int | Facility id |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
List<RichResource> | Resources |
Example URL
https://[hostname]/krb/rpc/json/facilitiesManager/getAssignedRichResources
Example params
{ "facility" : 64 }
Example response
[ { "id" : 493 , "name" : "host1.host.cz" , "description" : "ROOT access to host1.host.cz" , "facilityId" : 24 , "voId" : 123 , "uuid" : "542d676f-99b2-4d1c-bc80-a46fd7f34e62" , "beanName" : "RichResource" , "vo" : { "id" : 123 , "name" : "My testing VO" , "shortName" : "test_vo" , "beanName" : "Vo" }, "facility" : { "id" : 24 , "name" : "host.facility.cz" , "description" : "is optional" , "beanName" : "Facility" } , "resourceTags" : [ { "id" : 3 , "tagName" : "comp_cluster" , "voId" : 123 , "beanName" : "ResourceTag" } , {...} , {...} ] } , {...} , {...} ]
Returns all rich resources assigned to a facility and service with VO property filled.
Parameter name | Data type | Description |
---|---|---|
facility | int | Facility id |
service | int | Service id |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
List<RichResource> | Resources |
Example URL
https://[hostname]/krb/rpc/json/facilitiesManager/getAssignedRichResources
Example params
{ "facility" : 69 , "service" : 26 }
Example response
[ { "id" : 493 , "name" : "host1.host.cz" , "description" : "ROOT access to host1.host.cz" , "facilityId" : 24 , "voId" : 123 , "uuid" : "542d676f-99b2-4d1c-bc80-a46fd7f34e62" , "beanName" : "RichResource" , "vo" : { "id" : 123 , "name" : "My testing VO" , "shortName" : "test_vo" , "beanName" : "Vo" }, "facility" : { "id" : 24 , "name" : "host.facility.cz" , "description" : "is optional" , "beanName" : "Facility" } , "resourceTags" : [ { "id" : 3 , "tagName" : "comp_cluster" , "voId" : 123 , "beanName" : "ResourceTag" } , {...} , {...} ] } , {...} , {...} ]
Return assigned security teams for specific facility
Parameter name | Data type | Description |
---|---|---|
facilityName | String | Facility name |
Thrown exception | Description |
---|---|
FacilityNotExistsException | When Facility with given name doesn't exists. |
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
List<SecurityTeam> | assigned security teams fot given facility |
Example URL
https://[hostname]/krb/rpc/json/facilitiesManager/getAssignedSecurityTeams
Example params
{ "facilityName" : "text" }
Example response
[ { "id" : 924 , "name" : "CSIRT" , "description" : "My CSIRT" } , {...} , {...} ]
Return assigned security teams for specific facility
Parameter name | Data type | Description |
---|---|---|
facility | int | Facility id |
Thrown exception | Description |
---|---|
FacilityNotExistsException | When Facility with given id doesn't exists. |
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
List<SecurityTeam> | assigned security teams fot given facility |
Example URL
https://[hostname]/krb/rpc/json/facilitiesManager/getAssignedSecurityTeams
Example params
{ "facility" : 45 }
Example response
[ { "id" : 924 , "name" : "CSIRT" , "description" : "My CSIRT" } , {...} , {...} ]
Lists all users assigned to facility containing resources where service is assigned.
Parameter name | Data type | Description |
---|---|---|
service | int | Service id |
facilityName | String | Facility name |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
List<User> | assigned users |
Example URL
https://[hostname]/krb/rpc/json/facilitiesManager/getAssignedUsers
Example params
{ "service" : 28 , "facilityName" : "text" }
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" } , {...} , {...} ]
Lists all users assigned to facility.
Parameter name | Data type | Description |
---|---|---|
facilityName | String | Facility name |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
List<User> | assigned users |
Example URL
https://[hostname]/krb/rpc/json/facilitiesManager/getAssignedUsers
Example params
{ "facilityName" : "text" }
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" } , {...} , {...} ]
Lists all users assigned to facility containing resources where service is assigned.
Parameter name | Data type | Description |
---|---|---|
service | int | Service id |
facility | int | Facility id |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
List<User> | assigned users |
Example URL
https://[hostname]/krb/rpc/json/facilitiesManager/getAssignedUsers
Example params
{ "service" : 12 , "facility" : 77 }
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" } , {...} , {...} ]
Lists all users assigned to facility.
Parameter name | Data type | Description |
---|---|---|
facility | int | Facility id |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
List<User> | assigned users |
Example URL
https://[hostname]/krb/rpc/json/facilitiesManager/getAssignedUsers
Example params
{ "facility" : 41 }
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" } , {...} , {...} ]
Get ban by userId and facilityId.
Parameter name | Data type | Description |
---|---|---|
userId | int | User id |
facilityId | int | Facility id |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
BanOnFacility | banOnFacility |
Example URL
https://[hostname]/krb/rpc/json/facilitiesManager/getBan
Example params
{ "userId" : 6 , "facilityId" : 22 }
Example response
{ "id" : 3 , "validityTo" : 1533638919 , "description" : "banned" , "userId" : 2341 , "facilityId" : 233 , "beanName" : "BanOnFacility" }
Get Ban for user on facility by it's id.
Parameter name | Data type | Description |
---|---|---|
banId | int | BanOnFacility id |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
BanOnFacility | banOnFacility |
Example URL
https://[hostname]/krb/rpc/json/facilitiesManager/getBanById
Example params
{ "banId" : 62 }
Example response
{ "id" : 3 , "validityTo" : 1533638919 , "description" : "banned" , "userId" : 2341 , "facilityId" : 233 , "beanName" : "BanOnFacility" }
Get all bans for user on the facility.
Parameter name | Data type | Description |
---|---|---|
facilityId | int | Facility id |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
List<BanOnFacility> | usersBansOnFacility |
Example URL
https://[hostname]/krb/rpc/json/facilitiesManager/getBansForFacility
Example params
{ "facilityId" : 69 }
Example response
[ { "id" : 3 , "validityTo" : 1533638919 , "description" : "banned" , "userId" : 2341 , "facilityId" : 233 , "beanName" : "BanOnFacility" } , {...} , {...} ]
Get all bans for user on any facility.
Parameter name | Data type | Description |
---|---|---|
userId | int | User id |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
List<BanOnFacility> | userBansOnFacilities |
Example URL
https://[hostname]/krb/rpc/json/facilitiesManager/getBansForUser
Example params
{ "userId" : 38 }
Example response
[ { "id" : 3 , "validityTo" : 1533638919 , "description" : "banned" , "userId" : 2341 , "facilityId" : 233 , "beanName" : "BanOnFacility" } , {...} , {...} ]
Get all Facility direct admins.
Parameter name | Data type | Description |
---|---|---|
facilityName | String | Facility name |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
List<User> | list of admins of the facility |
Example URL
https://[hostname]/krb/rpc/json/facilitiesManager/getDirectAdmins
Example params
{ "facilityName" : "text" }
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" } , {...} , {...} ]
Get all Facility admins, which are assigned directly, as RichUsers with specific attributes (from user namespace)
Parameter name | Data type | Description |
---|---|---|
facilityName | String | Facility name |
specificAttributes | List<String> | list of attributes URNs |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
List<RichUser> | direct admins with attributes |
Example URL
https://[hostname]/krb/rpc/json/facilitiesManager/getDirectRichAdminsWithSpecificAttributes
Example params
{ "facilityName" : "text" , "specificAttributes" : [ "text" , "text" ] }
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" : "RichUser" , "userExtSources" : [ { "userId": 34 , "loa" : 0 , "extSource" : { "name" : "PERUNPEOPLE" , "type" : "cz.metacentrum.perun.core.impl.ExtSourceSql" , "attributes" : {} , "id" : 2 , "beanName" : "ExtSource" } , "login" : "my_login" , "persistent" : true , "id" : 312 , "lastAccess" : "2019-06-10 14:07:42.2767" , "beanName" : "UserExtSource" } , {...} , {...} ], "userAttributes" : [ { "value" : "my_login" , "type" : "java.lang.String" , "entity" : "user" , "namespace" : "urn:perun:user:attribute-def:def" , "friendlyName" : "login-namespace:perun" , "writable" : true , "baseFriendlyName" : "login-namespace" , "friendlyNameParameter" : "perun" , "unique" : false , "displayName" : "Login in namespace: perun" , "description" : "Logname in namespace 'perun'." , "id" : 1905 , "beanName" : "Attribute" } ] } , {...} , {...} ]
Get all Facility admins, which are assigned directly, as RichUsers with specific attributes (from user namespace)
Parameter name | Data type | Description |
---|---|---|
facility | int | Facility id |
specificAttributes | List<String> | list of attributes URNs |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
List<RichUser> | direct admins with attributes |
Example URL
https://[hostname]/krb/rpc/json/facilitiesManager/getDirectRichAdminsWithSpecificAttributes
Example params
{ "facility" : 58 , "specificAttributes" : [ "text" , "text" ] }
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" : "RichUser" , "userExtSources" : [ { "userId": 34 , "loa" : 0 , "extSource" : { "name" : "PERUNPEOPLE" , "type" : "cz.metacentrum.perun.core.impl.ExtSourceSql" , "attributes" : {} , "id" : 2 , "beanName" : "ExtSource" } , "login" : "my_login" , "persistent" : true , "id" : 312 , "lastAccess" : "2019-06-10 14:07:42.2767" , "beanName" : "UserExtSource" } , {...} , {...} ], "userAttributes" : [ { "value" : "my_login" , "type" : "java.lang.String" , "entity" : "user" , "namespace" : "urn:perun:user:attribute-def:def" , "friendlyName" : "login-namespace:perun" , "writable" : true , "baseFriendlyName" : "login-namespace" , "friendlyNameParameter" : "perun" , "unique" : false , "displayName" : "Login in namespace: perun" , "description" : "Logname in namespace 'perun'." , "id" : 1905 , "beanName" : "Attribute" } ] } , {...} , {...} ]
Get all enriched bans for users on the facility.
Parameter name | Data type | Description |
---|---|---|
facility | int | Facility id |
attrNames | List<String> | list of attribute names, if empty or null returns all user and member attributes |
Thrown exception | Description |
---|---|
FacilityNotExistsException | |
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
List<EnrichedBanOnFacility> | enriched bans on facility |
Example URL
https://[hostname]/krb/rpc/json/facilitiesManager/getEnrichedBansForFacility
Example params
{ "facility" : 1 , "attrNames" : [ "text" , "text" ] }
Example response
[ { "facility" : { "id" : 24 , "name" : "host.facility.cz" , "description" : "is optional" , "beanName" : "Facility" } , "user" : { "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" : "RichUser" , "userExtSources" : [ { "userId": 34 , "loa" : 0 , "extSource" : { "name" : "PERUNPEOPLE" , "type" : "cz.metacentrum.perun.core.impl.ExtSourceSql" , "attributes" : {} , "id" : 2 , "beanName" : "ExtSource" } , "login" : "my_login" , "persistent" : true , "id" : 312 , "lastAccess" : "2019-06-10 14:07:42.2767" , "beanName" : "UserExtSource" } , {...} , {...} ], "userAttributes" : [ { "value" : "my_login" , "type" : "java.lang.String" , "entity" : "user" , "namespace" : "urn:perun:user:attribute-def:def" , "friendlyName" : "login-namespace:perun" , "writable" : true , "baseFriendlyName" : "login-namespace" , "friendlyNameParameter" : "perun" , "unique" : false , "displayName" : "Login in namespace: perun" , "description" : "Logname in namespace 'perun'." , "id" : 1905 , "beanName" : "Attribute" } ] } , "ban" : { "id" : 3 , "validityTo" : 1533638919 , "description" : "banned" , "userId" : 2341 , "facilityId" : 233 , "beanName" : "BanOnFacility" } } , {...} , {...} ]
Get all user's enriched bans on assigned facilities.
Parameter name | Data type | Description |
---|---|---|
user | int | user id |
attrNames | List<String> | list of attribute names, if empty or null returns all user and member attributes |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
UserNotExistsException |
Return type | Description |
---|---|
List<EnrichedBanOnFacility> | enriched bans for user |
Example URL
https://[hostname]/krb/rpc/json/facilitiesManager/getEnrichedBansForUser
Example params
{ "user" : 83 , "attrNames" : [ "text" , "text" ] }
Example response
[ { "facility" : { "id" : 24 , "name" : "host.facility.cz" , "description" : "is optional" , "beanName" : "Facility" } , "user" : { "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" : "RichUser" , "userExtSources" : [ { "userId": 34 , "loa" : 0 , "extSource" : { "name" : "PERUNPEOPLE" , "type" : "cz.metacentrum.perun.core.impl.ExtSourceSql" , "attributes" : {} , "id" : 2 , "beanName" : "ExtSource" } , "login" : "my_login" , "persistent" : true , "id" : 312 , "lastAccess" : "2019-06-10 14:07:42.2767" , "beanName" : "UserExtSource" } , {...} , {...} ], "userAttributes" : [ { "value" : "my_login" , "type" : "java.lang.String" , "entity" : "user" , "namespace" : "urn:perun:user:attribute-def:def" , "friendlyName" : "login-namespace:perun" , "writable" : true , "baseFriendlyName" : "login-namespace" , "friendlyNameParameter" : "perun" , "unique" : false , "displayName" : "Login in namespace: perun" , "description" : "Logname in namespace 'perun'." , "id" : 1905 , "beanName" : "Attribute" } ] } , "ban" : { "id" : 3 , "validityTo" : 1533638919 , "description" : "banned" , "userId" : 2341 , "facilityId" : 233 , "beanName" : "BanOnFacility" } } , {...} , {...} ]
Gets all enriched facilities user has access rights to. If User is: - PERUNADMIN : all facilities - FACILITYADMIN : only facilities where user is facility admin - FACILITYOBSERVER: only facilities where user is facility observer
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
List<EnrichedFacility> | All enriched facilities |
Example URL
https://[hostname]/krb/rpc/json/facilitiesManager/getEnrichedFacilities
Example response
{ ... TODO ... }
Return all enriched hosts of given facility. That is host with all its attributes.
Parameter name | Data type | Description |
---|---|---|
facility | int | Facility id |
attrNames | List<String> | Attribute names |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
List<EnrichedHosts> | enrichedHosts |
Example URL
https://[hostname]/krb/rpc/json/facilitiesManager/getEnrichedHosts
Example params
{ "facility" : 55 , "attrNames" : [ "text" , "text" ] }
Example response
{ ... TODO ... }
List all facilities.
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
List<Facility> | All facilities |
Example URL
https://[hostname]/krb/rpc/json/facilitiesManager/getFacilities
Example response
[ { "id" : 24 , "name" : "host.facility.cz" , "description" : "is optional" , "beanName" : "Facility" } , {...} , {...} ]
Returns all facilities that have set the attribute 'attributeName' with the value 'attributeValue'. Searching only def and opt attributes.
Parameter name | Data type | Description |
---|---|---|
attributeName | String | |
attributeValue | String |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
List<Facility> | facilities with the specified attribute |
Example URL
https://[hostname]/krb/rpc/json/facilitiesManager/getFacilitiesByAttribute
Example params
{ "attributeName" : "text" , "attributeValue" : "text" }
Example response
[ { "id" : 24 , "name" : "host.facility.cz" , "description" : "is optional" , "beanName" : "Facility" } , {...} , {...} ]
Searches (partially!) for facilities with the attribute 'attributeName' and its value 'attributeValue'. Found Facilities are returned along with attributes listed in 'attrNames'.
Parameter name | Data type | Description |
---|---|---|
attributeName | String | |
attributeValue | String | |
attrNames | List<String> |
Thrown exception | Description |
---|---|
AttributeNotExistsException | when the attribute to search by does not exist |
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
List<FacilityWithAttribute> | facilities with attributes |
Example URL
https://[hostname]/krb/rpc/json/facilitiesManager/getFacilitiesByAttributeWithAttributes
Example params
{ "attributeName" : "text" , "attributeValue" : "text" , "attrNames" : [ "text" , "text" ] }
Example response
{ ... TODO ... }
Searches for the Facilities by theirs destination.
Parameter name | Data type | Description |
---|---|---|
destination | String | Destination |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
Facility | Found facility |
Example URL
https://[hostname]/krb/rpc/json/facilitiesManager/getFacilitiesByDestination
Example params
{ "destination" : "text" }
Example response
{ "id" : 24 , "name" : "host.facility.cz" , "description" : "is optional" , "beanName" : "Facility" }
Return all facilities where exists host with the specific hostname
Parameter name | Data type | Description |
---|---|---|
hostname | String | specific hostname |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
List<Facility> | Found Facilities |
Example URL
https://[hostname]/krb/rpc/json/facilitiesManager/getFacilitiesByHostName
Example params
{ "hostname" : "text" }
Example response
[ { "id" : 24 , "name" : "host.facility.cz" , "description" : "is optional" , "beanName" : "Facility" } , {...} , {...} ]
Returns facilities by their IDs.
Parameter name | Data type | Description |
---|---|---|
ids | List<Integer> | list of facilities IDs |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
List<Facility> | facilities with specified IDs |
Example URL
https://[hostname]/krb/rpc/json/facilitiesManager/getFacilitiesByIds
Example params
{ "ids" : [ 97 , 0 ] }
Example response
[ { "id" : 24 , "name" : "host.facility.cz" , "description" : "is optional" , "beanName" : "Facility" } , {...} , {...} ]
Gets count of all facilities.
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
int | Facilities count |
Example URL
https://[hostname]/krb/rpc/json/facilitiesManager/getFacilitiesCount
Example response
69
Returns list of Facilities, where the user is an Administrator. Including facilities, where the user is a VALID member of authorized group.
Parameter name | Data type | Description |
---|---|---|
user | int | User id |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
List<Facility> | Found Facilities |
Example URL
https://[hostname]/krb/rpc/json/facilitiesManager/getFacilitiesWhereUserIsAdmin
Example params
{ "user" : 23 }
Example response
[ { "id" : 24 , "name" : "host.facility.cz" , "description" : "is optional" , "beanName" : "Facility" } , {...} , {...} ]
Searches for the Facility with specified id.
Parameter name | Data type | Description |
---|---|---|
id | int | Facility id |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
Facility | Found facility |
Example URL
https://[hostname]/krb/rpc/json/facilitiesManager/getFacilityById
Example params
{ "id" : 79 }
Example response
{ "id" : 24 , "name" : "host.facility.cz" , "description" : "is optional" , "beanName" : "Facility" }
Searches the Facility by its name.
Parameter name | Data type | Description |
---|---|---|
name | String | Facility name |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
Facility | Found facility |
Example URL
https://[hostname]/krb/rpc/json/facilitiesManager/getFacilityByName
Example params
{ "name" : "text" }
Example response
{ "id" : 24 , "name" : "host.facility.cz" , "description" : "is optional" , "beanName" : "Facility" }
Return facility which has the host.
Parameter name | Data type | Description |
---|---|---|
host | int | Host id |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
Facility | Facility object |
Example URL
https://[hostname]/krb/rpc/json/facilitiesManager/getFacilityForHost
Example params
{ "host" : 17 }
Example response
{ "id" : 24 , "name" : "host.facility.cz" , "description" : "is optional" , "beanName" : "Facility" }
Returns a host by its id
.
Parameter name | Data type | Description |
---|---|---|
id | int | Host id |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
Host | Host object |
Example URL
https://[hostname]/krb/rpc/json/facilitiesManager/getHostById
Example params
{ "id" : 15 }
Example response
{ "id" : 523 , "hostname" : "host1.host.cz" }
Lists hosts of a Facility.
Parameter name | Data type | Description |
---|---|---|
facilityName | String | Facility name |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
List<Host> | Hosts |
Example URL
https://[hostname]/krb/rpc/json/facilitiesManager/getHosts
Example params
{ "facilityName" : "text" }
Example response
[ { "id" : 523 , "hostname" : "host1.host.cz" } , {...} , {...} ]
Lists hosts of a Facility.
Parameter name | Data type | Description |
---|---|---|
facility | int | Facility id |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
List<Host> | Hosts |
Example URL
https://[hostname]/krb/rpc/json/facilitiesManager/getHosts
Example params
{ "facility" : 0 }
Example response
[ { "id" : 523 , "hostname" : "host1.host.cz" } , {...} , {...} ]
Returns hosts by hostname. (from all facilities)
Parameter name | Data type | Description |
---|---|---|
hostname | String | hostname of hosts |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
List<Host> | all hosts with this hostname, empty arrayList if none exists |
Example URL
https://[hostname]/krb/rpc/json/facilitiesManager/getHostsByHostname
Example params
{ "hostname" : "text" }
Example response
[ { "id" : 523 , "hostname" : "host1.host.cz" } , {...} , {...} ]
Count hosts of Facility.
Parameter name | Data type | Description |
---|---|---|
facilityName | String | Facility name |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
int | Hosts count |
Example URL
https://[hostname]/krb/rpc/json/facilitiesManager/getHostsCount
Example params
{ "facilityName" : "text" }
Example response
33
Count hosts of Facility.
Parameter name | Data type | Description |
---|---|---|
facility | int | Facility id |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
int | Hosts count |
Example URL
https://[hostname]/krb/rpc/json/facilitiesManager/getHostsCount
Example params
{ "facility" : 72 }
Example response
54
Returns list of all facilities owned by the owner.
Parameter name | Data type | Description |
---|---|---|
owner | int | Owner id |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
List<Facility> | Owner's facilities |
Example URL
https://[hostname]/krb/rpc/json/facilitiesManager/getOwnerFacilities
Example params
{ "owner" : 61 }
Example response
[ { "id" : 24 , "name" : "host.facility.cz" , "description" : "is optional" , "beanName" : "Facility" } , {...} , {...} ]
Returns owners of a facility.
Parameter name | Data type | Description |
---|---|---|
facilityName | String | Facility name |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
List<Owner> | Facility owners |
Example URL
https://[hostname]/krb/rpc/json/facilitiesManager/getOwners
Example params
{ "facilityName" : "text" }
Example response
[ { "id" : 183 , "name" : "Some Body" , "type" : "administrative" , "contact" : "mail@mail.com" , "beanName" : "Owner" } , {...} , {...} ]
Returns owners of a facility.
Parameter name | Data type | Description |
---|---|---|
facility | int | Facility id |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
List<Owner> | Facility owners |
Example URL
https://[hostname]/krb/rpc/json/facilitiesManager/getOwners
Example params
{ "facility" : 66 }
Example response
[ { "id" : 183 , "name" : "Some Body" , "type" : "administrative" , "contact" : "mail@mail.com" , "beanName" : "Owner" } , {...} , {...} ]
Get list of all richUser administrators for the facility and supported role with specific attributes. If some group is administrator of the given group, all VALID members are included in the list. Supported roles: FacilityAdmin If "onlyDirectAdmins" is true, return only direct admins of the facility for supported role with specific attributes. If "allUserAttributes" is true, do not specify attributes through list and return them all in objects richUser. Ignoring list of specific attributes.
Parameter name | Data type | Description |
---|---|---|
facilityName | String | Facility name |
specificAttributes | List<String> | list of specified attributes which are needed in object richUser |
allUserAttributes | boolean | if == true, get all possible user attributes and ignore list of specificAttributes (if false, get only specific attributes) |
onlyDirectAdmins | boolean | if == true, get only direct facility administrators (if false, get both direct and indirect) |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
List<RichUser> | list of RichUser administrators for the facility and supported role with attributes |
Example URL
https://[hostname]/krb/rpc/json/facilitiesManager/getRichAdmins
Example params
{ "facilityName" : "text" , "specificAttributes" : [ "text" , "text" ] , "allUserAttributes" : true , "onlyDirectAdmins" : true }
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" : "RichUser" , "userExtSources" : [ { "userId": 34 , "loa" : 0 , "extSource" : { "name" : "PERUNPEOPLE" , "type" : "cz.metacentrum.perun.core.impl.ExtSourceSql" , "attributes" : {} , "id" : 2 , "beanName" : "ExtSource" } , "login" : "my_login" , "persistent" : true , "id" : 312 , "lastAccess" : "2019-06-10 14:07:42.2767" , "beanName" : "UserExtSource" } , {...} , {...} ], "userAttributes" : [ { "value" : "my_login" , "type" : "java.lang.String" , "entity" : "user" , "namespace" : "urn:perun:user:attribute-def:def" , "friendlyName" : "login-namespace:perun" , "writable" : true , "baseFriendlyName" : "login-namespace" , "friendlyNameParameter" : "perun" , "unique" : false , "displayName" : "Login in namespace: perun" , "description" : "Logname in namespace 'perun'." , "id" : 1905 , "beanName" : "Attribute" } ] } , {...} , {...} ]
Get all Facility admins as RichUsers
Parameter name | Data type | Description |
---|---|---|
facilityName | String | Facility name |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
List<RichUser> | admins |
Example URL
https://[hostname]/krb/rpc/json/facilitiesManager/getRichAdmins
Example params
{ "facilityName" : "text" }
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" : "RichUser" , "userExtSources" : [ { "userId": 34 , "loa" : 0 , "extSource" : { "name" : "PERUNPEOPLE" , "type" : "cz.metacentrum.perun.core.impl.ExtSourceSql" , "attributes" : {} , "id" : 2 , "beanName" : "ExtSource" } , "login" : "my_login" , "persistent" : true , "id" : 312 , "lastAccess" : "2019-06-10 14:07:42.2767" , "beanName" : "UserExtSource" } , {...} , {...} ], "userAttributes" : [ { "value" : "my_login" , "type" : "java.lang.String" , "entity" : "user" , "namespace" : "urn:perun:user:attribute-def:def" , "friendlyName" : "login-namespace:perun" , "writable" : true , "baseFriendlyName" : "login-namespace" , "friendlyNameParameter" : "perun" , "unique" : false , "displayName" : "Login in namespace: perun" , "description" : "Logname in namespace 'perun'." , "id" : 1905 , "beanName" : "Attribute" } ] } , {...} , {...} ]
Get list of all richUser administrators for the facility and supported role with specific attributes. If some group is administrator of the given group, all VALID members are included in the list. Supported roles: FacilityAdmin If "onlyDirectAdmins" is true, return only direct admins of the facility for supported role with specific attributes. If "allUserAttributes" is true, do not specify attributes through list and return them all in objects richUser. Ignoring list of specific attributes.
Parameter name | Data type | Description |
---|---|---|
facility | int | Facility id |
specificAttributes | List<String> | list of specified attributes which are needed in object richUser |
allUserAttributes | boolean | if == true, get all possible user attributes and ignore list of specificAttributes (if false, get only specific attributes) |
onlyDirectAdmins | boolean | if == true, get only direct facility administrators (if false, get both direct and indirect) |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
List<RichUser> | list of RichUser administrators for the facility and supported role with attributes |
Example URL
https://[hostname]/krb/rpc/json/facilitiesManager/getRichAdmins
Example params
{ "facility" : 10 , "specificAttributes" : [ "text" , "text" ] , "allUserAttributes" : true , "onlyDirectAdmins" : true }
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" : "RichUser" , "userExtSources" : [ { "userId": 34 , "loa" : 0 , "extSource" : { "name" : "PERUNPEOPLE" , "type" : "cz.metacentrum.perun.core.impl.ExtSourceSql" , "attributes" : {} , "id" : 2 , "beanName" : "ExtSource" } , "login" : "my_login" , "persistent" : true , "id" : 312 , "lastAccess" : "2019-06-10 14:07:42.2767" , "beanName" : "UserExtSource" } , {...} , {...} ], "userAttributes" : [ { "value" : "my_login" , "type" : "java.lang.String" , "entity" : "user" , "namespace" : "urn:perun:user:attribute-def:def" , "friendlyName" : "login-namespace:perun" , "writable" : true , "baseFriendlyName" : "login-namespace" , "friendlyNameParameter" : "perun" , "unique" : false , "displayName" : "Login in namespace: perun" , "description" : "Logname in namespace 'perun'." , "id" : 1905 , "beanName" : "Attribute" } ] } , {...} , {...} ]
Get all Facility admins as RichUsers
Parameter name | Data type | Description |
---|---|---|
facility | int | Facility id |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
List<RichUser> | admins |
Example URL
https://[hostname]/krb/rpc/json/facilitiesManager/getRichAdmins
Example params
{ "facility" : 38 }
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" : "RichUser" , "userExtSources" : [ { "userId": 34 , "loa" : 0 , "extSource" : { "name" : "PERUNPEOPLE" , "type" : "cz.metacentrum.perun.core.impl.ExtSourceSql" , "attributes" : {} , "id" : 2 , "beanName" : "ExtSource" } , "login" : "my_login" , "persistent" : true , "id" : 312 , "lastAccess" : "2019-06-10 14:07:42.2767" , "beanName" : "UserExtSource" } , {...} , {...} ], "userAttributes" : [ { "value" : "my_login" , "type" : "java.lang.String" , "entity" : "user" , "namespace" : "urn:perun:user:attribute-def:def" , "friendlyName" : "login-namespace:perun" , "writable" : true , "baseFriendlyName" : "login-namespace" , "friendlyNameParameter" : "perun" , "unique" : false , "displayName" : "Login in namespace: perun" , "description" : "Logname in namespace 'perun'." , "id" : 1905 , "beanName" : "Attribute" } ] } , {...} , {...} ]
Get all Facility admins as RichUsers with all their non-null user attributes
Parameter name | Data type | Description |
---|---|---|
facilityName | String | Facility name |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
List<RichUser> | admins with attributes |
Example URL
https://[hostname]/krb/rpc/json/facilitiesManager/getRichAdminsWithAttributes
Example params
{ "facilityName" : "text" }
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" : "RichUser" , "userExtSources" : [ { "userId": 34 , "loa" : 0 , "extSource" : { "name" : "PERUNPEOPLE" , "type" : "cz.metacentrum.perun.core.impl.ExtSourceSql" , "attributes" : {} , "id" : 2 , "beanName" : "ExtSource" } , "login" : "my_login" , "persistent" : true , "id" : 312 , "lastAccess" : "2019-06-10 14:07:42.2767" , "beanName" : "UserExtSource" } , {...} , {...} ], "userAttributes" : [ { "value" : "my_login" , "type" : "java.lang.String" , "entity" : "user" , "namespace" : "urn:perun:user:attribute-def:def" , "friendlyName" : "login-namespace:perun" , "writable" : true , "baseFriendlyName" : "login-namespace" , "friendlyNameParameter" : "perun" , "unique" : false , "displayName" : "Login in namespace: perun" , "description" : "Logname in namespace 'perun'." , "id" : 1905 , "beanName" : "Attribute" } ] } , {...} , {...} ]
Get all Facility admins as RichUsers with all their non-null user attributes
Parameter name | Data type | Description |
---|---|---|
facility | int | Facility id |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
List<RichUser> | admins with attributes |
Example URL
https://[hostname]/krb/rpc/json/facilitiesManager/getRichAdminsWithAttributes
Example params
{ "facility" : 15 }
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" : "RichUser" , "userExtSources" : [ { "userId": 34 , "loa" : 0 , "extSource" : { "name" : "PERUNPEOPLE" , "type" : "cz.metacentrum.perun.core.impl.ExtSourceSql" , "attributes" : {} , "id" : 2 , "beanName" : "ExtSource" } , "login" : "my_login" , "persistent" : true , "id" : 312 , "lastAccess" : "2019-06-10 14:07:42.2767" , "beanName" : "UserExtSource" } , {...} , {...} ], "userAttributes" : [ { "value" : "my_login" , "type" : "java.lang.String" , "entity" : "user" , "namespace" : "urn:perun:user:attribute-def:def" , "friendlyName" : "login-namespace:perun" , "writable" : true , "baseFriendlyName" : "login-namespace" , "friendlyNameParameter" : "perun" , "unique" : false , "displayName" : "Login in namespace: perun" , "description" : "Logname in namespace 'perun'." , "id" : 1905 , "beanName" : "Attribute" } ] } , {...} , {...} ]
Get all Facility admins as RichUsers with specific attributes (from user namespace)
Parameter name | Data type | Description |
---|---|---|
facilityName | String | Facility name |
specificAttributes | List<String> | list of attributes URNs |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
List<RichUser> | admins with attributes |
Example URL
https://[hostname]/krb/rpc/json/facilitiesManager/getRichAdminsWithSpecificAttributes
Example params
{ "facilityName" : "text" , "specificAttributes" : [ "text" , "text" ] }
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" : "RichUser" , "userExtSources" : [ { "userId": 34 , "loa" : 0 , "extSource" : { "name" : "PERUNPEOPLE" , "type" : "cz.metacentrum.perun.core.impl.ExtSourceSql" , "attributes" : {} , "id" : 2 , "beanName" : "ExtSource" } , "login" : "my_login" , "persistent" : true , "id" : 312 , "lastAccess" : "2019-06-10 14:07:42.2767" , "beanName" : "UserExtSource" } , {...} , {...} ], "userAttributes" : [ { "value" : "my_login" , "type" : "java.lang.String" , "entity" : "user" , "namespace" : "urn:perun:user:attribute-def:def" , "friendlyName" : "login-namespace:perun" , "writable" : true , "baseFriendlyName" : "login-namespace" , "friendlyNameParameter" : "perun" , "unique" : false , "displayName" : "Login in namespace: perun" , "description" : "Logname in namespace 'perun'." , "id" : 1905 , "beanName" : "Attribute" } ] } , {...} , {...} ]
Get all Facility admins as RichUsers with specific attributes (from user namespace)
Parameter name | Data type | Description |
---|---|---|
facility | int | Facility id |
specificAttributes | List<String> | list of attributes URNs |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
List<RichUser> | admins with attributes |
Example URL
https://[hostname]/krb/rpc/json/facilitiesManager/getRichAdminsWithSpecificAttributes
Example params
{ "facility" : 20 , "specificAttributes" : [ "text" , "text" ] }
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" : "RichUser" , "userExtSources" : [ { "userId": 34 , "loa" : 0 , "extSource" : { "name" : "PERUNPEOPLE" , "type" : "cz.metacentrum.perun.core.impl.ExtSourceSql" , "attributes" : {} , "id" : 2 , "beanName" : "ExtSource" } , "login" : "my_login" , "persistent" : true , "id" : 312 , "lastAccess" : "2019-06-10 14:07:42.2767" , "beanName" : "UserExtSource" } , {...} , {...} ], "userAttributes" : [ { "value" : "my_login" , "type" : "java.lang.String" , "entity" : "user" , "namespace" : "urn:perun:user:attribute-def:def" , "friendlyName" : "login-namespace:perun" , "writable" : true , "baseFriendlyName" : "login-namespace" , "friendlyNameParameter" : "perun" , "unique" : false , "displayName" : "Login in namespace: perun" , "description" : "Logname in namespace 'perun'." , "id" : 1905 , "beanName" : "Attribute" } ] } , {...} , {...} ]
Gets all possible rich facilities with all their owners.
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
List<RichFacility> | rich facilities |
Example URL
https://[hostname]/krb/rpc/json/facilitiesManager/getRichFacilities
Example response
[ { "id" : 24 , "name" : "host.facility.cz" , , "description" : "is optional" , "facilityOwners" : [ { "id" : 183 , "name" : "Some Body" , "type" : "technical" , "contact" : "mail@mail.com" , "beanName" : "Owner" } ] , "beanName" : "RichFacility" } , {...} , {...} ]
Removes a Facility admin.
Parameter name | Data type | Description |
---|---|---|
facilityName | String | Facility name |
user | int | User id |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
void |
Example URL
https://[hostname]/krb/rpc/json/facilitiesManager/removeAdmin
Example params
{ "facilityName" : "text" , "user" : 55 }
Example response
null
Removes a group administrator of the Facility.
Parameter name | Data type | Description |
---|---|---|
facilityName | String | Facility name |
authorizedGroup | int | Group id |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
void |
Example URL
https://[hostname]/krb/rpc/json/facilitiesManager/removeAdmin
Example params
{ "facilityName" : "text" , "authorizedGroup" : 72 }
Example response
null
Removes a Facility admin.
Parameter name | Data type | Description |
---|---|---|
facility | int | Facility id |
user | int | User id |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
void |
Example URL
https://[hostname]/krb/rpc/json/facilitiesManager/removeAdmin
Example params
{ "facility" : 63 , "user" : 71 }
Example response
null
Removes a group administrator of the Facility.
Parameter name | Data type | Description |
---|---|---|
facility | int | Facility id |
authorizedGroup | int | Group id |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
void |
Example URL
https://[hostname]/krb/rpc/json/facilitiesManager/removeAdmin
Example params
{ "facility" : 52 , "authorizedGroup" : 72 }
Example response
null
Remove specific ban by it's id.
Parameter name | Data type | Description |
---|---|---|
banId | int | BanOnFacility id |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
void |
Example URL
https://[hostname]/krb/rpc/json/facilitiesManager/removeBan
Example params
{ "banId" : 10 }
Example response
null
Remove specific ban by userId and facilityId.
Parameter name | Data type | Description |
---|---|---|
userId | int | User id |
facilityId | int | Facility id |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
void |
Example URL
https://[hostname]/krb/rpc/json/facilitiesManager/removeBan
Example params
{ "userId" : 77 , "facilityId" : 27 }
Example response
null
Removes a host.
Parameter name | Data type | Description |
---|---|---|
host | int | Host id |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
void |
Example URL
https://[hostname]/krb/rpc/json/facilitiesManager/removeHost
Example params
{ "host" : 62 }
Example response
null
Remove host from the Facility based on hostname. If there is ambiguity, method throws exception and no host is removed.
Parameter name | Data type | Description |
---|---|---|
hostname | String | hostname |
Thrown exception | Description |
---|---|
HostNotExistsException | When host doesn't exist or is not unique by name |
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
void |
Example URL
https://[hostname]/krb/rpc/json/facilitiesManager/removeHostByHostname
Example params
{ "hostname" : "text" }
Example response
null
Remove hosts from a Facility.
Parameter name | Data type | Description |
---|---|---|
hosts | List<Integer> | List of Host IDs |
facilityName | String | Facility name |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
void |
Example URL
https://[hostname]/krb/rpc/json/facilitiesManager/removeHosts
Example params
{ "hosts" : [ 30 , 85 ] , "facilityName" : "text" }
Example response
null
Remove hosts from a Facility.
Parameter name | Data type | Description |
---|---|---|
hosts | List<Integer> | List of Host IDs |
facility | int | Facility id |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
void |
Example URL
https://[hostname]/krb/rpc/json/facilitiesManager/removeHosts
Example params
{ "hosts" : [ 64 , 33 ] , "facility" : 52 }
Example response
null
Remove owner of a facility.
Parameter name | Data type | Description |
---|---|---|
facilityName | String | Facility name |
ownerName | String | Owner name |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
void |
Example URL
https://[hostname]/krb/rpc/json/facilitiesManager/removeOwner
Example params
{ "facilityName" : "text" , "ownerName" : "text" }
Example response
null
Remove owner of a facility.
Parameter name | Data type | Description |
---|---|---|
facility | int | Facility id |
ownerName | String | Owner name |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
void |
Example URL
https://[hostname]/krb/rpc/json/facilitiesManager/removeOwner
Example params
{ "facility" : 73 , "ownerName" : "text" }
Example response
null
Remove owner of a facility.
Parameter name | Data type | Description |
---|---|---|
facilityName | String | Facility name |
owner | int | Owner id |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
void |
Example URL
https://[hostname]/krb/rpc/json/facilitiesManager/removeOwner
Example params
{ "facilityName" : "text" , "owner" : 77 }
Example response
null
Remove owner of a facility.
Parameter name | Data type | Description |
---|---|---|
facility | int | Facility id |
owner | int | Owner id |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
void |
Example URL
https://[hostname]/krb/rpc/json/facilitiesManager/removeOwner
Example params
{ "facility" : 98 , "owner" : 69 }
Example response
null
Remove owners of a facility.
Parameter name | Data type | Description |
---|---|---|
facilityName | String | Facility name |
ownerNames | List<String> | Owner name |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
void |
Example URL
https://[hostname]/krb/rpc/json/facilitiesManager/removeOwners
Example params
{ "facilityName" : "text" , "ownerNames" : [ "text" , "text" ] }
Example response
null
Remove owners of a facility.
Parameter name | Data type | Description |
---|---|---|
facility | int | Facility id |
ownerNames | List<String> | Owner name |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
void |
Example URL
https://[hostname]/krb/rpc/json/facilitiesManager/removeOwners
Example params
{ "facility" : 8 , "ownerNames" : [ "text" , "text" ] }
Example response
null
Remove owners of a facility.
Parameter name | Data type | Description |
---|---|---|
facilityName | String | Facility name |
owners | List<int> | Owner id |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
void |
Example URL
https://[hostname]/krb/rpc/json/facilitiesManager/removeOwners
Example params
{ "facilityName" : "text" , "owners" : {...} }
Example response
null
Remove owners of a facility.
Parameter name | Data type | Description |
---|---|---|
facility | int | Facility id |
owners | List<int> | Owner id |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
void |
Example URL
https://[hostname]/krb/rpc/json/facilitiesManager/removeOwners
Example params
{ "facility" : 18 , "owners" : {...} }
Example response
null
Remove (Unassign) given security team from given facility
Parameter name | Data type | Description |
---|---|---|
facilityName | String | Facility name |
securityTeam | int | SecurityTeam id |
Thrown exception | Description |
---|---|
FacilityNotExistsException | When Facility with given name doesn't exists. |
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
SecurityTeamNotAssignedException | When SecurityTeam with given id is not assigned. |
SecurityTeamNotExistsException | When SecurityTeam with given id doesn't exists. |
Return type | Description |
---|---|
void |
Example URL
https://[hostname]/krb/rpc/json/facilitiesManager/removeSecurityTeam
Example params
{ "facilityName" : "text" , "securityTeam" : 3 }
Example response
null
Remove (Unassign) given security team from given facility
Parameter name | Data type | Description |
---|---|---|
facility | int | Facility id |
securityTeam | int | SecurityTeam id |
Thrown exception | Description |
---|---|
FacilityNotExistsException | When Facility with given id doesn't exists. |
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
SecurityTeamNotAssignedException | When SecurityTeam with given id is not assigned. |
SecurityTeamNotExistsException | When SecurityTeam with given id doesn't exists. |
Return type | Description |
---|---|
void |
Example URL
https://[hostname]/krb/rpc/json/facilitiesManager/removeSecurityTeam
Example params
{ "facility" : 99 , "securityTeam" : 10 }
Example response
null
Set ban for user on facility.
Parameter name | Data type | Description |
---|---|---|
banOnFacility | BanOnFacility | JSON object |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
BanOnFacility | Created banOnFacility |
Example URL
https://[hostname]/krb/rpc/json/facilitiesManager/setBan
Example params
{ "banOnFacility" : { "id" : 3 , "validityTo" : 1533638919 , "description" : "banned" , "userId" : 2341 , "facilityId" : 233 , "beanName" : "BanOnFacility" } }
Example response
{ "id" : 3 , "validityTo" : 1533638919 , "description" : "banned" , "userId" : 2341 , "facilityId" : 233 , "beanName" : "BanOnFacility" }
Update existing ban (description, validation timestamp)
Parameter name | Data type | Description |
---|---|---|
banOnFacility | BanOnFacility | JSON object |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
BanOnFacility | updated banOnFacility |
Example URL
https://[hostname]/krb/rpc/json/facilitiesManager/updateBan
Example params
{ "banOnFacility" : { "id" : 3 , "validityTo" : 1533638919 , "description" : "banned" , "userId" : 2341 , "facilityId" : 233 , "beanName" : "BanOnFacility" } }
Example response
{ "id" : 3 , "validityTo" : 1533638919 , "description" : "banned" , "userId" : 2341 , "facilityId" : 233 , "beanName" : "BanOnFacility" }
Update a facility (facility name)
Parameter name | Data type | Description |
---|---|---|
facility | Facility | JSON object |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
Facility | updated Facility object |
Example URL
https://[hostname]/krb/rpc/json/facilitiesManager/updateFacility
Example params
{ "facility" : { "id" : 24 , "name" : "host.facility.cz" , "description" : "is optional" , "beanName" : "Facility" } }
Example response
{ "id" : 24 , "name" : "host.facility.cz" , "description" : "is optional" , "beanName" : "Facility" }