RPC API documentation v17.2.0

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

ServicesManager

Adds an destination for a facility and service. If destination doesn't exist it will be created.

Parameter nameData typeDescription
serviceintService id
facilityintFacility id
destinationStringDestination
typeStringDestination type (host,user@host,user@host:port,url,mail,service-specific)
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
DestinationCreated destination.

Example URL

https://[hostname]/krb/rpc/json/servicesManager/addDestination

Example params

{ "service" : 32 , "facility" : 69 , "destination" : "text" , "type" : "text" }

Example response

{ "id" : 99 , "destination" : "host@host.cz" , "type" : "HOST" , "propagationType" : "PARALLEL" }

Adds an destination for a facility and list of services. If destination doesn't exist it will be created.

Parameter nameData typeDescription
servicesList<Service>Services
facilityintFacility id
destinationStringDestination
typeStringDestination type (host,user@host,user@host:port,url,mail,service-specific)
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
DestinationCreated destination.

Example URL

https://[hostname]/krb/rpc/json/servicesManager/addDestination

Example params

{ "services" : [ { "id" : 290 , "name" : "passwd" , "description" : "Provision /etc/passwd file." , "delay" : 10 , "recurrence" : 2 , "enabled" : true , "script" : "./passwd" , "useExpiredMembers" : false } , {...} , {...} ] , "facility" : 39 , "destination" : "text" , "type" : "text" }

Example response

{ "id" : 99 , "destination" : "host@host.cz" , "type" : "HOST" , "propagationType" : "PARALLEL" }

Adds an destination for a facility and service. If destination doesn't exist it will be created.

Parameter nameData typeDescription
serviceintService id
facilityintFacility id
destinationStringDestination
typeStringDestination type (host,user@host,user@host:port,url,mail,service-specific)
propagationTypeStringpropagation type (PARALLEL, DUMMY - doesn't send data)
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
DestinationCreated destination.

Example URL

https://[hostname]/krb/rpc/json/servicesManager/addDestination

Example params

{ "service" : 26 , "facility" : 36 , "destination" : "text" , "type" : "text" , "propagationType" : "text" }

Example response

{ "id" : 99 , "destination" : "host@host.cz" , "type" : "HOST" , "propagationType" : "PARALLEL" }

Adds an destination for a facility and list of services. If destination doesn't exist it will be created.

Parameter nameData typeDescription
servicesList<Service>Services
facilityintFacility id
destinationStringDestination
typeStringDestination type (host,user@host,user@host:port,url,mail,service-specific)
propagationTypeStringpropagation type (PARALLEL, DUMMY - doesn't send data)
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
DestinationCreated destination.

Example URL

https://[hostname]/krb/rpc/json/servicesManager/addDestination

Example params

{ "services" : [ { "id" : 290 , "name" : "passwd" , "description" : "Provision /etc/passwd file." , "delay" : 10 , "recurrence" : 2 , "enabled" : true , "script" : "./passwd" , "useExpiredMembers" : false } , {...} , {...} ] , "facility" : 3 , "destination" : "text" , "type" : "text" , "propagationType" : "text" }

Example response

{ "id" : 99 , "destination" : "host@host.cz" , "type" : "HOST" , "propagationType" : "PARALLEL" }

Add services destinations for all services currently available on facility (assigned to all facility's resources). Destinations names are taken from all facility's host hostnames.

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<Destinations>Added destinations

Example URL

https://[hostname]/krb/rpc/json/servicesManager/addDestinationsDefinedByHostsOnFacility

Example params

{ "service" : 61 , "facility" : 37 }

Example response

{ ... TODO ... }

Add services destinations for list of services. Destinations names are taken from all facility's host hostnames.

Parameter nameData typeDescription
servicesList<Service>Services
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<Destinations>Added destinations

Example URL

https://[hostname]/krb/rpc/json/servicesManager/addDestinationsDefinedByHostsOnFacility

Example params

{ "services" : [ { "id" : 290 , "name" : "passwd" , "description" : "Provision /etc/passwd file." , "delay" : 10 , "recurrence" : 2 , "enabled" : true , "script" : "./passwd" , "useExpiredMembers" : false } , {...} , {...} ] , "facility" : 15 }

Example response

{ ... TODO ... }

Add services destinations for one service. Destinations names are taken from all facility's host hostnames.

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<Destinations>Added destinations

Example URL

https://[hostname]/krb/rpc/json/servicesManager/addDestinationsDefinedByHostsOnFacility

Example params

{ "facility" : 71 }

Example response

{ ... TODO ... }

Adds destination for all services defined on the facility.

Parameter nameData typeDescription
facilityintFacility id
destinationStringDestination
typeStringString Destination type (host,user@host,user@host:port,url,mail,service-specific)
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<Destinations>Added destinations

Example URL

https://[hostname]/krb/rpc/json/servicesManager/addDestinationsForAllServicesOnFacility

Example params

{ "facility" : 31 , "destination" : "text" , "type" : "text" }

Example response

{ ... TODO ... }

Adds destination for all services defined on the facility.

Parameter nameData typeDescription
facilityintFacility id
destinationStringDestination
typeStringDestination type (host,user@host,user@host:port,url,mail,service-specific)
propagationTypeStringpropagation type (PARALLEL, DUMMY - doesn't send data)
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<Destinations>Added destinations

Example URL

https://[hostname]/krb/rpc/json/servicesManager/addDestinationsForAllServicesOnFacility

Example params

{ "facility" : 66 , "destination" : "text" , "type" : "text" , "propagationType" : "text" }

Example response

{ ... TODO ... }

Mark the attribute as required for the service. Required attributes are requisite for Service to run. If you add attribute which has a default attribute then this default attribute will be automatically add too.

Parameter nameData typeDescription
serviceintService id
attributeintAttribute 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.
ServiceAttributesCannotExtendif trying to add user-related attribute that could invalidate consents, requires disabling service
Return typeDescription
void

Example URL

https://[hostname]/krb/rpc/json/servicesManager/addRequiredAttribute

Example params

{ "service" : 17 , "attribute" : 63 }

Example response

null

Batch version of addRequiredAttribute.

Parameter nameData typeDescription
serviceintService id
attributesint[]Attribute 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.
ServiceAttributesCannotExtendif trying to add user-related attribute that could invalidate consents, requires disabling service
Return typeDescription
void

Example URL

https://[hostname]/krb/rpc/json/servicesManager/addRequiredAttributes

Example params

{ "service" : 72 , "attributes" : [ 95 , 69 ] }

Example response

null

Adds a Service to a Services Package.

Parameter nameData typeDescription
servicesPackageintServices package id to which the service supposed to be added
serviceintService id to be added to the services package
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/servicesManager/addServiceToServicesPackage

Example params

{ "servicesPackage" : 69 , "service" : 81 }

Example response

null

Block all services currently assigned on this destination. Newly assigned services are still allowed for propagation.

Parameter nameData typeDescription
destinationintDestination 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/servicesManager/blockAllServicesOnDestination

Example params

{ "destination" : 25 }

Example response

null

Block all services currently assigned on this destination. Newly assigned services are still allowed for propagation.

Parameter nameData typeDescription
destinationNameStringDestination name (like hostnames)
destinationTypeStringDestination type (like host, user@host, user@host:port, email, service-specific, ...)
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/servicesManager/blockAllServicesOnDestination

Example params

{ "destinationName" : "text" , "destinationType" : "text" }

Example response

null

Block all services currently assigned on this facility. Newly assigned services are still allowed for propagation.

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/servicesManager/blockAllServicesOnFacility

Example params

{ "facility" : 80 }

Example response

null

Bans Service on a destination.

Parameter nameData typeDescription
serviceintService id
destinationintDestination 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/servicesManager/blockServiceOnDestination

Example params

{ "service" : 1 , "destination" : 14 }

Example response

null

Bans Service on a destination.

Parameter nameData typeDescription
serviceintService id
destinationNameStringDestination name (like hostnames)
destinationTypeStringDestination type (like host, user@host, user@host:port, email, service-specific, ...)
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/servicesManager/blockServiceOnDestination

Example params

{ "service" : 3 , "destinationName" : "text" , "destinationType" : "text" }

Example response

null

Bans service on a facility.

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.
ServiceAlreadyBannedExceptionWhen service is already banned on facility.
Return typeDescription
void

Example URL

https://[hostname]/krb/rpc/json/servicesManager/blockServiceOnFacility

Example params

{ "service" : 46 , "facility" : 20 }

Example response

null

Creates a new service. Service object must contain name. Parameters desctiption, script, delay, recurrence, enabled are optional. Other parameters ignored.

Parameter nameData typeDescription
serviceServiceJSON 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
ServiceCreated Service

Example URL

https://[hostname]/krb/rpc/json/servicesManager/createService

Example params

{ "service" : { "name" : "New Service"} }

Example response

{ "id" : 290 , "name" : "passwd" , "description" : "Provision /etc/passwd file." , "delay" : 10 , "recurrence" : 2 , "enabled" : true , "script" : "./passwd" , "useExpiredMembers" : false }

Creates a new service.

Parameter nameData typeDescription
nameStringname
descriptionStringdescription
scriptStringscript which should be constructed like ./service_name (where anything else than [a-z,A-Z] is converted to _)
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
ServiceCreated Service

Example URL

https://[hostname]/krb/rpc/json/servicesManager/createService

Example params

{ "name" : "New Service" , "description" : "The new description with information" , "script" : "./service_name" }

Example response

{ "id" : 290 , "name" : "passwd" , "description" : "Provision /etc/passwd file." , "delay" : 10 , "recurrence" : 2 , "enabled" : true , "script" : "./passwd" , "useExpiredMembers" : false }

Creates a new services package.

Parameter nameData typeDescription
servicesPackageServicesPackageJSON 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
ServicesPackageCreated ServicesPackage

Example URL

https://[hostname]/krb/rpc/json/servicesManager/createServicesPackage

Example params

{ "servicesPackage" : { "id" : 50 , "name" : "Unix account" , "description" : "Collection of services for managing unix accounts." } }

Example response

{ "id" : 50 , "name" : "Unix account" , "description" : "Collection of services for managing unix accounts." }

Creates a new services package.

Parameter nameData typeDescription
nameStringname
descriptionStringdescription
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
ServicesPackageCreated ServicesPackage

Example URL

https://[hostname]/krb/rpc/json/servicesManager/createServicesPackage

Example params

{ "name" : "text" , "description" : "text" }

Example response

{ "id" : 50 , "name" : "Unix account" , "description" : "Collection of services for managing unix accounts." }

Deletes a service.

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
void

Example URL

https://[hostname]/krb/rpc/json/servicesManager/deleteService

Example params

{ "service" : 62 }

Example response

null

Deletes a service.

Parameter nameData typeDescription
serviceintService id
forcebooleanif true, service will be removed with all dependant objects from the db instead of raising exception
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/servicesManager/deleteService

Example params

{ "service" : 2 , "force" : true }

Example response

null

Deletes a services package.

Parameter nameData typeDescription
servicesPackageintServicesPackage 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/servicesManager/deleteServicesPackage

Example params

{ "servicesPackage" : 12 }

Example response

null

Forces service propagation on defined facility.

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
int1 = true if it is possible, 0 = false if not

Example URL

https://[hostname]/krb/rpc/json/servicesManager/forceServicePropagation

Example params

{ "service" : 32 , "facility" : 21 }

Example response

15

Forces service propagation for defined service on all facilities.

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
int1 = true if it is possible, 0 = false if not

Example URL

https://[hostname]/krb/rpc/json/servicesManager/forceServicePropagation

Example params

{ "service" : 78 }

Example response

92

Returns all rich destinations defined for 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<RichDestination>Found RichDestinations

Example URL

https://[hostname]/krb/rpc/json/servicesManager/getAllRichDestinations

Example params

{ "facility" : 2 }

Example response

[ { "id" : 99 , "destination" : "host@host.cz" , "type" : "HOST" , "propagationType" : "PARALLEL" , "service" : { "id" : 290 , "name" : "passwd" , "description" : "Provision /etc/passwd file." , "delay" : 10 , "recurrence" : 2 , "enabled" : true , "script" : "./passwd" , "useExpiredMembers" : false } , "facility" : { "id" : 24 , "name" : "host.facility.cz" , "description" : "is optional" , "beanName" : "Facility" } } , {...} , {...} ]

Returns all rich destinations defined for a service.

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<RichDestination>Found RichDestinations

Example URL

https://[hostname]/krb/rpc/json/servicesManager/getAllRichDestinations

Example params

{ "service" : 20 }

Example response

[ { "id" : 99 , "destination" : "host@host.cz" , "type" : "HOST" , "propagationType" : "PARALLEL" , "service" : { "id" : 290 , "name" : "passwd" , "description" : "Provision /etc/passwd file." , "delay" : 10 , "recurrence" : 2 , "enabled" : true , "script" : "./passwd" , "useExpiredMembers" : false } , "facility" : { "id" : 24 , "name" : "host.facility.cz" , "description" : "is optional" , "beanName" : "Facility" } } , {...} , {...} ]

Lists resources assigned to service.

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<Resource>List of resources

Example URL

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

Example params

{ "service" : 47 }

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" } , {...} , {...} ]

List all services associated with the facility (via resource).

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<Service>Found services

Example URL

https://[hostname]/krb/rpc/json/servicesManager/getAssignedServices

Example params

{ "facility" : 83 }

Example response

[ { "id" : 290 , "name" : "passwd" , "description" : "Provision /etc/passwd file." , "delay" : 10 , "recurrence" : 2 , "enabled" : true , "script" : "./passwd" , "useExpiredMembers" : false } , {...} , {...} ]

List all services associated with the facility and vo (via resource).

Parameter nameData typeDescription
facilityintFacility id
vointVo 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<Service>Found services

Example URL

https://[hostname]/krb/rpc/json/servicesManager/getAssignedServices

Example params

{ "facility" : 10 , "vo" : 22 }

Example response

[ { "id" : 290 , "name" : "passwd" , "description" : "Provision /etc/passwd file." , "delay" : 10 , "recurrence" : 2 , "enabled" : true , "script" : "./passwd" , "useExpiredMembers" : false } , {...} , {...} ]

Generates the list of attributes per each member associated with the resources and groups. Resource first child is abstract structure which children are groups. Resource second child is abstract structure which children are members. Group first child is empty structure (services expect members to be second child, here used to be subgroups). Group second child is abstract structure which children are members.

Parameter nameData typeDescription
serviceintService id. You will get attributes reuqired by this service
facilityintFacility id. You will get attributes for this facility, resources associated with it and members assigned to the resources
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
ServiceAttributesAttributes in special structure. Facility is in the root, facility children are resources.

Example URL

https://[hostname]/krb/rpc/json/servicesManager/getDataWithGroups

Example params

{ "service" : 22 , "facility" : 50 }

Example response

{ ... TODO ... }

Generates the list of attributes per each member associated with the resources and groups in vos. Facility is in the root, facility children are vos. Vo first child is abstract structure which children are resources. Resource first child is abstract structure which children are groups. Resource second chi is abstract structure which children are members. Group first child is abstract structure which children are groups. Group second chi is abstract structure which children are members.

Parameter nameData typeDescription
serviceattributesrequired by this service you will get
facilityyouwill get attributes for this facility, vos associated with this facility by resources, resources associated with it and members assigned to the resources
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
attributesin special structure.

Example URL

https://[hostname]/krb/rpc/json/servicesManager/getDataWithVos

Example params

{ "service" : {...} , "facility" : {...} }

Example response

{ ... TODO ... }

Returns a destination by its id.

Parameter nameData typeDescription
idintDestination 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
DestinationFound Destination

Example URL

https://[hostname]/krb/rpc/json/servicesManager/getDestinationById

Example params

{ "id" : 73 }

Example response

{ "id" : 99 , "destination" : "host@host.cz" , "type" : "HOST" , "propagationType" : "PARALLEL" }

Returns list of all destinations defined for the service and facility.

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<Destination>Found Destinations

Example URL

https://[hostname]/krb/rpc/json/servicesManager/getDestinations

Example params

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

Example response

[ { "id" : 99 , "destination" : "host@host.cz" , "type" : "HOST" , "propagationType" : "PARALLEL" } , {...} , {...} ]

Get list of all destinations.

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<Destination>List of all destinations for session

Example URL

https://[hostname]/krb/rpc/json/servicesManager/getDestinations

Example response

[ { "id" : 99 , "destination" : "host@host.cz" , "type" : "HOST" , "propagationType" : "PARALLEL" } , {...} , {...} ]

Gets count of all destinations.

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
intdestinations count

Example URL

https://[hostname]/krb/rpc/json/servicesManager/getDestinationsCount

Example response

58

List all destinations for all facilities which are joined by resources to the VO.

Parameter nameData typeDescription
vointVO 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<Destination>Found destinations

Example URL

https://[hostname]/krb/rpc/json/servicesManager/getFacilitiesDestinations

Example params

{ "vo" : 5 }

Example response

[ { "id" : 99 , "destination" : "host@host.cz" , "type" : "HOST" , "propagationType" : "PARALLEL" } , {...} , {...} ]

Return list of ServiceForGUI assigned on facility, (Service with "allowedOnFacility" property filled). 1 - allowed / 0 - service is service is denied.

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<ServiceForGUI>list of assigned services with allowed property

Example URL

https://[hostname]/krb/rpc/json/servicesManager/getFacilityAssignedServicesForGUI

Example params

{ "facility" : 0 }

Example response

{ ... TODO ... }

Generates the list of attributes per each user and per each resource. Never return member or member-resource attribute.

Parameter nameData typeDescription
serviceintService id. You will get attributes required by this service
facilityintFacility id. You will get attributes for this facility, resources associated with it and members assigned to the resources
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
ServiceAttributesAttributes in special structure. The facility is in the root. Facility first children is abstract node which contains no attributes and it's children are all resources. Facility second child is abstract node with no attribute and it's children are all users.

Example URL

https://[hostname]/krb/rpc/json/servicesManager/getFlatData

Example params

{ "service" : 76 , "facility" : 23 }

Example response

{ ... TODO ... }

Generates hashed data with group structure for given service and resource. Generates data in format: attributes: {...hashes...} hierarchy: { "1": { ** facility id ** members: { ** all members on the facility ** "4" : 5, ** member id : user id ** "6" : 7, ** member id : user id ** ... } children: [ "2": { ** resource id ** voId: 99, children: [ "89": { ** group id ** "children": {}, "members": { "91328": 57986, "91330": 60838 } } ], "members": { ** all members on the resource with id 2 ** "91328": 57986, "91330": 60838 } }, "3": { ... } ] } }

Parameter nameData typeDescription
serviceIntegerservice
facilityIntegerfacility
consentEvalBooleanif the generator should enforce evaluation of consents
Thrown exceptionDescription
FacilityNotExistsExceptionif there is no such facility
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.
PrivilegeExceptioninsufficient permissions
RpcExceptionWrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation.
ServiceNotExistsExceptionif there is no such service
Return typeDescription
HashedGenDatagenerated hashed data structure

Example URL

https://[hostname]/krb/rpc/json/servicesManager/getHashedDataWithGroups

Example params

{ "service" : {...} , "facility" : {...} , "consentEval" : {...} }

Example response

{ ... TODO ... }

Generates hashed data with group structure for given service and resource. Generates data in format: attributes: {...hashes...} hierarchy: { "1": { ** facility id ** members: { ** all members on the facility ** "4" : 5, ** member id : user id ** "6" : 7, ** member id : user id ** ... } children: [ "2": { ** resource id ** voId: 99, children: [ "89": { ** group id ** "children": {}, "members": { "91328": 57986, "91330": 60838 } } ], "members": { ** all members on the resource with id 2 ** "91328": 57986, "91330": 60838 } }, "3": { ... } ] } }

Parameter nameData typeDescription
serviceIntegerservice
facilityIntegerfacility
Thrown exceptionDescription
FacilityNotExistsExceptionif there is no such facility
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.
PrivilegeExceptioninsufficient permissions
RpcExceptionWrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation.
ServiceNotExistsExceptionif there is no such service
Return typeDescription
HashedGenDatagenerated hashed data structure

Example URL

https://[hostname]/krb/rpc/json/servicesManager/getHashedDataWithGroups

Example params

{ "service" : {...} , "facility" : {...} }

Example response

{ ... TODO ... }

Generates hashed hierarchical data structure for given service and facility. If enforcing consents is turned on on the instance and on the resource's consent hub, generates only the users that granted a consent to all the service required attributes. New UNSIGNED consents are created to users that don't have a consent containing all the service required attributes. attributes: {...hashes...} hierarchy: { "1": { ** facility id ** members: { ** all members on the facility ** "4" : 5, ** member id : user id ** "6" : 7, ** member id : user id ** ... } children: [ "2": { ** resource id ** children: [], voId: 99, members: { ** all members on the resource with id 2 ** "4" : 5 ** member id : user id ** } }, "3": { ... } ] } }

Parameter nameData typeDescription
serviceIntegerservice
facilityIntegerfacility
consentEvalBooleanif the generator should enforce evaluation of consents
Thrown exceptionDescription
FacilityNotExistsExceptionif there is no such facility
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.
PrivilegeExceptioninsufficient permissions
RpcExceptionWrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation.
ServiceNotExistsExceptionif there is no such service
Return typeDescription
HashedGenDatagenerated hashed data structure

Example URL

https://[hostname]/krb/rpc/json/servicesManager/getHashedHierarchicalData

Example params

{ "service" : {...} , "facility" : {...} , "consentEval" : {...} }

Example response

{ ... TODO ... }

Generates hashed hierarchical data structure for given service and facility. If enforcing consents is turned on on the instance and on the resource's consent hub, generates only the users that granted a consent to all the service required attributes. New UNSIGNED consents are created to users that don't have a consent containing all the service required attributes. attributes: {...hashes...} hierarchy: { "1": { ** facility id ** members: { ** all members on the facility ** "4" : 5, ** member id : user id ** "6" : 7, ** member id : user id ** ... } children: [ "2": { ** resource id ** children: [], voId: 99, members: { ** all members on the resource with id 2 ** "4" : 5 ** member id : user id ** } }, "3": { ... } ] } }

Parameter nameData typeDescription
serviceIntegerservice
facilityIntegerfacility
Thrown exceptionDescription
FacilityNotExistsExceptionif there is no such facility
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.
PrivilegeExceptioninsufficient permissions
RpcExceptionWrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation.
ServiceNotExistsExceptionif there is no such service
Return typeDescription
HashedGenDatagenerated hashed data structure

Example URL

https://[hostname]/krb/rpc/json/servicesManager/getHashedHierarchicalData

Example params

{ "service" : {...} , "facility" : {...} }

Example response

{ ... TODO ... }

Generates the list of attributes per each member associated with the resource.

Parameter nameData typeDescription
serviceintService id
facilityintFacility id. You will get attributes for this facility, resources associated with it and members assigned to the resources.
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<ServiceAttributes>Attributes in special structure. Facility is in the root, facility children are resources. And resource children are members.

Example URL

https://[hostname]/krb/rpc/json/servicesManager/getHierarchicalData

Example params

{ "service" : 68 , "facility" : 88 }

Example response

{ ... TODO ... }

Returns list of all rich destinations defined for the service and facility.

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<RichDestination>Found RichDestination

Example URL

https://[hostname]/krb/rpc/json/servicesManager/getRichDestinations

Example params

{ "service" : 11 , "facility" : 67 }

Example response

[ { "id" : 99 , "destination" : "host@host.cz" , "type" : "HOST" , "propagationType" : "PARALLEL" , "service" : { "id" : 290 , "name" : "passwd" , "description" : "Provision /etc/passwd file." , "delay" : 10 , "recurrence" : 2 , "enabled" : true , "script" : "./passwd" , "useExpiredMembers" : false } , "facility" : { "id" : 24 , "name" : "host.facility.cz" , "description" : "is optional" , "beanName" : "Facility" } } , {...} , {...} ]

Returns a service by its id.

Parameter nameData typeDescription
idintService 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
ServiceFound Service

Example URL

https://[hostname]/krb/rpc/json/servicesManager/getServiceById

Example params

{ "id" : 70 }

Example response

{ "id" : 290 , "name" : "passwd" , "description" : "Provision /etc/passwd file." , "delay" : 10 , "recurrence" : 2 , "enabled" : true , "script" : "./passwd" , "useExpiredMembers" : false }

Returns a service by its name.

Parameter nameData typeDescription
nameStringService 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
ServiceFound Service

Example URL

https://[hostname]/krb/rpc/json/servicesManager/getServiceByName

Example params

{ "name" : "text" }

Example response

{ "id" : 290 , "name" : "passwd" , "description" : "Provision /etc/passwd file." , "delay" : 10 , "recurrence" : 2 , "enabled" : true , "script" : "./passwd" , "useExpiredMembers" : false }

Returns all services.

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<Service>All services

Example URL

https://[hostname]/krb/rpc/json/servicesManager/getServices

Example response

[ { "id" : 290 , "name" : "passwd" , "description" : "Provision /etc/passwd file." , "delay" : 10 , "recurrence" : 2 , "enabled" : true , "script" : "./passwd" , "useExpiredMembers" : false } , {...} , {...} ]

Returns list of denials for a destination.

Parameter nameData typeDescription
destinationintDestination 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<Service>Services

Example URL

https://[hostname]/krb/rpc/json/servicesManager/getServicesBlockedOnDestination

Example params

{ "destination" : 8 }

Example response

[ { "id" : 290 , "name" : "passwd" , "description" : "Provision /etc/passwd file." , "delay" : 10 , "recurrence" : 2 , "enabled" : true , "script" : "./passwd" , "useExpiredMembers" : false } , {...} , {...} ]

Returns list of denials for 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<Service>Services

Example URL

https://[hostname]/krb/rpc/json/servicesManager/getServicesBlockedOnFacility

Example params

{ "facility" : 85 }

Example response

[ { "id" : 290 , "name" : "passwd" , "description" : "Provision /etc/passwd file." , "delay" : 10 , "recurrence" : 2 , "enabled" : true , "script" : "./passwd" , "useExpiredMembers" : false } , {...} , {...} ]

Get all services with given attribute.

Parameter nameData typeDescription
attributeDefinitionintattributeDefinition 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
allservices with given attribute

Example URL

https://[hostname]/krb/rpc/json/servicesManager/getServicesByAttributeDefinition

Example params

{ "attributeDefinition" : 83 }

Example response

{ ... TODO ... }

Lists services stored in a package.

Parameter nameData typeDescription
servicesPackageintServicesPackage 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<Service>List of services

Example URL

https://[hostname]/krb/rpc/json/servicesManager/getServicesFromServicesPackage

Example params

{ "servicesPackage" : 49 }

Example response

[ { "id" : 290 , "name" : "passwd" , "description" : "Provision /etc/passwd file." , "delay" : 10 , "recurrence" : 2 , "enabled" : true , "script" : "./passwd" , "useExpiredMembers" : false } , {...} , {...} ]

Gets package by id.

Parameter nameData typeDescription
servicesPackageIdintServicesPackage 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
ServicesPackageFound ServicesPackage

Example URL

https://[hostname]/krb/rpc/json/servicesManager/getServicesPackageById

Example params

{ "servicesPackageId" : 70 }

Example response

{ "id" : 50 , "name" : "Unix account" , "description" : "Collection of services for managing unix accounts." }

Gets package by name.

Parameter nameData typeDescription
nameStringServicesPackage 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
ServicesPackageFound ServicesPackage

Example URL

https://[hostname]/krb/rpc/json/servicesManager/getServicesPackageByName

Example params

{ "name" : "text" }

Example response

{ "id" : 50 , "name" : "Unix account" , "description" : "Collection of services for managing unix accounts." }

Returns packages.

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<ServicesPackage>Packages.

Example URL

https://[hostname]/krb/rpc/json/servicesManager/getServicesPackages

Example response

[ { "id" : 50 , "name" : "Unix account" , "description" : "Collection of services for managing unix accounts." } , {...} , {...} ]

Is this Service denied on the destination?

Parameter nameData typeDescription
serviceintService id
destinationintDestination 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
int1 = true - the Service is denied on the destination, 0 = false - the Service is NOT denied on the destination

Example URL

https://[hostname]/krb/rpc/json/servicesManager/isServiceBlockedOnDestination

Example params

{ "service" : 12 , "destination" : 74 }

Example response

1

Is this Service denied on the facility?

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
int1 = true - the Service is denied on the facility, 0 = false - the Service is NOT denied on the facility

Example URL

https://[hostname]/krb/rpc/json/servicesManager/isServiceBlockedOnFacility

Example params

{ "service" : 95 , "facility" : 90 }

Example response

1

Plans service propagation on defined facility.

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
int1 = true if it is possible, 0 = false if not

Example URL

https://[hostname]/krb/rpc/json/servicesManager/planServicePropagation

Example params

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

Example response

78

Plans service propagation on defined facility.

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
int1 = true if it is possible, 0 = false if not

Example URL

https://[hostname]/krb/rpc/json/servicesManager/planServicePropagation

Example params

{ "service" : 67 }

Example response

53

Removes all destinations from a facility and service.

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
void

Example URL

https://[hostname]/krb/rpc/json/servicesManager/removeAllDestinations

Example params

{ "service" : 45 , "facility" : 73 }

Example response

null

Remove all required attributes from service.

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
void

Example URL

https://[hostname]/krb/rpc/json/servicesManager/removeAllRequiredAttributes

Example params

{ "service" : 72 }

Example response

null

Removes an destination from a facility and service.

Parameter nameData typeDescription
serviceintService id
facilityintFacility id
destinationStringDestination
typeStringType
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/servicesManager/removeDestination

Example params

{ "service" : 64 , "facility" : 19 , "destination" : "text" , "type" : "text" }

Example response

null

Remove required attribute from service.

Parameter nameData typeDescription
serviceintService id
attributeintAttribute 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/servicesManager/removeRequiredAttribute

Example params

{ "service" : 51 , "attribute" : 8 }

Example response

null

Remove required attributes from service.

Parameter nameData typeDescription
serviceintService id
attributesint[]Attribute 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
void

Example URL

https://[hostname]/krb/rpc/json/servicesManager/removeRequiredAttributes

Example params

{ "service" : 71 , "attributes" : [ 58 , 90 ] }

Example response

null

Removes a Service from a Services Package.

Parameter nameData typeDescription
servicesPackageintServices package id from which the service supposed to be removed
serviceintService id that will be removed from the services package
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/servicesManager/removeServiceFromServicesPackage

Example params

{ "servicesPackage" : 19 , "service" : 73 }

Example response

null

Erase all the possible denials on this destination.

Parameter nameData typeDescription
destinationintDestination 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/servicesManager/unblockAllServicesOnDestination

Example params

{ "destination" : 39 }

Example response

null

Erase all the possible denials on this destination.

Parameter nameData typeDescription
destinationNameStringDestination name (like hostnames)
destinationTypeStringDestination type (like host, user@host, user@host:port, email, service-specific, ...)
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/servicesManager/unblockAllServicesOnDestination

Example params

{ "destinationName" : "text" , "destinationType" : "text" }

Example response

null

Erase all the possible denials on 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
void

Example URL

https://[hostname]/krb/rpc/json/servicesManager/unblockAllServicesOnFacility

Example params

{ "facility" : 23 }

Example response

null

Free the denial of the Service on this destination. If the Service was banned on this destination, it will be freed. In case the Service was not banned on this destination, nothing will happen.

Parameter nameData typeDescription
serviceintService id
destinationintDestination 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/servicesManager/unblockServiceOnDestination

Example params

{ "service" : 27 , "destination" : 16 }

Example response

null

Free the denial of the Service on this destination. If the Service was banned on this destination, it will be freed. In case the Service was not banned on this destination, nothing will happen.

Parameter nameData typeDescription
serviceintService id
destinationNameStringDestination name (like hostnames)
destinationTypeStringDestination type (like host, user@host, user@host:port, email, service-specific, ...)
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/servicesManager/unblockServiceOnDestination

Example params

{ "service" : 54 , "destinationName" : "text" , "destinationType" : "text" }

Example response

null

Free the denial of the Service on this facility. If the Service was banned on this facility, it will be freed. In case the Service was not banned on this facility, nothing will happen.

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
void

Example URL

https://[hostname]/krb/rpc/json/servicesManager/unblockServiceOnFacility

Example params

{ "service" : 96 , "facility" : 82 }

Example response

null

Updates a service.

Parameter nameData typeDescription
serviceServiceJSON 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
void

Example URL

https://[hostname]/krb/rpc/json/servicesManager/updateService

Example params

{ "service" : { "id" : 290 , "name" : "passwd" , "description" : "Provision /etc/passwd file." , "delay" : 10 , "recurrence" : 2 , "enabled" : true , "script" : "./passwd" , "useExpiredMembers" : false } }

Example response

null

Updates a service package.

Parameter nameData typeDescription
servicesPackageServicesPackageJSON 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
void

Example URL

https://[hostname]/krb/rpc/json/servicesManager/updateServicesPackage

Example params

{ "servicesPackage" : { "id" : 50 , "name" : "Unix account" , "description" : "Collection of services for managing unix accounts." } }

Example response

null