RPC API documentation v17.2.0

Back to Documentation Version:  General How to use RPC Managers AttributesManagerAuditMessagesManagerAuthzResolverCabinetManagerConfigManagerConsentsManagerDatabaseManagerExtSourcesManagerFacilitiesManagerGroupsManagerIntegrationManagerMembersManagerNotificationManagerOwnersManagerRTMessagesManagerRegistrarManagerResourcesManagerSearcherSecurityTeamsManagerServicesManagerTasksManagerUsersManagerVosManager

FacilitiesManager

Adds a Facility admin.

Parameter nameData typeDescription
facilityNameStringFacility name
userintUser id
Thrown exceptionDescription
InternalErrorExceptionWhen unspecified error occur. See exception param message for explanation.
PrivilegeExceptionWhen caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values.
RpcExceptionWrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation.
Return typeDescription
void

Example URL

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

Example params

{ "facilityName" : "text" , "user" : 2 }

Example response

null

Adds a group administrator to the Facility.

Parameter nameData typeDescription
facilityNameStringFacility name
authorizedGroupintGroup id
Thrown exceptionDescription
InternalErrorExceptionWhen unspecified error occur. See exception param message for explanation.
PrivilegeExceptionWhen caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values.
RpcExceptionWrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation.
Return typeDescription
void

Example URL

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

Example params

{ "facilityName" : "text" , "authorizedGroup" : 10 }

Example response

null

Adds a Facility admin.

Parameter nameData typeDescription
facilityintFacility id
userintUser id
Thrown exceptionDescription
InternalErrorExceptionWhen unspecified error occur. See exception param message for explanation.
PrivilegeExceptionWhen caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values.
RpcExceptionWrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation.
Return typeDescription
void

Example URL

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

Example params

{ "facility" : 85 , "user" : 7 }

Example response

null

Adds a group administrator to the Facility.

Parameter nameData typeDescription
facilityintFacility id
authorizedGroupintGroup id
Thrown exceptionDescription
InternalErrorExceptionWhen unspecified error occur. See exception param message for explanation.
PrivilegeExceptionWhen caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values.
RpcExceptionWrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation.
Return typeDescription
void

Example URL

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

Example params

{ "facility" : 17 , "authorizedGroup" : 42 }

Example response

null

Adds host to a Facility.

Parameter nameData typeDescription
hostnameStringHostname
facilityNameStringFacility name
Thrown exceptionDescription
InternalErrorExceptionWhen unspecified error occur. See exception param message for explanation.
PrivilegeExceptionWhen caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values.
RpcExceptionWrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation.
Return typeDescription
HostHost 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 nameData typeDescription
hostnameStringHostname
facilityintFacility id
Thrown exceptionDescription
InternalErrorExceptionWhen unspecified error occur. See exception param message for explanation.
PrivilegeExceptionWhen caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values.
RpcExceptionWrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation.
Return typeDescription
HostHost with id set.

Example URL

https://[hostname]/krb/rpc/json/facilitiesManager/addHost

Example params

{ "hostname" : "text" , "facility" : 52 }

Example response

{ "id" : 523 , "hostname" : "host1.host.cz" }

Adds hosts to the Facility.

Parameter nameData typeDescription
hostnamesList<String>Host names
facilityNameStringFacility name
Thrown exceptionDescription
InternalErrorExceptionWhen unspecified error occur. See exception param message for explanation.
PrivilegeExceptionWhen caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values.
RpcExceptionWrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation.
Return typeDescription
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 nameData typeDescription
hostnamesList<String>Host names
facilityintFacility id
Thrown exceptionDescription
InternalErrorExceptionWhen unspecified error occur. See exception param message for explanation.
PrivilegeExceptionWhen caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values.
RpcExceptionWrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation.
Return typeDescription
List<Host>Hosts with id's set.

Example URL

https://[hostname]/krb/rpc/json/facilitiesManager/addHosts

Example params

{ "hostnames" : [ "text" , "text" ] , "facility" : 56 }

Example response

[ { "id" : 523 , "hostname" : "host1.host.cz" } , {...} , {...} ]

Add owner of a facility.

Parameter nameData typeDescription
facilityNameStringFacility name
ownerNameStringOwner name
Thrown exceptionDescription
InternalErrorExceptionWhen unspecified error occur. See exception param message for explanation.
PrivilegeExceptionWhen caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values.
RpcExceptionWrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation.
Return typeDescription
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 nameData typeDescription
facilityNameStringFacility name
ownerintOwner id
Thrown exceptionDescription
InternalErrorExceptionWhen unspecified error occur. See exception param message for explanation.
PrivilegeExceptionWhen caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values.
RpcExceptionWrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation.
Return typeDescription
void

Example URL

https://[hostname]/krb/rpc/json/facilitiesManager/addOwner

Example params

{ "facilityName" : "text" , "owner" : 8 }

Example response

null

Add owner of a facility.

Parameter nameData typeDescription
facilityintFacility id
ownerNameStringOwner name
Thrown exceptionDescription
InternalErrorExceptionWhen unspecified error occur. See exception param message for explanation.
PrivilegeExceptionWhen caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values.
RpcExceptionWrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation.
Return typeDescription
void

Example URL

https://[hostname]/krb/rpc/json/facilitiesManager/addOwner

Example params

{ "facility" : 17 , "ownerName" : "text" }

Example response

null

Add owner of a facility.

Parameter nameData typeDescription
facilityintFacility id
ownerintOwner id
Thrown exceptionDescription
InternalErrorExceptionWhen unspecified error occur. See exception param message for explanation.
PrivilegeExceptionWhen caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values.
RpcExceptionWrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation.
Return typeDescription
void

Example URL

https://[hostname]/krb/rpc/json/facilitiesManager/addOwner

Example params

{ "facility" : 24 , "owner" : 7 }

Example response

null

Assign given security team to given facility (means the facility trusts the security team)

Parameter nameData typeDescription
facilityNameStringFacility name
securityTeamintSecurityTeam id
Thrown exceptionDescription
FacilityNotExistsExceptionWhen Facility with given name doesn't exists.
InternalErrorExceptionWhen unspecified error occur. See exception param message for explanation.
PrivilegeExceptionWhen caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values.
RpcExceptionWrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation.
SecurityTeamAlreadyAssignedExceptionWhen SecurityTeam with given id is already assigned.
SecurityTeamNotExistsExceptionWhen SecurityTeam with given id doesn't exists.
Return typeDescription
void

Example URL

https://[hostname]/krb/rpc/json/facilitiesManager/assignSecurityTeam

Example params

{ "facilityName" : "text" , "securityTeam" : 6 }

Example response

null

Assign given security team to given facility (means the facility trusts the security team)

Parameter nameData typeDescription
facilityintFacility id
securityTeamintSecurityTeam id
Thrown exceptionDescription
FacilityNotExistsExceptionWhen Facility with given id doesn't exists.
InternalErrorExceptionWhen unspecified error occur. See exception param message for explanation.
PrivilegeExceptionWhen caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values.
RpcExceptionWrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation.
SecurityTeamAlreadyAssignedExceptionWhen SecurityTeam with given id is already assigned.
SecurityTeamNotExistsExceptionWhen SecurityTeam with given id doesn't exists.
Return typeDescription
void

Example URL

https://[hostname]/krb/rpc/json/facilitiesManager/assignSecurityTeam

Example params

{ "facility" : 37 , "securityTeam" : 45 }

Example response

null

Copy attributes (settings) from source facility to destination facility. You must be facility manager of both.

Parameter nameData typeDescription
srcFacilityNameStringfacility name
destFacilityNameStringfacility name
Thrown exceptionDescription
InternalErrorExceptionWhen unspecified error occur. See exception param message for explanation.
PrivilegeExceptionWhen caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values.
RpcExceptionWrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation.
Return typeDescription
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 nameData typeDescription
srcFacilityintfacility id
destFacilityNameStringfacility name
Thrown exceptionDescription
InternalErrorExceptionWhen unspecified error occur. See exception param message for explanation.
PrivilegeExceptionWhen caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values.
RpcExceptionWrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation.
Return typeDescription
void

Example URL

https://[hostname]/krb/rpc/json/facilitiesManager/copyAttributes

Example params

{ "srcFacility" : 60 , "destFacilityName" : "text" }

Example response

null

Copy attributes (settings) from source facility to destination facility. You must be facility manager of both.

Parameter nameData typeDescription
srcFacilityNameStringfacility name
destFacilityintfacility id
Thrown exceptionDescription
InternalErrorExceptionWhen unspecified error occur. See exception param message for explanation.
PrivilegeExceptionWhen caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values.
RpcExceptionWrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation.
Return typeDescription
void

Example URL

https://[hostname]/krb/rpc/json/facilitiesManager/copyAttributes

Example params

{ "srcFacilityName" : "text" , "destFacility" : 77 }

Example response

null

Copy attributes (settings) from source facility to destination facility. You must be facility manager of both.

Parameter nameData typeDescription
srcFacilityintfacility id
destFacilityintfacility id
Thrown exceptionDescription
InternalErrorExceptionWhen unspecified error occur. See exception param message for explanation.
PrivilegeExceptionWhen caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values.
RpcExceptionWrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation.
Return typeDescription
void

Example URL

https://[hostname]/krb/rpc/json/facilitiesManager/copyAttributes

Example params

{ "srcFacility" : 36 , "destFacility" : 50 }

Example response

null

Copy managers from source facility to destination facility. You must be facility manager of both.

Parameter nameData typeDescription
srcFacilityNameStringfacility name
destFacilityNameStringfacility name
Thrown exceptionDescription
InternalErrorExceptionWhen unspecified error occur. See exception param message for explanation.
PrivilegeExceptionWhen caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values.
RpcExceptionWrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation.
Return typeDescription
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 nameData typeDescription
srcFacilityintfacility id
destFacilityNameStringfacility name
Thrown exceptionDescription
InternalErrorExceptionWhen unspecified error occur. See exception param message for explanation.
PrivilegeExceptionWhen caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values.
RpcExceptionWrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation.
Return typeDescription
void

Example URL

https://[hostname]/krb/rpc/json/facilitiesManager/copyManagers

Example params

{ "srcFacility" : 12 , "destFacilityName" : "text" }

Example response

null

Copy managers from source facility to destination facility. You must be facility manager of both.

Parameter nameData typeDescription
srcFacilityNameStringfacility name
destFacilityintfacility id
Thrown exceptionDescription
InternalErrorExceptionWhen unspecified error occur. See exception param message for explanation.
PrivilegeExceptionWhen caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values.
RpcExceptionWrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation.
Return typeDescription
void

Example URL

https://[hostname]/krb/rpc/json/facilitiesManager/copyManagers

Example params

{ "srcFacilityName" : "text" , "destFacility" : 41 }

Example response

null

Copy managers from source facility to destination facility. You must be facility manager of both.

Parameter nameData typeDescription
srcFacilityintfacility id
destFacilityintfacility id
Thrown exceptionDescription
InternalErrorExceptionWhen unspecified error occur. See exception param message for explanation.
PrivilegeExceptionWhen caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values.
RpcExceptionWrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation.
Return typeDescription
void

Example URL

https://[hostname]/krb/rpc/json/facilitiesManager/copyManagers

Example params

{ "srcFacility" : 26 , "destFacility" : 29 }

Example response

null

Copy owners from source facility to destination facility. You must be facility manager of both.

Parameter nameData typeDescription
srcFacilityNameStringfacility name
destFacilityNameStringfacility name
Thrown exceptionDescription
InternalErrorExceptionWhen unspecified error occur. See exception param message for explanation.
PrivilegeExceptionWhen caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values.
RpcExceptionWrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation.
Return typeDescription
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 nameData typeDescription
srcFacilityintfacility id
destFacilityNameStringfacility name
Thrown exceptionDescription
InternalErrorExceptionWhen unspecified error occur. See exception param message for explanation.
PrivilegeExceptionWhen caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values.
RpcExceptionWrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation.
Return typeDescription
void

Example URL

https://[hostname]/krb/rpc/json/facilitiesManager/copyOwners

Example params

{ "srcFacility" : 84 , "destFacilityName" : "text" }

Example response

null

Copy owners from source facility to destination facility. You must be facility manager of both.

Parameter nameData typeDescription
srcFacilityNameStringfacility name
destFacilityintfacility id
Thrown exceptionDescription
InternalErrorExceptionWhen unspecified error occur. See exception param message for explanation.
PrivilegeExceptionWhen caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values.
RpcExceptionWrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation.
Return typeDescription
void

Example URL

https://[hostname]/krb/rpc/json/facilitiesManager/copyOwners

Example params

{ "srcFacilityName" : "text" , "destFacility" : 70 }

Example response

null

Copy owners from source facility to destination facility. You must be facility manager of both.

Parameter nameData typeDescription
srcFacilityintfacility id
destFacilityintfacility id
Thrown exceptionDescription
InternalErrorExceptionWhen unspecified error occur. See exception param message for explanation.
PrivilegeExceptionWhen caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values.
RpcExceptionWrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation.
Return typeDescription
void

Example URL

https://[hostname]/krb/rpc/json/facilitiesManager/copyOwners

Example params

{ "srcFacility" : 37 , "destFacility" : 68 }

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 nameData typeDescription
facilityFacilityJSON object
Thrown exceptionDescription
ConsentHubExistsExceptionif consent hub with facility name exists
FacilityExistsExceptionif facility already exists
InternalErrorExceptionWhen unspecified error occur. See exception param message for explanation.
PrivilegeExceptionWhen caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values.
RpcExceptionWrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation.
Return typeDescription
FacilityCreated 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 nameData typeDescription
nameStringname of a facility - can contain only a-Z0-9.-_ and space characters.
descriptionStringdescription of a facility
Thrown exceptionDescription
ConsentHubExistsExceptionif consent hub with facility name exists
FacilityExistsExceptionif facility already exists
InternalErrorExceptionWhen unspecified error occur. See exception param message for explanation.
PrivilegeExceptionWhen caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values.
RpcExceptionWrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation.
Return typeDescription
FacilityCreated 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 nameData typeDescription
facilityNameStringFacility name
Thrown exceptionDescription
InternalErrorExceptionWhen unspecified error occur. See exception param message for explanation.
PrivilegeExceptionWhen caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values.
RpcExceptionWrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation.
Return typeDescription
void

Example URL

https://[hostname]/krb/rpc/json/facilitiesManager/deleteFacility

Example params

{ "facilityName" : "text" }

Example response

null

Deletes a facility.

Parameter nameData typeDescription
facilityNameStringFacility name
forceBooleanif true deletes all constrains of facility before deleting facility
Thrown exceptionDescription
InternalErrorExceptionWhen unspecified error occur. See exception param message for explanation.
PrivilegeExceptionWhen caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values.
RpcExceptionWrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation.
Return typeDescription
void

Example URL

https://[hostname]/krb/rpc/json/facilitiesManager/deleteFacility

Example params

{ "facilityName" : "text" , "force" : {...} }

Example response

null

Deletes a facility.

Parameter nameData typeDescription
facilityintFacility id
Thrown exceptionDescription
InternalErrorExceptionWhen unspecified error occur. See exception param message for explanation.
PrivilegeExceptionWhen caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values.
RpcExceptionWrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation.
Return typeDescription
void

Example URL

https://[hostname]/krb/rpc/json/facilitiesManager/deleteFacility

Example params

{ "facility" : 60 }

Example response

null

Deletes a facility.

Parameter nameData typeDescription
facilityintFacility id
forceBooleanif true deletes all constrains of facility before deleting facility
Thrown exceptionDescription
InternalErrorExceptionWhen unspecified error occur. See exception param message for explanation.
PrivilegeExceptionWhen caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values.
RpcExceptionWrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation.
Return typeDescription
void

Example URL

https://[hostname]/krb/rpc/json/facilitiesManager/deleteFacility

Example params

{ "facility" : 42 , "force" : {...} }

Example response

null

Get all Facility group admins.

Parameter nameData typeDescription
facilityNameStringFacility name
Thrown exceptionDescription
InternalErrorExceptionWhen unspecified error occur. See exception param message for explanation.
PrivilegeExceptionWhen caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values.
RpcExceptionWrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation.
Return typeDescription
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 nameData typeDescription
facilityintFacility id
Thrown exceptionDescription
InternalErrorExceptionWhen unspecified error occur. See exception param message for explanation.
PrivilegeExceptionWhen caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values.
RpcExceptionWrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation.
Return typeDescription
List<Group>admins

Example URL

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

Example params

{ "facility" : 93 }

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 nameData typeDescription
facilityNameStringFacility name
onlyDirectAdminsbooleanif true, get only direct facility administrators (if false, get both direct and indirect)
Thrown exceptionDescription
InternalErrorExceptionWhen unspecified error occur. See exception param message for explanation.
PrivilegeExceptionWhen caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values.
RpcExceptionWrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation.
Return typeDescription
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 nameData typeDescription
facilityNameStringFacility name
Thrown exceptionDescription
InternalErrorExceptionWhen unspecified error occur. See exception param message for explanation.
PrivilegeExceptionWhen caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values.
RpcExceptionWrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation.
Return typeDescription
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 nameData typeDescription
facilityintFacility id
onlyDirectAdminsbooleanif true, get only direct facility administrators (if false, get both direct and indirect)
Thrown exceptionDescription
InternalErrorExceptionWhen unspecified error occur. See exception param message for explanation.
PrivilegeExceptionWhen caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values.
RpcExceptionWrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation.
Return typeDescription
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" : 14 , "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 nameData typeDescription
facilityintFacility id
Thrown exceptionDescription
InternalErrorExceptionWhen unspecified error occur. See exception param message for explanation.
PrivilegeExceptionWhen caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values.
RpcExceptionWrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation.
Return typeDescription
List<User>List of Users who are admins in the facility.

Example URL

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

Example params

{ "facility" : 89 }

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 nameData typeDescription
facilityNameStringFacility name
Thrown exceptionDescription
InternalErrorExceptionWhen unspecified error occur. See exception param message for explanation.
PrivilegeExceptionWhen caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values.
RpcExceptionWrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation.
Return typeDescription
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 nameData typeDescription
facilityNameStringFacility name
vointVo id to filter groups by
Thrown exceptionDescription
InternalErrorExceptionWhen unspecified error occur. See exception param message for explanation.
PrivilegeExceptionWhen caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values.
RpcExceptionWrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation.
Return typeDescription
List<Group>assigned groups

Example URL

https://[hostname]/krb/rpc/json/facilitiesManager/getAllowedGroups

Example params

{ "facilityName" : "text" , "vo" : 84 }

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 nameData typeDescription
facilityNameStringFacility name
serviceintService id to filter groups by
Thrown exceptionDescription
InternalErrorExceptionWhen unspecified error occur. See exception param message for explanation.
PrivilegeExceptionWhen caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values.
RpcExceptionWrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation.
Return typeDescription
List<Group>assigned groups

Example URL

https://[hostname]/krb/rpc/json/facilitiesManager/getAllowedGroups

Example params

{ "facilityName" : "text" , "service" : 64 }

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 nameData typeDescription
facilityNameStringFacility name
vointVo id to filter groups by
serviceintService id to filter groups by
Thrown exceptionDescription
InternalErrorExceptionWhen unspecified error occur. See exception param message for explanation.
PrivilegeExceptionWhen caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values.
RpcExceptionWrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation.
Return typeDescription
List<Group>assigned groups

Example URL

https://[hostname]/krb/rpc/json/facilitiesManager/getAllowedGroups

Example params

{ "facilityName" : "text" , "vo" : 82 , "service" : 55 }

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 nameData typeDescription
facilityintFacility id
Thrown exceptionDescription
InternalErrorExceptionWhen unspecified error occur. See exception param message for explanation.
PrivilegeExceptionWhen caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values.
RpcExceptionWrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation.
Return typeDescription
List<Group>assigned groups

Example URL

https://[hostname]/krb/rpc/json/facilitiesManager/getAllowedGroups

Example params

{ "facility" : 66 }

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 nameData typeDescription
facilityintFacility id
vointVo id to filter groups by
Thrown exceptionDescription
InternalErrorExceptionWhen unspecified error occur. See exception param message for explanation.
PrivilegeExceptionWhen caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values.
RpcExceptionWrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation.
Return typeDescription
List<Group>assigned groups

Example URL

https://[hostname]/krb/rpc/json/facilitiesManager/getAllowedGroups

Example params

{ "facility" : 74 , "vo" : 27 }

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 nameData typeDescription
facilityintFacility id
serviceintService id to filter groups by
Thrown exceptionDescription
InternalErrorExceptionWhen unspecified error occur. See exception param message for explanation.
PrivilegeExceptionWhen caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values.
RpcExceptionWrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation.
Return typeDescription
List<Group>assigned groups

Example URL

https://[hostname]/krb/rpc/json/facilitiesManager/getAllowedGroups

Example params

{ "facility" : 54 , "service" : 24 }

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 nameData typeDescription
facilityintFacility id
vointVo id to filter groups by
serviceintService id to filter groups by
Thrown exceptionDescription
InternalErrorExceptionWhen unspecified error occur. See exception param message for explanation.
PrivilegeExceptionWhen caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values.
RpcExceptionWrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation.
Return typeDescription
List<Group>assigned groups

Example URL

https://[hostname]/krb/rpc/json/facilitiesManager/getAllowedGroups

Example params

{ "facility" : 14 , "vo" : 99 , "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 nameData typeDescription
facilityNameStringFacility name
attrNamesList<String>Attribute names
Thrown exceptionDescription
InternalErrorExceptionWhen unspecified error occur. See exception param message for explanation.
PrivilegeExceptionWhen caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values.
RpcExceptionWrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation.
Return typeDescription
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 nameData typeDescription
facilityNameStringFacility name
vointVo id to filter groups by
attrNamesList<String>Attribute names
Thrown exceptionDescription
InternalErrorExceptionWhen unspecified error occur. See exception param message for explanation.
PrivilegeExceptionWhen caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values.
RpcExceptionWrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation.
Return typeDescription
List<RichGroup>assigned groups

Example URL

https://[hostname]/krb/rpc/json/facilitiesManager/getAllowedRichGroupsWithAttributes

Example params

{ "facilityName" : "text" , "vo" : 82 , "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 nameData typeDescription
facilityNameStringFacility name
serviceintService id to filter groups by
attrNamesList<String>Attribute names
Thrown exceptionDescription
InternalErrorExceptionWhen unspecified error occur. See exception param message for explanation.
PrivilegeExceptionWhen caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values.
RpcExceptionWrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation.
Return typeDescription
List<RichGroup>assigned groups

Example URL

https://[hostname]/krb/rpc/json/facilitiesManager/getAllowedRichGroupsWithAttributes

Example params

{ "facilityName" : "text" , "service" : 16 , "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 nameData typeDescription
facilityNameStringFacility name
vointVo id to filter groups by
serviceintService id to filter groups by
attrNamesList<String>Attribute names
Thrown exceptionDescription
InternalErrorExceptionWhen unspecified error occur. See exception param message for explanation.
PrivilegeExceptionWhen caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values.
RpcExceptionWrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation.
Return typeDescription
List<RichGroup>assigned groups

Example URL

https://[hostname]/krb/rpc/json/facilitiesManager/getAllowedRichGroupsWithAttributes

Example params

{ "facilityName" : "text" , "vo" : 54 , "service" : 43 , "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 nameData typeDescription
facilityintFacility id
attrNamesList<String>Attribute names
Thrown exceptionDescription
InternalErrorExceptionWhen unspecified error occur. See exception param message for explanation.
PrivilegeExceptionWhen caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values.
RpcExceptionWrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation.
Return typeDescription
List<RichGroup>assigned groups

Example URL

https://[hostname]/krb/rpc/json/facilitiesManager/getAllowedRichGroupsWithAttributes

Example params

{ "facility" : 94 , "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 nameData typeDescription
facilityintFacility id
vointVo id to filter groups by
attrNamesList<String>Attribute names
Thrown exceptionDescription
InternalErrorExceptionWhen unspecified error occur. See exception param message for explanation.
PrivilegeExceptionWhen caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values.
RpcExceptionWrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation.
Return typeDescription
List<RichGroup>assigned groups

Example URL

https://[hostname]/krb/rpc/json/facilitiesManager/getAllowedRichGroupsWithAttributes

Example params

{ "facility" : 98 , "vo" : 54 , "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 nameData typeDescription
facilityintFacility id
serviceintService id to filter groups by
attrNamesList<String>Attribute names
Thrown exceptionDescription
InternalErrorExceptionWhen unspecified error occur. See exception param message for explanation.
PrivilegeExceptionWhen caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values.
RpcExceptionWrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation.
Return typeDescription
List<RichGroup>assigned groups

Example URL

https://[hostname]/krb/rpc/json/facilitiesManager/getAllowedRichGroupsWithAttributes

Example params

{ "facility" : 25 , "service" : 51 , "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 nameData typeDescription
facilityintFacility id
vointVo id to filter groups by
serviceintService id to filter groups by
attrNamesList<String>Attribute names
Thrown exceptionDescription
InternalErrorExceptionWhen unspecified error occur. See exception param message for explanation.
PrivilegeExceptionWhen caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values.
RpcExceptionWrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation.
Return typeDescription
List<RichGroup>assigned groups

Example URL

https://[hostname]/krb/rpc/json/facilitiesManager/getAllowedRichGroupsWithAttributes

Example params

{ "facility" : 10 , "vo" : 86 , "service" : 51 , "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 nameData typeDescription
facilityNameStringFacility name
vointVO id, if provided, filter out users who aren't in specific VO
serviceintService id, if provided, filter out users who aren't allowed to use the service on the facility
Thrown exceptionDescription
InternalErrorExceptionWhen unspecified error occur. See exception param message for explanation.
PrivilegeExceptionWhen caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values.
RpcExceptionWrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation.
Return typeDescription
List<User>list of allowed users

Example URL

https://[hostname]/krb/rpc/json/facilitiesManager/getAllowedUsers

Example params

{ "facilityName" : "text" , "vo" : 48 , "service" : 39 }

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 nameData typeDescription
facilityintFacility id
vointVO id, if provided, filter out users who aren't in specific VO
serviceintService id, if provided, filter out users who aren't allowed to use the service on the facility
Thrown exceptionDescription
InternalErrorExceptionWhen unspecified error occur. See exception param message for explanation.
PrivilegeExceptionWhen caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values.
RpcExceptionWrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation.
Return typeDescription
List<User>list of allowed users

Example URL

https://[hostname]/krb/rpc/json/facilitiesManager/getAllowedUsers

Example params

{ "facility" : 27 , "vo" : 15 , "service" : 14 }

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 nameData typeDescription
facilityNameStringFacility name
Thrown exceptionDescription
InternalErrorExceptionWhen unspecified error occur. See exception param message for explanation.
PrivilegeExceptionWhen caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values.
RpcExceptionWrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation.
Return typeDescription
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 nameData typeDescription
facilityintFacility id
Thrown exceptionDescription
InternalErrorExceptionWhen unspecified error occur. See exception param message for explanation.
PrivilegeExceptionWhen caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values.
RpcExceptionWrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation.
Return typeDescription
List<Vo>List of VOs

Example URL

https://[hostname]/krb/rpc/json/facilitiesManager/getAllowedVos

Example params

{ "facility" : 83 }

Example response

[ { "id" : 123 , "name" : "My testing VO" , "shortName" : "test_vo" , "beanName" : "Vo" } , {...} , {...} ]

Get facilities where the service is defined..

Parameter nameData typeDescription
serviceintService id
Thrown exceptionDescription
InternalErrorExceptionWhen unspecified error occur. See exception param message for explanation.
PrivilegeExceptionWhen caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values.
RpcExceptionWrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation.
Return typeDescription
List<Facility>Assigned facilities

Example URL

https://[hostname]/krb/rpc/json/facilitiesManager/getAssignedFacilities

Example params

{ "service" : 81 }

Example response

[ { "id" : 24 , "name" : "host.facility.cz" , "description" : "is optional" , "beanName" : "Facility" } , {...} , {...} ]

Get facilities which are assigned to a Group (via resource).

Parameter nameData typeDescription
groupintGroup id
Thrown exceptionDescription
InternalErrorExceptionWhen unspecified error occur. See exception param message for explanation.
PrivilegeExceptionWhen caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values.
RpcExceptionWrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation.
Return typeDescription
List<Facility>Assigned facilities

Example URL

https://[hostname]/krb/rpc/json/facilitiesManager/getAssignedFacilities

Example params

{ "group" : 14 }

Example response

[ { "id" : 24 , "name" : "host.facility.cz" , "description" : "is optional" , "beanName" : "Facility" } , {...} , {...} ]

Get facilities which have the member access on.

Parameter nameData typeDescription
memberintMember id
Thrown exceptionDescription
InternalErrorExceptionWhen unspecified error occur. See exception param message for explanation.
PrivilegeExceptionWhen caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values.
RpcExceptionWrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation.
Return typeDescription
List<Facility>Assigned facilities

Example URL

https://[hostname]/krb/rpc/json/facilitiesManager/getAssignedFacilities

Example params

{ "member" : 1 }

Example response

[ { "id" : 24 , "name" : "host.facility.cz" , "description" : "is optional" , "beanName" : "Facility" } , {...} , {...} ]

Get facilities which have the user access on.

Parameter nameData typeDescription
userintUser id
Thrown exceptionDescription
InternalErrorExceptionWhen unspecified error occur. See exception param message for explanation.
PrivilegeExceptionWhen caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values.
RpcExceptionWrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation.
Return typeDescription
List<Facility>Assigned facilities

Example URL

https://[hostname]/krb/rpc/json/facilitiesManager/getAssignedFacilities

Example params

{ "user" : 14 }

Example response

[ { "id" : 24 , "name" : "host.facility.cz" , "description" : "is optional" , "beanName" : "Facility" } , {...} , {...} ]

Returns all resources assigned to a facility.

Parameter nameData typeDescription
facilityNameStringFacility name
Thrown exceptionDescription
InternalErrorExceptionWhen unspecified error occur. See exception param message for explanation.
PrivilegeExceptionWhen caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values.
RpcExceptionWrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation.
Return typeDescription
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 nameData typeDescription
facilityintFacility id
Thrown exceptionDescription
InternalErrorExceptionWhen unspecified error occur. See exception param message for explanation.
PrivilegeExceptionWhen caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values.
RpcExceptionWrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation.
Return typeDescription
List<Resource>Resources

Example URL

https://[hostname]/krb/rpc/json/facilitiesManager/getAssignedResources

Example params

{ "facility" : 68 }

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 nameData typeDescription
facilityintFacility id
serviceintService id
Thrown exceptionDescription
InternalErrorExceptionWhen unspecified error occur. See exception param message for explanation.
PrivilegeExceptionWhen caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values.
RpcExceptionWrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation.
Return typeDescription
List<Resource>Resources

Example URL

https://[hostname]/krb/rpc/json/facilitiesManager/getAssignedResourcesByAssignedService

Example params

{ "facility" : 85 , "service" : 26 }

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 nameData typeDescription
facilityNameStringFacility name
Thrown exceptionDescription
InternalErrorExceptionWhen unspecified error occur. See exception param message for explanation.
PrivilegeExceptionWhen caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values.
RpcExceptionWrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation.
Return typeDescription
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 nameData typeDescription
facilityintFacility id
Thrown exceptionDescription
InternalErrorExceptionWhen unspecified error occur. See exception param message for explanation.
PrivilegeExceptionWhen caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values.
RpcExceptionWrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation.
Return typeDescription
List<RichResource>Resources

Example URL

https://[hostname]/krb/rpc/json/facilitiesManager/getAssignedRichResources

Example params

{ "facility" : 63 }

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 nameData typeDescription
facilityintFacility id
serviceintService id
Thrown exceptionDescription
InternalErrorExceptionWhen unspecified error occur. See exception param message for explanation.
PrivilegeExceptionWhen caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values.
RpcExceptionWrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation.
Return typeDescription
List<RichResource>Resources

Example URL

https://[hostname]/krb/rpc/json/facilitiesManager/getAssignedRichResources

Example params

{ "facility" : 29 , "service" : 34 }

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 nameData typeDescription
facilityNameStringFacility name
Thrown exceptionDescription
FacilityNotExistsExceptionWhen Facility with given name doesn't exists.
InternalErrorExceptionWhen unspecified error occur. See exception param message for explanation.
PrivilegeExceptionWhen caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values.
RpcExceptionWrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation.
Return typeDescription
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 nameData typeDescription
facilityintFacility id
Thrown exceptionDescription
FacilityNotExistsExceptionWhen Facility with given id doesn't exists.
InternalErrorExceptionWhen unspecified error occur. See exception param message for explanation.
PrivilegeExceptionWhen caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values.
RpcExceptionWrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation.
Return typeDescription
List<SecurityTeam>assigned security teams fot given facility

Example URL

https://[hostname]/krb/rpc/json/facilitiesManager/getAssignedSecurityTeams

Example params

{ "facility" : 34 }

Example response

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

Lists all users assigned to facility containing resources where service is assigned.

Parameter nameData typeDescription
serviceintService id
facilityNameStringFacility name
Thrown exceptionDescription
InternalErrorExceptionWhen unspecified error occur. See exception param message for explanation.
PrivilegeExceptionWhen caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values.
RpcExceptionWrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation.
Return typeDescription
List<User>assigned users

Example URL

https://[hostname]/krb/rpc/json/facilitiesManager/getAssignedUsers

Example params

{ "service" : 31 , "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 nameData typeDescription
facilityNameStringFacility name
Thrown exceptionDescription
InternalErrorExceptionWhen unspecified error occur. See exception param message for explanation.
PrivilegeExceptionWhen caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values.
RpcExceptionWrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation.
Return typeDescription
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 nameData typeDescription
serviceintService id
facilityintFacility id
Thrown exceptionDescription
InternalErrorExceptionWhen unspecified error occur. See exception param message for explanation.
PrivilegeExceptionWhen caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values.
RpcExceptionWrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation.
Return typeDescription
List<User>assigned users

Example URL

https://[hostname]/krb/rpc/json/facilitiesManager/getAssignedUsers

Example params

{ "service" : 94 , "facility" : 75 }

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 nameData typeDescription
facilityintFacility id
Thrown exceptionDescription
InternalErrorExceptionWhen unspecified error occur. See exception param message for explanation.
PrivilegeExceptionWhen caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values.
RpcExceptionWrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation.
Return typeDescription
List<User>assigned users

Example URL

https://[hostname]/krb/rpc/json/facilitiesManager/getAssignedUsers

Example params

{ "facility" : 52 }

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 nameData typeDescription
userIdintUser id
facilityIdintFacility id
Thrown exceptionDescription
InternalErrorExceptionWhen unspecified error occur. See exception param message for explanation.
PrivilegeExceptionWhen caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values.
RpcExceptionWrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation.
Return typeDescription
BanOnFacilitybanOnFacility

Example URL

https://[hostname]/krb/rpc/json/facilitiesManager/getBan

Example params

{ "userId" : 94 , "facilityId" : 91 }

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 nameData typeDescription
banIdintBanOnFacility id
Thrown exceptionDescription
InternalErrorExceptionWhen unspecified error occur. See exception param message for explanation.
PrivilegeExceptionWhen caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values.
RpcExceptionWrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation.
Return typeDescription
BanOnFacilitybanOnFacility

Example URL

https://[hostname]/krb/rpc/json/facilitiesManager/getBanById

Example params

{ "banId" : 81 }

Example response

{ "id" : 3 , "validityTo" : 1533638919 , "description" : "banned" , "userId" : 2341 , "facilityId" : 233 , "beanName" : "BanOnFacility" }

Get all bans for user on the facility.

Parameter nameData typeDescription
facilityIdintFacility id
Thrown exceptionDescription
InternalErrorExceptionWhen unspecified error occur. See exception param message for explanation.
PrivilegeExceptionWhen caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values.
RpcExceptionWrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation.
Return typeDescription
List<BanOnFacility>usersBansOnFacility

Example URL

https://[hostname]/krb/rpc/json/facilitiesManager/getBansForFacility

Example params

{ "facilityId" : 24 }

Example response

[ { "id" : 3 , "validityTo" : 1533638919 , "description" : "banned" , "userId" : 2341 , "facilityId" : 233 , "beanName" : "BanOnFacility" } , {...} , {...} ]

Get all bans for user on any facility.

Parameter nameData typeDescription
userIdintUser id
Thrown exceptionDescription
InternalErrorExceptionWhen unspecified error occur. See exception param message for explanation.
PrivilegeExceptionWhen caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values.
RpcExceptionWrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation.
Return typeDescription
List<BanOnFacility>userBansOnFacilities

Example URL

https://[hostname]/krb/rpc/json/facilitiesManager/getBansForUser

Example params

{ "userId" : 77 }

Example response

[ { "id" : 3 , "validityTo" : 1533638919 , "description" : "banned" , "userId" : 2341 , "facilityId" : 233 , "beanName" : "BanOnFacility" } , {...} , {...} ]

Get all Facility direct admins.

Parameter nameData typeDescription
facilityNameStringFacility name
Thrown exceptionDescription
InternalErrorExceptionWhen unspecified error occur. See exception param message for explanation.
PrivilegeExceptionWhen caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values.
RpcExceptionWrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation.
Return typeDescription
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 nameData typeDescription
facilityNameStringFacility name
specificAttributesList<String>list of attributes URNs
Thrown exceptionDescription
InternalErrorExceptionWhen unspecified error occur. See exception param message for explanation.
PrivilegeExceptionWhen caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values.
RpcExceptionWrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation.
Return typeDescription
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 nameData typeDescription
facilityintFacility id
specificAttributesList<String>list of attributes URNs
Thrown exceptionDescription
InternalErrorExceptionWhen unspecified error occur. See exception param message for explanation.
PrivilegeExceptionWhen caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values.
RpcExceptionWrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation.
Return typeDescription
List<RichUser>direct admins with attributes

Example URL

https://[hostname]/krb/rpc/json/facilitiesManager/getDirectRichAdminsWithSpecificAttributes

Example params

{ "facility" : 46 , "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 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 exceptionDescription
InternalErrorExceptionWhen unspecified error occur. See exception param message for explanation.
PrivilegeExceptionWhen caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values.
RpcExceptionWrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation.
Return typeDescription
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 nameData typeDescription
facilityintFacility id
attrNamesList<String>Attribute names
Thrown exceptionDescription
InternalErrorExceptionWhen unspecified error occur. See exception param message for explanation.
PrivilegeExceptionWhen caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values.
RpcExceptionWrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation.
Return typeDescription
List<EnrichedHosts>enrichedHosts

Example URL

https://[hostname]/krb/rpc/json/facilitiesManager/getEnrichedHosts

Example params

{ "facility" : 97 , "attrNames" : [ "text" , "text" ] }

Example response

{ ... TODO ... }

List all facilities.

Thrown exceptionDescription
InternalErrorExceptionWhen unspecified error occur. See exception param message for explanation.
PrivilegeExceptionWhen caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values.
RpcExceptionWrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation.
Return typeDescription
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 nameData typeDescription
attributeNameString
attributeValueString
Thrown exceptionDescription
InternalErrorExceptionWhen unspecified error occur. See exception param message for explanation.
PrivilegeExceptionWhen caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values.
RpcExceptionWrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation.
Return typeDescription
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 for the Facilities by theirs destination.

Parameter nameData typeDescription
destinationStringDestination
Thrown exceptionDescription
InternalErrorExceptionWhen unspecified error occur. See exception param message for explanation.
PrivilegeExceptionWhen caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values.
RpcExceptionWrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation.
Return typeDescription
FacilityFound 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 nameData typeDescription
hostnameStringspecific hostname
Thrown exceptionDescription
InternalErrorExceptionWhen unspecified error occur. See exception param message for explanation.
PrivilegeExceptionWhen caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values.
RpcExceptionWrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation.
Return typeDescription
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 nameData typeDescription
idsList<Integer>list of facilities IDs
Thrown exceptionDescription
InternalErrorExceptionWhen unspecified error occur. See exception param message for explanation.
PrivilegeExceptionWhen caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values.
RpcExceptionWrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation.
Return typeDescription
List<Facility>facilities with specified IDs

Example URL

https://[hostname]/krb/rpc/json/facilitiesManager/getFacilitiesByIds

Example params

{ "ids" : [ 44 , 3 ] }

Example response

[ { "id" : 24 , "name" : "host.facility.cz" , "description" : "is optional" , "beanName" : "Facility" } , {...} , {...} ]

Gets count of all facilities.

Thrown exceptionDescription
InternalErrorExceptionWhen unspecified error occur. See exception param message for explanation.
PrivilegeExceptionWhen caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values.
RpcExceptionWrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation.
Return typeDescription
intFacilities count

Example URL

https://[hostname]/krb/rpc/json/facilitiesManager/getFacilitiesCount

Example response

40

Returns list of Facilities, where the user is an Administrator. Including facilities, where the user is a VALID member of authorized group.

Parameter nameData typeDescription
userintUser id
Thrown exceptionDescription
InternalErrorExceptionWhen unspecified error occur. See exception param message for explanation.
PrivilegeExceptionWhen caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values.
RpcExceptionWrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation.
Return typeDescription
List<Facility>Found Facilities

Example URL

https://[hostname]/krb/rpc/json/facilitiesManager/getFacilitiesWhereUserIsAdmin

Example params

{ "user" : 5 }

Example response

[ { "id" : 24 , "name" : "host.facility.cz" , "description" : "is optional" , "beanName" : "Facility" } , {...} , {...} ]

Searches for the Facility with specified id.

Parameter nameData typeDescription
idintFacility id
Thrown exceptionDescription
InternalErrorExceptionWhen unspecified error occur. See exception param message for explanation.
PrivilegeExceptionWhen caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values.
RpcExceptionWrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation.
Return typeDescription
FacilityFound facility

Example URL

https://[hostname]/krb/rpc/json/facilitiesManager/getFacilityById

Example params

{ "id" : 32 }

Example response

{ "id" : 24 , "name" : "host.facility.cz" , "description" : "is optional" , "beanName" : "Facility" }

Searches the Facility by its name.

Parameter nameData typeDescription
nameStringFacility name
Thrown exceptionDescription
InternalErrorExceptionWhen unspecified error occur. See exception param message for explanation.
PrivilegeExceptionWhen caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values.
RpcExceptionWrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation.
Return typeDescription
FacilityFound 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 nameData typeDescription
hostintHost id
Thrown exceptionDescription
InternalErrorExceptionWhen unspecified error occur. See exception param message for explanation.
PrivilegeExceptionWhen caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values.
RpcExceptionWrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation.
Return typeDescription
FacilityFacility object

Example URL

https://[hostname]/krb/rpc/json/facilitiesManager/getFacilityForHost

Example params

{ "host" : 99 }

Example response

{ "id" : 24 , "name" : "host.facility.cz" , "description" : "is optional" , "beanName" : "Facility" }

Returns a host by its id.

Parameter nameData typeDescription
idintHost id
Thrown exceptionDescription
InternalErrorExceptionWhen unspecified error occur. See exception param message for explanation.
PrivilegeExceptionWhen caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values.
RpcExceptionWrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation.
Return typeDescription
HostHost object

Example URL

https://[hostname]/krb/rpc/json/facilitiesManager/getHostById

Example params

{ "id" : 7 }

Example response

{ "id" : 523 , "hostname" : "host1.host.cz" }

Lists hosts of a Facility.

Parameter nameData typeDescription
facilityNameStringFacility name
Thrown exceptionDescription
InternalErrorExceptionWhen unspecified error occur. See exception param message for explanation.
PrivilegeExceptionWhen caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values.
RpcExceptionWrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation.
Return typeDescription
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 nameData typeDescription
facilityintFacility id
Thrown exceptionDescription
InternalErrorExceptionWhen unspecified error occur. See exception param message for explanation.
PrivilegeExceptionWhen caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values.
RpcExceptionWrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation.
Return typeDescription
List<Host>Hosts

Example URL

https://[hostname]/krb/rpc/json/facilitiesManager/getHosts

Example params

{ "facility" : 93 }

Example response

[ { "id" : 523 , "hostname" : "host1.host.cz" } , {...} , {...} ]

Returns hosts by hostname. (from all facilities)

Parameter nameData typeDescription
hostnameStringhostname of hosts
Thrown exceptionDescription
InternalErrorExceptionWhen unspecified error occur. See exception param message for explanation.
PrivilegeExceptionWhen caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values.
RpcExceptionWrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation.
Return typeDescription
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 nameData typeDescription
facilityNameStringFacility name
Thrown exceptionDescription
InternalErrorExceptionWhen unspecified error occur. See exception param message for explanation.
PrivilegeExceptionWhen caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values.
RpcExceptionWrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation.
Return typeDescription
intHosts count

Example URL

https://[hostname]/krb/rpc/json/facilitiesManager/getHostsCount

Example params

{ "facilityName" : "text" }

Example response

23

Count hosts of Facility.

Parameter nameData typeDescription
facilityintFacility id
Thrown exceptionDescription
InternalErrorExceptionWhen unspecified error occur. See exception param message for explanation.
PrivilegeExceptionWhen caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values.
RpcExceptionWrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation.
Return typeDescription
intHosts count

Example URL

https://[hostname]/krb/rpc/json/facilitiesManager/getHostsCount

Example params

{ "facility" : 59 }

Example response

31

Returns list of all facilities owned by the owner.

Parameter nameData typeDescription
ownerintOwner id
Thrown exceptionDescription
InternalErrorExceptionWhen unspecified error occur. See exception param message for explanation.
PrivilegeExceptionWhen caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values.
RpcExceptionWrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation.
Return typeDescription
List<Facility>Owner's facilities

Example URL

https://[hostname]/krb/rpc/json/facilitiesManager/getOwnerFacilities

Example params

{ "owner" : 82 }

Example response

[ { "id" : 24 , "name" : "host.facility.cz" , "description" : "is optional" , "beanName" : "Facility" } , {...} , {...} ]

Returns owners of a facility.

Parameter nameData typeDescription
facilityNameStringFacility name
Thrown exceptionDescription
InternalErrorExceptionWhen unspecified error occur. See exception param message for explanation.
PrivilegeExceptionWhen caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values.
RpcExceptionWrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation.
Return typeDescription
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 nameData typeDescription
facilityintFacility id
Thrown exceptionDescription
InternalErrorExceptionWhen unspecified error occur. See exception param message for explanation.
PrivilegeExceptionWhen caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values.
RpcExceptionWrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation.
Return typeDescription
List<Owner>Facility owners

Example URL

https://[hostname]/krb/rpc/json/facilitiesManager/getOwners

Example params

{ "facility" : 8 }

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 nameData typeDescription
facilityNameStringFacility name
specificAttributesList<String>list of specified attributes which are needed in object richUser
allUserAttributesbooleanif == true, get all possible user attributes and ignore list of specificAttributes (if false, get only specific attributes)
onlyDirectAdminsbooleanif == true, get only direct facility administrators (if false, get both direct and indirect)
Thrown exceptionDescription
InternalErrorExceptionWhen unspecified error occur. See exception param message for explanation.
PrivilegeExceptionWhen caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values.
RpcExceptionWrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation.
Return typeDescription
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 nameData typeDescription
facilityNameStringFacility name
Thrown exceptionDescription
InternalErrorExceptionWhen unspecified error occur. See exception param message for explanation.
PrivilegeExceptionWhen caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values.
RpcExceptionWrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation.
Return typeDescription
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 nameData typeDescription
facilityintFacility id
specificAttributesList<String>list of specified attributes which are needed in object richUser
allUserAttributesbooleanif == true, get all possible user attributes and ignore list of specificAttributes (if false, get only specific attributes)
onlyDirectAdminsbooleanif == true, get only direct facility administrators (if false, get both direct and indirect)
Thrown exceptionDescription
InternalErrorExceptionWhen unspecified error occur. See exception param message for explanation.
PrivilegeExceptionWhen caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values.
RpcExceptionWrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation.
Return typeDescription
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" : 44 , "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 nameData typeDescription
facilityintFacility id
Thrown exceptionDescription
InternalErrorExceptionWhen unspecified error occur. See exception param message for explanation.
PrivilegeExceptionWhen caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values.
RpcExceptionWrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation.
Return typeDescription
List<RichUser>admins

Example URL

https://[hostname]/krb/rpc/json/facilitiesManager/getRichAdmins

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" : "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 nameData typeDescription
facilityNameStringFacility name
Thrown exceptionDescription
InternalErrorExceptionWhen unspecified error occur. See exception param message for explanation.
PrivilegeExceptionWhen caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values.
RpcExceptionWrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation.
Return typeDescription
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 nameData typeDescription
facilityintFacility id
Thrown exceptionDescription
InternalErrorExceptionWhen unspecified error occur. See exception param message for explanation.
PrivilegeExceptionWhen caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values.
RpcExceptionWrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation.
Return typeDescription
List<RichUser>admins with attributes

Example URL

https://[hostname]/krb/rpc/json/facilitiesManager/getRichAdminsWithAttributes

Example params

{ "facility" : 27 }

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 nameData typeDescription
facilityNameStringFacility name
specificAttributesList<String>list of attributes URNs
Thrown exceptionDescription
InternalErrorExceptionWhen unspecified error occur. See exception param message for explanation.
PrivilegeExceptionWhen caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values.
RpcExceptionWrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation.
Return typeDescription
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 nameData typeDescription
facilityintFacility id
specificAttributesList<String>list of attributes URNs
Thrown exceptionDescription
InternalErrorExceptionWhen unspecified error occur. See exception param message for explanation.
PrivilegeExceptionWhen caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values.
RpcExceptionWrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation.
Return typeDescription
List<RichUser>admins with attributes

Example URL

https://[hostname]/krb/rpc/json/facilitiesManager/getRichAdminsWithSpecificAttributes

Example params

{ "facility" : 51 , "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 exceptionDescription
InternalErrorExceptionWhen unspecified error occur. See exception param message for explanation.
PrivilegeExceptionWhen caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values.
RpcExceptionWrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation.
Return typeDescription
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 nameData typeDescription
facilityNameStringFacility name
userintUser id
Thrown exceptionDescription
InternalErrorExceptionWhen unspecified error occur. See exception param message for explanation.
PrivilegeExceptionWhen caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values.
RpcExceptionWrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation.
Return typeDescription
void

Example URL

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

Example params

{ "facilityName" : "text" , "user" : 57 }

Example response

null

Removes a group administrator of the Facility.

Parameter nameData typeDescription
facilityNameStringFacility name
authorizedGroupintGroup id
Thrown exceptionDescription
InternalErrorExceptionWhen unspecified error occur. See exception param message for explanation.
PrivilegeExceptionWhen caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values.
RpcExceptionWrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation.
Return typeDescription
void

Example URL

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

Example params

{ "facilityName" : "text" , "authorizedGroup" : 71 }

Example response

null

Removes a Facility admin.

Parameter nameData typeDescription
facilityintFacility id
userintUser id
Thrown exceptionDescription
InternalErrorExceptionWhen unspecified error occur. See exception param message for explanation.
PrivilegeExceptionWhen caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values.
RpcExceptionWrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation.
Return typeDescription
void

Example URL

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

Example params

{ "facility" : 91 , "user" : 86 }

Example response

null

Removes a group administrator of the Facility.

Parameter nameData typeDescription
facilityintFacility id
authorizedGroupintGroup id
Thrown exceptionDescription
InternalErrorExceptionWhen unspecified error occur. See exception param message for explanation.
PrivilegeExceptionWhen caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values.
RpcExceptionWrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation.
Return typeDescription
void

Example URL

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

Example params

{ "facility" : 79 , "authorizedGroup" : 81 }

Example response

null

Remove specific ban by it's id.

Parameter nameData typeDescription
banIdintBanOnFacility id
Thrown exceptionDescription
InternalErrorExceptionWhen unspecified error occur. See exception param message for explanation.
PrivilegeExceptionWhen caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values.
RpcExceptionWrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation.
Return typeDescription
void

Example URL

https://[hostname]/krb/rpc/json/facilitiesManager/removeBan

Example params

{ "banId" : 69 }

Example response

null

Remove specific ban by userId and facilityId.

Parameter nameData typeDescription
userIdintUser id
facilityIdintFacility id
Thrown exceptionDescription
InternalErrorExceptionWhen unspecified error occur. See exception param message for explanation.
PrivilegeExceptionWhen caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values.
RpcExceptionWrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation.
Return typeDescription
void

Example URL

https://[hostname]/krb/rpc/json/facilitiesManager/removeBan

Example params

{ "userId" : 84 , "facilityId" : 99 }

Example response

null

Removes a host.

Parameter nameData typeDescription
hostintHost id
Thrown exceptionDescription
InternalErrorExceptionWhen unspecified error occur. See exception param message for explanation.
PrivilegeExceptionWhen caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values.
RpcExceptionWrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation.
Return typeDescription
void

Example URL

https://[hostname]/krb/rpc/json/facilitiesManager/removeHost

Example params

{ "host" : 15 }

Example response

null

Remove host from the Facility based on hostname. If there is ambiguity, method throws exception and no host is removed.

Parameter nameData typeDescription
hostnameStringhostname
Thrown exceptionDescription
HostNotExistsExceptionWhen host doesn't exist or is not unique by name
InternalErrorExceptionWhen unspecified error occur. See exception param message for explanation.
PrivilegeExceptionWhen caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values.
RpcExceptionWrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation.
Return typeDescription
void

Example URL

https://[hostname]/krb/rpc/json/facilitiesManager/removeHostByHostname

Example params

{ "hostname" : "text" }

Example response

null

Remove hosts from a Facility.

Parameter nameData typeDescription
hostsList<Integer>List of Host IDs
facilityNameStringFacility name
Thrown exceptionDescription
InternalErrorExceptionWhen unspecified error occur. See exception param message for explanation.
PrivilegeExceptionWhen caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values.
RpcExceptionWrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation.
Return typeDescription
void

Example URL

https://[hostname]/krb/rpc/json/facilitiesManager/removeHosts

Example params

{ "hosts" : [ 27 , 55 ] , "facilityName" : "text" }

Example response

null

Remove hosts from a Facility.

Parameter nameData typeDescription
hostsList<Integer>List of Host IDs
facilityintFacility id
Thrown exceptionDescription
InternalErrorExceptionWhen unspecified error occur. See exception param message for explanation.
PrivilegeExceptionWhen caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values.
RpcExceptionWrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation.
Return typeDescription
void

Example URL

https://[hostname]/krb/rpc/json/facilitiesManager/removeHosts

Example params

{ "hosts" : [ 43 , 59 ] , "facility" : 24 }

Example response

null

Remove owner of a facility.

Parameter nameData typeDescription
facilityNameStringFacility name
ownerNameStringOwner name
Thrown exceptionDescription
InternalErrorExceptionWhen unspecified error occur. See exception param message for explanation.
PrivilegeExceptionWhen caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values.
RpcExceptionWrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation.
Return typeDescription
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 nameData typeDescription
facilityintFacility id
ownerNameStringOwner name
Thrown exceptionDescription
InternalErrorExceptionWhen unspecified error occur. See exception param message for explanation.
PrivilegeExceptionWhen caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values.
RpcExceptionWrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation.
Return typeDescription
void

Example URL

https://[hostname]/krb/rpc/json/facilitiesManager/removeOwner

Example params

{ "facility" : 34 , "ownerName" : "text" }

Example response

null

Remove owner of a facility.

Parameter nameData typeDescription
facilityNameStringFacility name
ownerintOwner id
Thrown exceptionDescription
InternalErrorExceptionWhen unspecified error occur. See exception param message for explanation.
PrivilegeExceptionWhen caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values.
RpcExceptionWrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation.
Return typeDescription
void

Example URL

https://[hostname]/krb/rpc/json/facilitiesManager/removeOwner

Example params

{ "facilityName" : "text" , "owner" : 4 }

Example response

null

Remove owner of a facility.

Parameter nameData typeDescription
facilityintFacility id
ownerintOwner id
Thrown exceptionDescription
InternalErrorExceptionWhen unspecified error occur. See exception param message for explanation.
PrivilegeExceptionWhen caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values.
RpcExceptionWrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation.
Return typeDescription
void

Example URL

https://[hostname]/krb/rpc/json/facilitiesManager/removeOwner

Example params

{ "facility" : 0 , "owner" : 1 }

Example response

null

Remove (Unassign) given security team from given facility

Parameter nameData typeDescription
facilityNameStringFacility name
securityTeamintSecurityTeam id
Thrown exceptionDescription
FacilityNotExistsExceptionWhen Facility with given name doesn't exists.
InternalErrorExceptionWhen unspecified error occur. See exception param message for explanation.
PrivilegeExceptionWhen caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values.
RpcExceptionWrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation.
SecurityTeamNotAssignedExceptionWhen SecurityTeam with given id is not assigned.
SecurityTeamNotExistsExceptionWhen SecurityTeam with given id doesn't exists.
Return typeDescription
void

Example URL

https://[hostname]/krb/rpc/json/facilitiesManager/removeSecurityTeam

Example params

{ "facilityName" : "text" , "securityTeam" : 17 }

Example response

null

Remove (Unassign) given security team from given facility

Parameter nameData typeDescription
facilityintFacility id
securityTeamintSecurityTeam id
Thrown exceptionDescription
FacilityNotExistsExceptionWhen Facility with given id doesn't exists.
InternalErrorExceptionWhen unspecified error occur. See exception param message for explanation.
PrivilegeExceptionWhen caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values.
RpcExceptionWrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation.
SecurityTeamNotAssignedExceptionWhen SecurityTeam with given id is not assigned.
SecurityTeamNotExistsExceptionWhen SecurityTeam with given id doesn't exists.
Return typeDescription
void

Example URL

https://[hostname]/krb/rpc/json/facilitiesManager/removeSecurityTeam

Example params

{ "facility" : 89 , "securityTeam" : 4 }

Example response

null

Set ban for user on facility.

Parameter nameData typeDescription
banOnFacilityBanOnFacilityJSON object
Thrown exceptionDescription
InternalErrorExceptionWhen unspecified error occur. See exception param message for explanation.
PrivilegeExceptionWhen caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values.
RpcExceptionWrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation.
Return typeDescription
BanOnFacilityCreated 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 nameData typeDescription
banOnFacilityBanOnFacilityJSON object
Thrown exceptionDescription
InternalErrorExceptionWhen unspecified error occur. See exception param message for explanation.
PrivilegeExceptionWhen caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values.
RpcExceptionWrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation.
Return typeDescription
BanOnFacilityupdated 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 nameData typeDescription
facilityFacilityJSON object
Thrown exceptionDescription
InternalErrorExceptionWhen unspecified error occur. See exception param message for explanation.
PrivilegeExceptionWhen caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values.
RpcExceptionWrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation.
Return typeDescription
Facilityupdated 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" }