RPC API documentation v45.0.0

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

Example URL

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

• see URL structure

Example params

{ "service" : 12 , "facility" : 20 , "destination" : "text" , "type" : "text" }

• see Passing params

Example response

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

• see Return values
• see HTTP return codes

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

Example URL

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

• see URL structure

Example params

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

• see Passing params

Example response

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

• see Return values
• see HTTP return codes

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

Example URL

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

• see URL structure

Example params

{ "service" : 6 , "facility" : 30 , "destination" : "text" , "type" : "text" , "propagationType" : "text" }

• see Passing params

Example response

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

• see Return values
• see HTTP return codes

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

Example URL

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

• see URL structure

Example params

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

• see Passing params

Example response

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

• see Return values
• see HTTP return codes

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.

Example URL

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

• see URL structure

Example params

{ "service" : 70 , "facility" : 14 }

• see Passing params

Example response

{ ... TODO ... }

• see Return values
• see HTTP return codes

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

Example URL

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

• see URL structure

Example params

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

• see Passing params

Example response

{ ... TODO ... }

• see Return values
• see HTTP return codes

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

Example URL

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

• see URL structure

Example params

{ "facility" : 34 }

• see Passing params

Example response

{ ... TODO ... }

• see Return values
• see HTTP return codes

Adds destination for all services defined on the facility.

Example URL

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

• see URL structure

Example params

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

• see Passing params

Example response

{ ... TODO ... }

• see Return values
• see HTTP return codes

Adds destination for all services defined on the facility.

Example URL

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

• see URL structure

Example params

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

• see Passing params

Example response

{ ... TODO ... }

• see Return values
• see HTTP return codes

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.

Example URL

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

• see URL structure

Example params

{ "service" : 12 , "attribute" : 2 }

• see Passing params

Example response

null

• see Return values
• see HTTP return codes

Batch version of addRequiredAttribute.

Example URL

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

• see URL structure

Example params

{ "service" : 98 , "attributes" : [ 93 , 43 ] }

• see Passing params

Example response

null

• see Return values
• see HTTP return codes

Adds a Service to a Services Package.

Example URL

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

• see URL structure

Example params

{ "servicesPackage" : 64 , "service" : 35 }

• see Passing params

Example response

null

• see Return values
• see HTTP return codes

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

Example URL

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

• see URL structure

Example params

{ "destination" : 91 }

• see Passing params

Example response

null

• see Return values
• see HTTP return codes

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

Example URL

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

• see URL structure

Example params

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

• see Passing params

Example response

null

• see Return values
• see HTTP return codes

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

Example URL

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

• see URL structure

Example params

{ "facility" : 1 }

• see Passing params

Example response

null

• see Return values
• see HTTP return codes

Bans Service on a destination.

Example URL

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

• see URL structure

Example params

{ "service" : 86 , "destination" : 93 }

• see Passing params

Example response

null

• see Return values
• see HTTP return codes

Bans Service on a destination.

Example URL

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

• see URL structure

Example params

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

• see Passing params

Example response

null

• see Return values
• see HTTP return codes

Bans service on a facility.

Example URL

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

• see URL structure

Example params

{ "service" : 8 , "facility" : 63 }

• see Passing params

Example response

null

• see Return values
• see HTTP return codes

Bans the Service on the destination - each pair defined by the rich destination. It wouldn't be possible to execute the given Service on this destination, however, it still can be executed on all the other destinations in the facility.

Example URL

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

• see URL structure

Example params

{ "service" : 90 , "richDestinations" : [ { "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 , "useExpiredVoMembers" : false } , "facility" : { "id" : 24 , "name" : "host.facility.cz" , "description" : "is optional" , "beanName" : "Facility" } } , {...} , {...} ] }

• see Passing params

Example response

null

• see Return values
• see HTTP return codes

Bans services on a facility.

Example URL

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

• see URL structure

Example params

{ "services" : [ 2 , 18 ] , "facility" : 19 }

• see Passing params

Example response

null

• see Return values
• see HTTP return codes

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

Example URL

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

• see URL structure

Example params

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

• see Passing params

Example response

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

• see Return values
• see HTTP return codes

Creates a new service.

Example URL

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

• see URL structure

Example params

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

• see Passing params

Example response

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

• see Return values
• see HTTP return codes

Creates a new services package.

Example URL

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

• see URL structure

Example params

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

• see Passing params

Example response

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

• see Return values
• see HTTP return codes

Creates a new services package.

Example URL

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

• see URL structure

Example params

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

• see Passing params

Example response

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

• see Return values
• see HTTP return codes

Deletes a service.

Example URL

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

• see URL structure

Example params

{ "service" : 2 }

• see Passing params

Example response

null

• see Return values
• see HTTP return codes

Deletes a service.

Example URL

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

• see URL structure

Example params

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

• see Passing params

Example response

null

• see Return values
• see HTTP return codes

Deletes given services.

Example URL

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

• see URL structure

Example params

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

• see Passing params

Example response

null

• see Return values
• see HTTP return codes

Deletes given services.

Example URL

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

• see URL structure

Example params

{ "services" : [ 67 , 94 ] , "force" : true }

• see Passing params

Example response

null

• see Return values
• see HTTP return codes

Deletes a services package.

Example URL

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

• see URL structure

Example params

{ "servicesPackage" : 19 }

• see Passing params

Example response

null

• see Return values
• see HTTP return codes

Forces service propagation on defined facility.

Example URL

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

• see URL structure

Example params

{ "service" : 64 , "facility" : 80 }

• see Passing params

Example response

6

• see Return values
• see HTTP return codes

Forces service propagation for defined service on all facilities.

Example URL

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

• see URL structure

Example params

{ "service" : 54 }

• see Passing params

Example response

42

• see Return values
• see HTTP return codes

Forces services propagation on defined facility.

Example URL

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

• see URL structure

Example params

{ "facility" : 89 , "services" : [ 0 , 25 ] }

• see Passing params

Example response

null

• see Return values
• see HTTP return codes

Forces services propagation on all facilities where the services are defined on.

Example URL

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

• see URL structure

Example params

{ "services" : [ 56 , 21 ] }

• see Passing params

Example response

null

• see Return values
• see HTTP return codes

Forces services propagation on all facilities for all services where hostname is used. Service must be correctly assigned, have destination matching hostname and not be blocked on any level (globally, facility, destination).

Example URL

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

• see URL structure

Example params

{ "hostname" : "text" }

• see Passing params

Example response

"text"

• see Return values
• see HTTP return codes

Returns all rich destinations defined for a facility.

Example URL

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

• see URL structure

Example params

{ "facility" : 48 }

• see Passing params

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 , "useExpiredVoMembers" : false } , "facility" : { "id" : 24 , "name" : "host.facility.cz" , "description" : "is optional" , "beanName" : "Facility" } } , {...} , {...} ]

• see Return values
• see HTTP return codes

Returns all rich destinations defined for a service.

Example URL

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

• see URL structure

Example params

{ "service" : 34 }

• see Passing params

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 , "useExpiredVoMembers" : false } , "facility" : { "id" : 24 , "name" : "host.facility.cz" , "description" : "is optional" , "beanName" : "Facility" } } , {...} , {...} ]

• see Return values
• see HTTP return codes

Lists resources assigned to service.

Example URL

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

• see URL structure

Example params

{ "service" : 78 }

• see Passing params

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

• see Return values
• see HTTP return codes

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

Example URL

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

• see URL structure

Example params

{ "facility" : 22 }

• see Passing params

Example response

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

• see Return values
• see HTTP return codes

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

Example URL

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

• see URL structure

Example params

{ "facility" : 93 , "vo" : 30 }

• see Passing params

Example response

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

• see Return values
• see HTTP return codes

Returns a destination by its id.

Example URL

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

• see URL structure

Example params

{ "id" : 72 }

• see Passing params

Example response

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

• see Return values
• see HTTP return codes

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

Example URL

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

• see URL structure

Example params

{ "service" : 3 , "facility" : 3 }

• see Passing params

Example response

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

• see Return values
• see HTTP return codes

Get list of all destinations.

Example URL

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

• see URL structure

Example response

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

• see Return values
• see HTTP return codes

Gets count of all destinations.

Example URL

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

• see URL structure

Example response

64

• see Return values
• see HTTP return codes

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

Example URL

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

• see URL structure

Example params

{ "vo" : 7 }

• see Passing params

Example response

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

• see Return values
• see HTTP return codes

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

Example URL

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

• see URL structure

Example params

{ "facility" : 92 }

• see Passing params

Example response

{ ... TODO ... }

• see Return values
• see HTTP return codes

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

Example URL

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

• see URL structure

Example params

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

• see Passing params

Example response

{ ... TODO ... }

• see Return values
• see HTTP return codes

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

Example URL

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

• see URL structure

Example params

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

• see Passing params

Example response

{ ... TODO ... }

• see Return values
• see HTTP return codes

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

Example URL

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

• see URL structure

Example params

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

• see Passing params

Example response

{ ... TODO ... }

• see Return values
• see HTTP return codes

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

Example URL

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

• see URL structure

Example params

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

• see Passing params

Example response

{ ... TODO ... }

• see Return values
• see HTTP return codes

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

Example URL

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

• see URL structure

Example params

{ "service" : 93 , "facility" : 9 }

• see Passing params

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 , "useExpiredVoMembers" : false } , "facility" : { "id" : 24 , "name" : "host.facility.cz" , "description" : "is optional" , "beanName" : "Facility" } } , {...} , {...} ]

• see Return values
• see HTTP return codes

Returns a service by its id.

Example URL

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

• see URL structure

Example params

{ "id" : 90 }

• see Passing params

Example response

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

• see Return values
• see HTTP return codes

Returns a service by its name.

Example URL

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

• see URL structure

Example params

{ "name" : "text" }

• see Passing params

Example response

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

• see Return values
• see HTTP return codes

Returns all services.

Example URL

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

• see URL structure

Example response

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

• see Return values
• see HTTP return codes

Returns list of denials for a destination.

Example URL

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

• see URL structure

Example params

{ "destination" : 58 }

• see Passing params

Example response

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

• see Return values
• see HTTP return codes

Returns list of denials for a facility.

Example URL

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

• see URL structure

Example params

{ "facility" : 4 }

• see Passing params

Example response

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

• see Return values
• see HTTP return codes

Get all services with given attribute.

Example URL

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

• see URL structure

Example params

{ "attributeDefinition" : 70 }

• see Passing params

Example response

{ ... TODO ... }

• see Return values
• see HTTP return codes

Lists services stored in a package.

Example URL

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

• see URL structure

Example params

{ "servicesPackage" : 23 }

• see Passing params

Example response

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

• see Return values
• see HTTP return codes

Gets package by id.

Example URL

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

• see URL structure

Example params

{ "servicesPackageId" : 51 }

• see Passing params

Example response

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

• see Return values
• see HTTP return codes

Gets package by name.

Example URL

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

• see URL structure

Example params

{ "name" : "text" }

• see Passing params

Example response

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

• see Return values
• see HTTP return codes

Returns packages.

Example URL

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

• see URL structure

Example response

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

• see Return values
• see HTTP return codes

Is this Service denied on the destination?

Example URL

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

• see URL structure

Example params

{ "service" : 9 , "destination" : 79 }

• see Passing params

Example response

1

• see Return values
• see HTTP return codes

Is this Service denied on the facility?

Example URL

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

• see URL structure

Example params

{ "service" : 14 , "facility" : 39 }

• see Passing params

Example response

1

• see Return values
• see HTTP return codes

Plans service propagation on defined facility.

Example URL

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

• see URL structure

Example params

{ "service" : 1 , "facility" : 43 }

• see Passing params

Example response

54

• see Return values
• see HTTP return codes

Plans service propagation on defined facility.

Example URL

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

• see URL structure

Example params

{ "service" : 60 }

• see Passing params

Example response

83

• see Return values
• see HTTP return codes

Removes all destinations from a facility and service.

Example URL

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

• see URL structure

Example params

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

• see Passing params

Example response

null

• see Return values
• see HTTP return codes

Remove all required attributes from service.

Example URL

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

• see URL structure

Example params

{ "service" : 13 }

• see Passing params

Example response

null

• see Return values
• see HTTP return codes

Removes an destination from a facility and service.

Example URL

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

• see URL structure

Example params

{ "service" : 47 , "facility" : 93 , "destination" : "text" , "type" : "text" }

• see Passing params

Example response

null

• see Return values
• see HTTP return codes

Removes destinations defined by list of rich destinations. Each destination is removed from the rich destination's facility and service.

Example URL

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

• see URL structure

Example params

{ "richDestinations" : [ { "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 , "useExpiredVoMembers" : false } , "facility" : { "id" : 24 , "name" : "host.facility.cz" , "description" : "is optional" , "beanName" : "Facility" } } , {...} , {...} ] }

• see Passing params

Example response

null

• see Return values
• see HTTP return codes

Remove required attribute from service.

Example URL

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

• see URL structure

Example params

{ "service" : 96 , "attribute" : 73 }

• see Passing params

Example response

null

• see Return values
• see HTTP return codes

Remove required attributes from service.

Example URL

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

• see URL structure

Example params

{ "service" : 86 , "attributes" : [ 53 , 47 ] }

• see Passing params

Example response

null

• see Return values
• see HTTP return codes

Removes a Service from a Services Package.

Example URL

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

• see URL structure

Example params

{ "servicesPackage" : 96 , "service" : 71 }

• see Passing params

Example response

null

• see Return values
• see HTTP return codes

Erase all the possible denials on this destination.

Example URL

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

• see URL structure

Example params

{ "destination" : 21 }

• see Passing params

Example response

null

• see Return values
• see HTTP return codes

Erase all the possible denials on this destination.

Example URL

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

• see URL structure

Example params

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

• see Passing params

Example response

null

• see Return values
• see HTTP return codes

Erase all the possible denials on this facility.

Example URL

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

• see URL structure

Example params

{ "facility" : 80 }

• see Passing params

Example response

null

• see Return values
• see HTTP return codes

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.

Example URL

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

• see URL structure

Example params

{ "service" : 49 , "destination" : 13 }

• see Passing params

Example response

null

• see Return values
• see HTTP return codes

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.

Example URL

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

• see URL structure

Example params

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

• see Passing params

Example response

null

• see Return values
• see HTTP return codes

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.

Example URL

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

• see URL structure

Example params

{ "service" : 92 , "facility" : 9 }

• see Passing params

Example response

null

• see Return values
• see HTTP return codes

Free the denial of the Service on the destination - each pair defined by the rich destination. If the Service was banned on the destination, it will be freed. In case the Service was not banned on the destination, nothing will happen.

Example URL

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

• see URL structure

Example params

{ "service" : 24 , "richDestinations" : [ { "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 , "useExpiredVoMembers" : false } , "facility" : { "id" : 24 , "name" : "host.facility.cz" , "description" : "is optional" , "beanName" : "Facility" } } , {...} , {...} ] }

• see Passing params

Example response

null

• see Return values
• see HTTP return codes

Free the denial of the Service on this facility.

Example URL

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

• see URL structure

Example params

{ "services" : [ 88 , 27 ] , "facility" : 57 }

• see Passing params

Example response

null

• see Return values
• see HTTP return codes

Updates a service.

Example URL

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

• see URL structure

Example params

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

• see Passing params

Example response

null

• see Return values
• see HTTP return codes

Updates a service package.

Example URL

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

• see URL structure

Example params

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

• see Passing params

Example response

null

• see Return values
• see HTTP return codes