RPC API documentation v34.4.0

Returns consent with changed status.

Example URL

https://[hostname]/krb/rpc/json/consentsManager/changeConsentStatus

• see URL structure

Example params

{ "consent" : 10 , "status" : "text" }

• see Passing params

Example response

{ "id" : 1 , "userId" : 1 , "status" : "UNSIGNED" , "consentHub" : { "id" : 10 , "name" : "Test Consent Hub" , "enforceConsents" : false , "facilities" : [ { "id" : 24 , "name" : "host.facility.cz" , "description" : "is optional" , "beanName" : "Facility" } , {...} , {...} ] , "beanName" : "ConsentHub" } , "attributes" :  [ { "id" : 2820 , "friendlyName" : "createdAt" , "namespace" : "urn:perun:vo:attribute-def:core" , "type" : "java.lang.String" , "entity" : "vo" , "writable" : true , "baseFriendlyName" : "createdAt" , "friendlyNameParameter" : "" , "unique" : false , "displayName" : "VO created date" , "description" : "Date when VO was created." , "beanName" : "AttributeDefinition" } , {...} , {...} ] , "beanName" : "Consent" }

• see Return values
• see HTTP return codes

Evaluates consents for given consent hub.

Example URL

https://[hostname]/krb/rpc/json/consentsManager/evaluateConsentsForConsentHub

• see URL structure

Example params

{ "consentHub" : { "id" : 1 , "userId" : 1 , "status" : "UNSIGNED" , "consentHub" : { "id" : 10 , "name" : "Test Consent Hub" , "enforceConsents" : false , "facilities" : [ { "id" : 24 , "name" : "host.facility.cz" , "description" : "is optional" , "beanName" : "Facility" } , {...} , {...} ] , "beanName" : "ConsentHub" } , "attributes" :  [ { "id" : 2820 , "friendlyName" : "createdAt" , "namespace" : "urn:perun:vo:attribute-def:core" , "type" : "java.lang.String" , "entity" : "vo" , "writable" : true , "baseFriendlyName" : "createdAt" , "friendlyNameParameter" : "" , "unique" : false , "displayName" : "VO created date" , "description" : "Date when VO was created." , "beanName" : "AttributeDefinition" } , {...} , {...} ] , "beanName" : "Consent" } }

• see Passing params

Example response

null

• see Return values
• see HTTP return codes

Evaluates consents for given consent hubs.

Example URL

https://[hostname]/krb/rpc/json/consentsManager/evaluateConsentsForConsentHubs

• see URL structure

Example params

{ "consentHubs" : [ 81 , 81 ] }

• see Passing params

Example response

null

• see Return values
• see HTTP return codes

Corresponding consent hubs (containing the service) will have consents evaluated ONLY for selected service. Service defines whether only active users will be evaluated or expired ones as well.

Example URL

https://[hostname]/krb/rpc/json/consentsManager/evaluateConsentsForService

• see URL structure

Example params

{ "service" : {...} }

• see Passing params

Example response

null

• see Return values
• see HTTP return codes

Return list of all Consent Hubs.

Example URL

https://[hostname]/krb/rpc/json/consentsManager/getAllConsentHubs

• see URL structure

Example response

[ { "id" : 10 , "name" : "Test Consent Hub" , "enforceConsents" : false , "facilities" : [ { "id" : 24 , "name" : "host.facility.cz" , "description" : "is optional" , "beanName" : "Facility" } , {...} , {...} ] , "beanName" : "ConsentHub" } , {...} , {...} ]

• see Return values
• see HTTP return codes

Returns all existing Consents

Example URL

https://[hostname]/krb/rpc/json/consentsManager/getAllConsents

• see URL structure

Example response

[ { "id" : 1 , "userId" : 1 , "status" : "UNSIGNED" , "consentHub" : { "id" : 10 , "name" : "Test Consent Hub" , "enforceConsents" : false , "facilities" : [ { "id" : 24 , "name" : "host.facility.cz" , "description" : "is optional" , "beanName" : "Facility" } , {...} , {...} ] , "beanName" : "ConsentHub" } , "attributes" :  [ { "id" : 2820 , "friendlyName" : "createdAt" , "namespace" : "urn:perun:vo:attribute-def:core" , "type" : "java.lang.String" , "entity" : "vo" , "writable" : true , "baseFriendlyName" : "createdAt" , "friendlyNameParameter" : "" , "unique" : false , "displayName" : "VO created date" , "description" : "Date when VO was created." , "beanName" : "AttributeDefinition" } , {...} , {...} ] , "beanName" : "Consent" } , {...} , {...} ]

• see Return values
• see HTTP return codes

Returns Consent with the corresponding id

Example URL

https://[hostname]/krb/rpc/json/consentsManager/getConsentById

• see URL structure

Example params

{ "id" : 25 }

• see Passing params

Example response

[ { "id" : 1 , "userId" : 1 , "status" : "UNSIGNED" , "consentHub" : { "id" : 10 , "name" : "Test Consent Hub" , "enforceConsents" : false , "facilities" : [ { "id" : 24 , "name" : "host.facility.cz" , "description" : "is optional" , "beanName" : "Facility" } , {...} , {...} ] , "beanName" : "ConsentHub" } , "attributes" :  [ { "id" : 2820 , "friendlyName" : "createdAt" , "namespace" : "urn:perun:vo:attribute-def:core" , "type" : "java.lang.String" , "entity" : "vo" , "writable" : true , "baseFriendlyName" : "createdAt" , "friendlyNameParameter" : "" , "unique" : false , "displayName" : "VO created date" , "description" : "Date when VO was created." , "beanName" : "AttributeDefinition" } , {...} , {...} ] , "beanName" : "Consent" } , {...} , {...} ]

• see Return values
• see HTTP return codes

Returns consent for a user in consent hub with specified status

Example URL

https://[hostname]/krb/rpc/json/consentsManager/getConsentForUserAndConsentHub

• see URL structure

Example params

{ "user" : 37 , "consentHub" : 18 , "status" : "text" }

• see Passing params

Example response

{ "id" : 1 , "userId" : 1 , "status" : "UNSIGNED" , "consentHub" : { "id" : 10 , "name" : "Test Consent Hub" , "enforceConsents" : false , "facilities" : [ { "id" : 24 , "name" : "host.facility.cz" , "description" : "is optional" , "beanName" : "Facility" } , {...} , {...} ] , "beanName" : "ConsentHub" } , "attributes" :  [ { "id" : 2820 , "friendlyName" : "createdAt" , "namespace" : "urn:perun:vo:attribute-def:core" , "type" : "java.lang.String" , "entity" : "vo" , "writable" : true , "baseFriendlyName" : "createdAt" , "friendlyNameParameter" : "" , "unique" : false , "displayName" : "VO created date" , "description" : "Date when VO was created." , "beanName" : "AttributeDefinition" } , {...} , {...} ] , "beanName" : "Consent" }

• see Return values
• see HTTP return codes

Returns a Consent Hub by facility id.

Example URL

https://[hostname]/krb/rpc/json/consentsManager/getConsentHubByFacility

• see URL structure

Example params

{ "facilityId" : {...} }

• see Passing params

Example response

{ "id" : 10 , "name" : "Test Consent Hub" , "enforceConsents" : false , "facilities" : [ { "id" : 24 , "name" : "host.facility.cz" , "description" : "is optional" , "beanName" : "Facility" } , {...} , {...} ] , "beanName" : "ConsentHub" }

• see Return values
• see HTTP return codes

Returns a Consent Hub by its id.

Example URL

https://[hostname]/krb/rpc/json/consentsManager/getConsentHubById

• see URL structure

Example params

{ "id" : 20 }

• see Passing params

Example response

{ "id" : 10 , "name" : "Test Consent Hub" , "enforceConsents" : false , "facilities" : [ { "id" : 24 , "name" : "host.facility.cz" , "description" : "is optional" , "beanName" : "Facility" } , {...} , {...} ] , "beanName" : "ConsentHub" }

• see Return values
• see HTTP return codes

Returns a Consent Hub by its name.

Example URL

https://[hostname]/krb/rpc/json/consentsManager/getConsentHubByName

• see URL structure

Example params

{ "name" : "text" }

• see Passing params

Example response

{ "id" : 10 , "name" : "Test Consent Hub" , "enforceConsents" : false , "facilities" : [ { "id" : 24 , "name" : "host.facility.cz" , "description" : "is optional" , "beanName" : "Facility" } , {...} , {...} ] , "beanName" : "ConsentHub" }

• see Return values
• see HTTP return codes

Returns a Consent Hub for facility to which resource belongs.

Example URL

https://[hostname]/krb/rpc/json/consentsManager/getConsentHubByResource

• see URL structure

Example params

{ "resourceId" : {...} }

• see Passing params

Example response

{ "id" : 10 , "name" : "Test Consent Hub" , "enforceConsents" : false , "facilities" : [ { "id" : 24 , "name" : "host.facility.cz" , "description" : "is optional" , "beanName" : "Facility" } , {...} , {...} ] , "beanName" : "ConsentHub" }

• see Return values
• see HTTP return codes

Returns all consents for a ConsentHub

Example URL

https://[hostname]/krb/rpc/json/consentsManager/getConsentsForConsentHub

• see URL structure

Example params

{ "consentHub" : 67 }

• see Passing params

Example response

[ { "id" : 1 , "userId" : 1 , "status" : "UNSIGNED" , "consentHub" : { "id" : 10 , "name" : "Test Consent Hub" , "enforceConsents" : false , "facilities" : [ { "id" : 24 , "name" : "host.facility.cz" , "description" : "is optional" , "beanName" : "Facility" } , {...} , {...} ] , "beanName" : "ConsentHub" } , "attributes" :  [ { "id" : 2820 , "friendlyName" : "createdAt" , "namespace" : "urn:perun:vo:attribute-def:core" , "type" : "java.lang.String" , "entity" : "vo" , "writable" : true , "baseFriendlyName" : "createdAt" , "friendlyNameParameter" : "" , "unique" : false , "displayName" : "VO created date" , "description" : "Date when VO was created." , "beanName" : "AttributeDefinition" } , {...} , {...} ] , "beanName" : "Consent" } , {...} , {...} ]

• see Return values
• see HTTP return codes

Returns all consents with a specific status for a ConsentHub.

Example URL

https://[hostname]/krb/rpc/json/consentsManager/getConsentsForConsentHub

• see URL structure

Example params

{ "consentHub" : 85 , "status" : "text" }

• see Passing params

Example response

[ { "id" : 1 , "userId" : 1 , "status" : "UNSIGNED" , "consentHub" : { "id" : 10 , "name" : "Test Consent Hub" , "enforceConsents" : false , "facilities" : [ { "id" : 24 , "name" : "host.facility.cz" , "description" : "is optional" , "beanName" : "Facility" } , {...} , {...} ] , "beanName" : "ConsentHub" } , "attributes" :  [ { "id" : 2820 , "friendlyName" : "createdAt" , "namespace" : "urn:perun:vo:attribute-def:core" , "type" : "java.lang.String" , "entity" : "vo" , "writable" : true , "baseFriendlyName" : "createdAt" , "friendlyNameParameter" : "" , "unique" : false , "displayName" : "VO created date" , "description" : "Date when VO was created." , "beanName" : "AttributeDefinition" } , {...} , {...} ] , "beanName" : "Consent" } , {...} , {...} ]

• see Return values
• see HTTP return codes

Returns consents for members assigned to the chosen resource.

Example URL

https://[hostname]/krb/rpc/json/consentsManager/getConsentsForConsentHubByResource

• see URL structure

Example params

{ "resource" : 78 }

• see Passing params

Example response

[ { "id" : 1 , "userId" : 1 , "status" : "UNSIGNED" , "consentHub" : { "id" : 10 , "name" : "Test Consent Hub" , "enforceConsents" : false , "facilities" : [ { "id" : 24 , "name" : "host.facility.cz" , "description" : "is optional" , "beanName" : "Facility" } , {...} , {...} ] , "beanName" : "ConsentHub" } , "attributes" :  [ { "id" : 2820 , "friendlyName" : "createdAt" , "namespace" : "urn:perun:vo:attribute-def:core" , "type" : "java.lang.String" , "entity" : "vo" , "writable" : true , "baseFriendlyName" : "createdAt" , "friendlyNameParameter" : "" , "unique" : false , "displayName" : "VO created date" , "description" : "Date when VO was created." , "beanName" : "AttributeDefinition" } , {...} , {...} ] , "beanName" : "Consent" } , {...} , {...} ]

• see Return values
• see HTTP return codes

Returns all consents for a User

Example URL

https://[hostname]/krb/rpc/json/consentsManager/getConsentsForUser

• see URL structure

Example params

{ "user" : 18 }

• see Passing params

Example response

[ { "id" : 1 , "userId" : 1 , "status" : "UNSIGNED" , "consentHub" : { "id" : 10 , "name" : "Test Consent Hub" , "enforceConsents" : false , "facilities" : [ { "id" : 24 , "name" : "host.facility.cz" , "description" : "is optional" , "beanName" : "Facility" } , {...} , {...} ] , "beanName" : "ConsentHub" } , "attributes" :  [ { "id" : 2820 , "friendlyName" : "createdAt" , "namespace" : "urn:perun:vo:attribute-def:core" , "type" : "java.lang.String" , "entity" : "vo" , "writable" : true , "baseFriendlyName" : "createdAt" , "friendlyNameParameter" : "" , "unique" : false , "displayName" : "VO created date" , "description" : "Date when VO was created." , "beanName" : "AttributeDefinition" } , {...} , {...} ] , "beanName" : "Consent" } , {...} , {...} ]

• see Return values
• see HTTP return codes

Returns all consents with a specific status for a User.

Example URL

https://[hostname]/krb/rpc/json/consentsManager/getConsentsForUser

• see URL structure

Example params

{ "user" : 92 , "status" : "text" }

• see Passing params

Example response

[ { "id" : 1 , "userId" : 1 , "status" : "UNSIGNED" , "consentHub" : { "id" : 10 , "name" : "Test Consent Hub" , "enforceConsents" : false , "facilities" : [ { "id" : 24 , "name" : "host.facility.cz" , "description" : "is optional" , "beanName" : "Facility" } , {...} , {...} ] , "beanName" : "ConsentHub" } , "attributes" :  [ { "id" : 2820 , "friendlyName" : "createdAt" , "namespace" : "urn:perun:vo:attribute-def:core" , "type" : "java.lang.String" , "entity" : "vo" , "writable" : true , "baseFriendlyName" : "createdAt" , "friendlyNameParameter" : "" , "unique" : false , "displayName" : "VO created date" , "description" : "Date when VO was created." , "beanName" : "AttributeDefinition" } , {...} , {...} ] , "beanName" : "Consent" } , {...} , {...} ]

• see Return values
• see HTTP return codes

Returns all consents for a user in specified consent hub

Example URL

https://[hostname]/krb/rpc/json/consentsManager/getConsentsForUserAndConsentHub

• see URL structure

Example params

{ "user" : 84 , "consentHub" : 99 }

• see Passing params

Example response

[ { "id" : 1 , "userId" : 1 , "status" : "UNSIGNED" , "consentHub" : { "id" : 10 , "name" : "Test Consent Hub" , "enforceConsents" : false , "facilities" : [ { "id" : 24 , "name" : "host.facility.cz" , "description" : "is optional" , "beanName" : "Facility" } , {...} , {...} ] , "beanName" : "ConsentHub" } , "attributes" :  [ { "id" : 2820 , "friendlyName" : "createdAt" , "namespace" : "urn:perun:vo:attribute-def:core" , "type" : "java.lang.String" , "entity" : "vo" , "writable" : true , "baseFriendlyName" : "createdAt" , "friendlyNameParameter" : "" , "unique" : false , "displayName" : "VO created date" , "description" : "Date when VO was created." , "beanName" : "AttributeDefinition" } , {...} , {...} ] , "beanName" : "Consent" } , {...} , {...} ]

• see Return values
• see HTTP return codes

Updates a consent hub.

Example URL

https://[hostname]/krb/rpc/json/consentsManager/updateConsentHub

• see URL structure

Example params

{ "consentHub" : { "id" : 10 , "name" : "Test Consent Hub" , "enforceConsents" : false , "facilities" : [ { "id" : 24 , "name" : "host.facility.cz" , "description" : "is optional" , "beanName" : "Facility" } , {...} , {...} ] , "beanName" : "ConsentHub" } }

• see Passing params

Example response

{ ... TODO ... }

• see Return values
• see HTTP return codes