RPC API documentation v17.2.0

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

ConsentsManager

Returns consent with changed status.

Parameter nameData typeDescription
consentintConsent id
statusStringUNSIGNED | GRANTED | REVOKED
Thrown exceptionDescription
ConsentNotExistsExceptionif consent hub does not exist
InternalErrorExceptionWhen unspecified error occur. See exception param message for explanation.
InvalidConsentStatusExceptionif passed status value can not be set
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.
UserNotExistsExceptionif user does not exist
Return typeDescription
Consent

Example URL

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

Example params

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

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" }

Evaluates consents for given consent hub.

Parameter nameData typeDescription
consentHubConsentHub
Thrown exceptionDescription
ConsentNotExistsExceptionif consent hub does not exist
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/consentsManager/evaluateConsentsForConsentHub

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" } }

Example response

null

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.

Parameter nameData typeDescription
serviceusedfor consents evaluation
Thrown exceptionDescription
ConsentNotExistsExceptionif consent hub does not exist
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/consentsManager/evaluateConsentsForService

Example params

{ "service" : {...} }

Example response

null

Return list of all Consent Hubs.

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<ConsentHub>list of Consent Hubs

Example URL

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

Example response

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

Returns all existing Consents

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<Consent>list of Consents

Example URL

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

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

Returns Consent with the corresponding id

Parameter nameData typeDescription
idintConsent id
Thrown exceptionDescription
ConsentNotExistsExceptionwhen Consent specified by id doesn't exist
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<Consent>list of Consents

Example URL

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

Example params

{ "id" : 91 }

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

Returns consent for a user in consent hub with specified status

Parameter nameData typeDescription
userintUser id
consentHubintConsentHub id
statusStringUNSIGNED | GRANTED | REVOKED
Thrown exceptionDescription
ConsentHubNotExistsExceptionwhen Consent Hub specified by id doesn't exist
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.
UserNotExistsExceptionwhen User specified by id doesn't exist
Return typeDescription
Consentconsent of User in the ConsentHub with specified ConsentStatus

Example URL

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

Example params

{ "user" : 30 , "consentHub" : 90 , "status" : "text" }

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" }

Returns a Consent Hub by facility id.

Parameter nameData typeDescription
facilityIdfacilityid
Thrown exceptionDescription
ConsentHubNotExistsExceptionWhen Consent Hub for facility with given id doesn't exist.
FacilityNotExistsExceptionif facility with given id does not exist
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
ConsentHubFound Consent Hub

Example URL

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

Example params

{ "facilityId" : {...} }

Example response

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

Returns a Consent Hub by its id.

Parameter nameData typeDescription
idintConsent Hub id
Thrown exceptionDescription
ConsentHubNotExistsExceptionWhen Consent Hub specified by id doesn't exist.
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
ConsentHubFound Consent Hub

Example URL

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

Example params

{ "id" : 84 }

Example response

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

Returns a Consent Hub by its name.

Parameter nameData typeDescription
nameStringConsent Hub name
Thrown exceptionDescription
ConsentHubNotExistsExceptionWhen Consent Hub specified by name doesn't exist.
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
ConsentHubFound Consent Hub

Example URL

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

Example params

{ "name" : "text" }

Example response

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

Returns all consents for a ConsentHub

Parameter nameData typeDescription
consentHubintConsentHub id
Thrown exceptionDescription
ConsentHubNotExistsExceptionwhen Consent Hub specified by id doesn't exist
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<Consent>Consents of the ConsentHub

Example URL

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

Example params

{ "consentHub" : 43 }

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

Returns all consents with a specific status for a ConsentHub.

Parameter nameData typeDescription
consentHubintConsentHub id
statusStringUNSIGNED | GRANTED | REVOKED
Thrown exceptionDescription
ConsentHubNotExistsExceptionwhen Consent Hub specified by id doesn't exist
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<Consent>Consents of the ConsentHub

Example URL

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

Example params

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

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

Returns all consents for a User

Parameter nameData typeDescription
userintUser id
Thrown exceptionDescription
InternalErrorExceptionWhen unspecified error occur. See exception param message for explanation.
PrivilegeExceptionWhen caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values.
RpcExceptionWrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation.
UserNotExistsExceptionwhen User specified by id doesn't exist
Return typeDescription
List<Consent>Consents of the User

Example URL

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

Example params

{ "user" : 73 }

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

Returns all consents with a specific status for a User.

Parameter nameData typeDescription
userintUser id
statusStringUNSIGNED | GRANTED | REVOKED
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.
UserNotExistsExceptionwhen User specified by id doesn't exist
Return typeDescription
List<Consent>Consents of the User

Example URL

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

Example params

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

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

Returns all consents for a user in specified consent hub

Parameter nameData typeDescription
userintUser id
consentHubintConsentHub id
Thrown exceptionDescription
ConsentHubNotExistsExceptionwhen Consent Hub specified by id doesn't exist
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.
UserNotExistsExceptionwhen User specified by id doesn't exist
Return typeDescription
List<Consent>Consents of the User in the ConsentHub

Example URL

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

Example params

{ "user" : 15 , "consentHub" : 52 }

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

Updates a consent hub.

Parameter nameData typeDescription
consentHubConsentHubJSON object
Thrown exceptionDescription
ConsentHubExistsExceptionif consent hub with the same name already exists
ConsentHubNotExistsExceptionif consent hub with given id does not exist
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
updatedconsent hub

Example URL

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

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" } }

Example response

{ ... TODO ... }