Add new mail notification.
Parameter name | Data type | Description |
---|---|---|
vo | int | VO id |
ApplicationMail | ApplicationMail JSON object |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
ApplicationMailId | int |
Example URL
https://[hostname]/krb/rpc/json/registrarManager/addApplicationMail
Example params
{ "vo" : 55 , "mail" : {...} }
Example response
{ ... TODO ... }
Add new mail notification.
Parameter name | Data type | Description |
---|---|---|
group | int | Group id |
ApplicationMail | ApplicationMail JSON object |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
ApplicationMailId | int |
Example URL
https://[hostname]/krb/rpc/json/registrarManager/addApplicationMail
Example params
{ "group" : 96 , "mail" : {...} }
Example response
{ ... TODO ... }
Adds a new item to a form.
Parameter name | Data type | Description |
---|---|---|
vo | int | VO id |
item | ApplicationFormItem | ApplicationFormItem JSON object |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
ApplicationFormItem | Added ApplicationFormItem object |
Example URL
https://[hostname]/krb/rpc/json/registrarManager/addFormItem
Example params
{ "vo" : 83 , "item" : { "id" : 12 , "shortname" : "Form item name' , "required" : false , "updatable" : true , "type" : "CHECKBOX" , "federationAttribute" : "" , "perunSourceAttribute" : "PERUNPEOPLE" , "perunDestinationAttribute" : "", "regex" : "", "applicationTypes" : ["INITIAL" , "EXTENSION"], "ordnum" : 5, "hiddenDependencyItemId" : 5, "disabledDependencyItemId" : 5, "disabled" : "NEVER", "hidden" : "NEVER", "beanName" : "ApplicationFormItem" } }
Example response
{ "id" : 12 , "shortname" : "Form item name' , "required" : false , "updatable" : true , "type" : "CHECKBOX" , "federationAttribute" : "" , "perunSourceAttribute" : "PERUNPEOPLE" , "perunDestinationAttribute" : "", "regex" : "", "applicationTypes" : ["INITIAL" , "EXTENSION"], "ordnum" : 5, "hiddenDependencyItemId" : 5, "disabledDependencyItemId" : 5, "disabled" : "NEVER", "hidden" : "NEVER", "beanName" : "ApplicationFormItem" }
Adds a new item to a form.
Parameter name | Data type | Description |
---|---|---|
group | int | Group id |
item | ApplicationFormItem | ApplicationFormItem JSON object |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
ApplicationFormItem | Added ApplicationFormItem object |
Example URL
https://[hostname]/krb/rpc/json/registrarManager/addFormItem
Example params
{ "group" : 73 , "item" : { "id" : 12 , "shortname" : "Form item name' , "required" : false , "updatable" : true , "type" : "CHECKBOX" , "federationAttribute" : "" , "perunSourceAttribute" : "PERUNPEOPLE" , "perunDestinationAttribute" : "", "regex" : "", "applicationTypes" : ["INITIAL" , "EXTENSION"], "ordnum" : 5, "hiddenDependencyItemId" : 5, "disabledDependencyItemId" : 5, "disabled" : "NEVER", "hidden" : "NEVER", "beanName" : "ApplicationFormItem" } }
Example response
{ "id" : 12 , "shortname" : "Form item name' , "required" : false , "updatable" : true , "type" : "CHECKBOX" , "federationAttribute" : "" , "perunSourceAttribute" : "PERUNPEOPLE" , "perunDestinationAttribute" : "", "regex" : "", "applicationTypes" : ["INITIAL" , "EXTENSION"], "ordnum" : 5, "hiddenDependencyItemId" : 5, "disabledDependencyItemId" : 5, "disabled" : "NEVER", "hidden" : "NEVER", "beanName" : "ApplicationFormItem" }
Adds groups to a list of groups which can be registered into during vo registration.
Parameter name | Data type | Description |
---|---|---|
ids | List<Integer> | list of groups IDs |
Thrown exception | Description |
---|---|
GroupNotAllowedToAutoRegistrationException | When given group cannot be added to auto registration |
GroupNotExistsException | When the group doesn't exist |
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
void |
Example URL
https://[hostname]/krb/rpc/json/registrarManager/addGroupsToAutoRegistration
Example params
{ "ids" : [ 20 , 17 ] }
Example response
null
Adds groups to a list of groups which can be registered into during vo registration and are representing options for a particular form item.
Parameter name | Data type | Description |
---|---|---|
ids | List<Integer> | list of groups IDs |
formItem | int | id of the form item to which the options are assigned |
Thrown exception | Description |
---|---|
GroupNotAllowedToAutoRegistrationException | When given group cannot be added to auto registration |
GroupNotExistsException | When the group doesn't exist |
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
void |
Example URL
https://[hostname]/krb/rpc/json/registrarManager/addGroupsToAutoRegistration
Example params
{ "ids" : [ 6 , 64 ] , "formItem" : 50 }
Example response
null
Adds groups to a list of groups which can be registered into during group registration and are representing options for a particular form item.
Parameter name | Data type | Description |
---|---|---|
ids | List<Integer> | list of groups IDs |
registrationGroup | id | of the group to which these groups will be associated for the embedded registration |
formItem | int | id of the form item to which the options are assigned |
Thrown exception | Description |
---|---|
GroupIsNotASubgroup | When the specified groups contain an item which is not a subgroup of the registration group |
GroupNotAllowedToAutoRegistrationException | When given group cannot be added to auto registration |
GroupNotExistsException | When the group doesn't exist |
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
void |
Example URL
https://[hostname]/krb/rpc/json/registrarManager/addGroupsToAutoRegistration
Example params
{ "ids" : [ 19 , 88 ] , "registrationGroup" : {...} , "formItem" : 78 }
Example response
null
Manually approves an application. Expected to be called as a result of direct VO administrator action in the web UI.
Parameter name | Data type | Description |
---|---|---|
id | int | Application id |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
Application | Approved application |
Example URL
https://[hostname]/krb/rpc/json/registrarManager/approveApplication
Example params
{ "id" : 99 }
Example response
{ "id" : 12 , "vo" : { "id" : 123 , "name" : "My testing VO" , "shortName" : "test_vo" , "beanName" : "Vo" } , "type" : "INITIAL" , "fedInfo" : "" , "state" : "NEW" , "autoApproveError" : null , "extSourceName" : "PERUNPEOPLE" , "extSourceType" : "cz.metacentrum.perun.core.impl.ExtSourceSql" , "user" : { "firstName" : "Some" , "lastName" : "Body" , "middleName" : null , "titleBefore" : "Mgr." , "titleAfter" : null , "serviceUser" : false , "sponsoredUser" : false , "specificUser" : false , "majorSpecificType" : "NORMAL" , "id" : 34 , "uuid" : "5e5a02dd-f991-4706-a428-69c3ea6c5ce8" , "beanName" : "User" }, "beanName" : "Application" }
Manually approve multiple applications at once. Expected to be called as a result of direct VO administrator action in the web UI.
Parameter name | Data type | Description |
---|---|---|
ids | int[] | List of Application IDs |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
list | of ApplicationOperationResult |
Example URL
https://[hostname]/krb/rpc/json/registrarManager/approveApplications
Example params
{ "ids" : [ 40 , 96 ] }
Example response
{ ... TODO ... }
Creates an invitation link for the given Vo with the default authType (if defined in the Vo attribute)
Parameter name | Data type | Description |
---|---|---|
voId | int | id of Vo for which the invitation link should be created |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
the | full invitation URL for Vo |
Example URL
https://[hostname]/krb/rpc/json/registrarManager/buildInviteURL
Example params
{ "voId" : 76 }
Example response
{ ... TODO ... }
Creates an invitation link for the given group with the default authType (if defined in the Group attribute)
Parameter name | Data type | Description |
---|---|---|
voId | int | id of the parent Vo for the given Group |
groupId | int | id of Group for which the invitation link should be created |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
the | full invitation URL for Group |
Example URL
https://[hostname]/krb/rpc/json/registrarManager/buildInviteURL
Example params
{ "voId" : 24 , "groupId" : 4 }
Example response
{ ... TODO ... }
Check if application can be approved based on form module rules. Throws exception if not. Expected to be called from Web UI before actual approving happens, so VO admin can override this default behavior.
Parameter name | Data type | Description |
---|---|---|
id | int | Application id |
Thrown exception | Description |
---|---|
CantBeApprovedException | When application can't be approved based on form module rules. |
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
void |
Example URL
https://[hostname]/krb/rpc/json/registrarManager/canBeApproved
Example params
{ "id" : 14 }
Example response
null
Checks whether input is valid html for application form item checkbox labels
Parameter name | Data type | Description |
---|---|---|
html | String | input html to check |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
InvalidHtmlInputException | when the input is not valid |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
void |
Example URL
https://[hostname]/krb/rpc/json/registrarManager/checkCheckboxHtml
Example params
{ "html" : "text" }
Example response
null
Check for similar users by name and email in session (authz) information
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
List<EnrichedIdentity> | List of found similar identities. |
Example URL
https://[hostname]/krb/rpc/json/registrarManager/checkForSimilarRichIdentities
Example response
{ ... TODO ... }
Check if new application may belong to another user in Perun (but same person in real life). Return list of similar identities (by external identity, name or email). Returned identities contain also organization, email and external identities.
Parameter name | Data type | Description |
---|---|---|
appId | int | id of application to check for |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
List<Identity> | List of found similar identities. |
Example URL
https://[hostname]/krb/rpc/json/registrarManager/checkForSimilarUsers
Example params
{ "appId" : 91 }
Example response
{ ... TODO ... }
Check if new application may belong to another user in Perun (but same person in real life). IMPORTANT: This check is performed only on latest application of specified vo/group and type which belongs to logged in user/identity. Return list of similar identities (by external identity, name or email). Returned identities contain also organization, email and external identities.
Parameter name | Data type | Description |
---|---|---|
voId | int | Vo to get application for |
groupId | int | Group to get application for |
type | String | Application type |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
List<Identity> | List of found similar identities. |
Example URL
https://[hostname]/krb/rpc/json/registrarManager/checkForSimilarUsers
Example params
{ "voId" : 27 , "groupId" : 53 , "type" : "text" }
Example response
{ ... TODO ... }
Check for similar users by name and email in session (authz) information
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
List<Identity> | List of found similar identities. |
Example URL
https://[hostname]/krb/rpc/json/registrarManager/checkForSimilarUsers
Example response
{ ... TODO ... }
Check if newly inserted form data may connect anonymous person to existing user. Return list of similar users (by identity, name or email). Returned users contain also organization and preferredMail attribute.
Parameter name | Data type | Description |
---|---|---|
formItems | List<ApplicationFormItemData> | List of application form items with data |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
List<Identity> | List of found similar identities. |
Example URL
https://[hostname]/krb/rpc/json/registrarManager/checkForSimilarUsers
Example params
{ "formItems" : [ { "id" : 12 , "forItem" : { "id" : 12 , "shortname" : "Form item name' , "required" : false , "updatable" : true , "type" : "CHECKBOX" , "federationAttribute" : "" , "perunSourceAttribute" : "PERUNPEOPLE" , "perunDestinationAttribute" : "", "regex" : "", "applicationTypes" : ["INITIAL" , "EXTENSION"], "ordnum" : 5, "hiddenDependencyItemId" : 5, "disabledDependencyItemId" : 5, "disabled" : "NEVER", "hidden" : "NEVER", "beanName" : "ApplicationFormItem" } , "shortName" : "form data name" , "value" : "test value" , "assuranceLevel" : "0" , "beanName" : "ApplicationFormItemData" } , {...} , {...} ] }
Example response
{ ... TODO ... }
Checks whether input is valid html according to the rules in our custom html parser
Parameter name | Data type | Description |
---|---|---|
html | String | input html to check |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
InvalidHtmlInputException | when html is not valid |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
warning | if the input will be autocompleted/changed during the sanitization, empty string otherwise |
Example URL
https://[hostname]/krb/rpc/json/registrarManager/checkHtmlInput
Example params
{ "html" : "text" }
Example response
{ ... TODO ... }
Resets the group application form to the state after creation - deletes all form items, removes modules and sets approval styles to manual.
Parameter name | Data type | Description |
---|---|---|
group | int | id of group |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
void |
Example URL
https://[hostname]/krb/rpc/json/registrarManager/clearGroupForm
Example params
{ "group" : 72 }
Example response
null
Resets the Vo application form to the state after creation - deletes all form items, removes modules and sets approval styles to manual.
Parameter name | Data type | Description |
---|---|---|
vo | int | id of vo |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
void |
Example URL
https://[hostname]/krb/rpc/json/registrarManager/clearVoForm
Example params
{ "vo" : 94 }
Example response
null
Join user identities by access tokens.
Parameter name | Data type | Description |
---|---|---|
accessToken | access | token |
Thrown exception | Description |
---|---|
IdentitiesAlreadyJoinedException | Both identities used in a process belong to the same user in Perun (already joined). |
IdentityAlreadyInUseException | Both identities used in a process are associated with different users. In order to join two user accounts contact support. |
IdentityIsSameException | User used same identity (authz) to get token and to request joining. |
IdentityUnknownException | When neither current or previous identity is associated with a user in Perun. |
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
InvalidTokenException | when some of the access token is expired |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
void |
Example URL
https://[hostname]/krb/rpc/json/registrarManager/consolidate
Example params
{ "accessToken" : {...} }
Example response
null
Join current user identity (authz) with the one previously provided and referenced by the token.
Parameter name | Data type | Description |
---|---|---|
token | String | Token to be used for joining identities. |
Thrown exception | Description |
---|---|
IdentitiesAlreadyJoinedException | Both identities used in a process belong to the same user in Perun (already joined). |
IdentityAlreadyInUseException | Both identities used in a process are associated with different users. In order to join two user accounts contact support. |
IdentityIsSameException | User used same identity (authz) to get token and to request joining. |
IdentityUnknownException | When neither current or previous identity is associated with a user in Perun. |
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
List<UserExtSource> | List of user identities know to Perun after joining. |
Example URL
https://[hostname]/krb/rpc/json/registrarManager/consolidateIdentityUsingToken
Example params
{ "token" : "text" }
Example response
[ { "userId": 34 , "loa" : 0 , "extSource" : { "name" : "PERUNPEOPLE" , "type" : "cz.metacentrum.perun.core.impl.ExtSourceSql" , "attributes" : {} , "id" : 2 , "beanName" : "ExtSource" } , "login" : "my_login" , "persistent" : true , "id" : 312 , "lastAccess" : "2019-06-10 14:07:42.2767" , "beanName" : "UserExtSource" } , {...} , {...} ]
Copy all form items from selected VO into another.
Parameter name | Data type | Description |
---|---|---|
fromVo | int | Source VO id |
toVo | int | Destination VO id |
idempotent | boolean | if true, the target existing form items are deleted (optional, default is false) |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
Object | Always null |
Example URL
https://[hostname]/krb/rpc/json/registrarManager/copyForm
Example params
{ "fromVo" : 7 , "toVo" : 24 , "idempotent" : true }
Example response
{ ... TODO ... }
Copy all form items from selected Group into another.
Parameter name | Data type | Description |
---|---|---|
fromGroup | int | Source Group id |
toGroup | int | Destination Group id |
idempotent | boolean | if true, the target existing form items are deleted (optional, default is false) |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
Object | Always null |
Example URL
https://[hostname]/krb/rpc/json/registrarManager/copyForm
Example params
{ "fromGroup" : 73 , "toGroup" : 84 , "idempotent" : true }
Example response
{ ... TODO ... }
Copy all form items from selected VO into Group.
Parameter name | Data type | Description |
---|---|---|
fromVo | int | Source VO id |
toGroup | int | Destination Group id |
idempotent | boolean | if true, the target existing form items are deleted (optional, default is false) |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
Object | Always null |
Example URL
https://[hostname]/krb/rpc/json/registrarManager/copyForm
Example params
{ "fromVo" : 37 , "toGroup" : 75 , "idempotent" : true }
Example response
{ ... TODO ... }
Copy all form items from selected Group into VO.
Parameter name | Data type | Description |
---|---|---|
fromGroup | int | Source Group id |
toVo | int | Destination VO id |
idempotent | boolean | if true, the target existing form items are deleted (optional, default is false) |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
Object | Always null |
Example URL
https://[hostname]/krb/rpc/json/registrarManager/copyForm
Example params
{ "fromGroup" : 28 , "toVo" : 2 , "idempotent" : true }
Example response
{ ... TODO ... }
Copy all e-mail notifications from selected VO into another.
Parameter name | Data type | Description |
---|---|---|
fromVo | int | Source VO id |
toVo | int | Destination VO id |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
Object | Always null |
Example URL
https://[hostname]/krb/rpc/json/registrarManager/copyMails
Example params
{ "fromVo" : 53 , "toVo" : 68 }
Example response
{ ... TODO ... }
Copy all e-mail notifications from selected Group into another.
Parameter name | Data type | Description |
---|---|---|
fromGroup | int | Source Group id |
toGroup | int | Destination Group id |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
Object | Always null |
Example URL
https://[hostname]/krb/rpc/json/registrarManager/copyMails
Example params
{ "fromGroup" : 10 , "toGroup" : 15 }
Example response
{ ... TODO ... }
Copy all e-mail notifications from selected VO into Group.
Parameter name | Data type | Description |
---|---|---|
fromVo | int | Source VO id |
toGroup | int | Destination Group id |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
Object | Always null |
Example URL
https://[hostname]/krb/rpc/json/registrarManager/copyMails
Example params
{ "fromVo" : 58 , "toGroup" : 67 }
Example response
{ ... TODO ... }
Copy all e-mail notifications from selected Group into VO.
Parameter name | Data type | Description |
---|---|---|
fromGroup | int | Source Group id |
toVO | int | Destination VO id |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
Object | Always null |
Example URL
https://[hostname]/krb/rpc/json/registrarManager/copyMails
Example params
{ "fromGroup" : 82 , "toVO" : 51 }
Example response
{ ... TODO ... }
Creates a new application. The method triggers approval for VOs with auto-approved applications.
Parameter name | Data type | Description |
---|---|---|
app | Application | Application JSON object |
data | List<ApplicationFormItemData> | List of ApplicationFormItemData JSON objects |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
List<ApplicationFormItemData> | Stored app data |
Example URL
https://[hostname]/krb/rpc/json/registrarManager/createApplication
Example params
{ "app" : { "id" : 12 , "vo" : { "id" : 123 , "name" : "My testing VO" , "shortName" : "test_vo" , "beanName" : "Vo" } , "type" : "INITIAL" , "fedInfo" : "" , "state" : "NEW" , "autoApproveError" : null , "extSourceName" : "PERUNPEOPLE" , "extSourceType" : "cz.metacentrum.perun.core.impl.ExtSourceSql" , "user" : { "firstName" : "Some" , "lastName" : "Body" , "middleName" : null , "titleBefore" : "Mgr." , "titleAfter" : null , "serviceUser" : false , "sponsoredUser" : false , "specificUser" : false , "majorSpecificType" : "NORMAL" , "id" : 34 , "uuid" : "5e5a02dd-f991-4706-a428-69c3ea6c5ce8" , "beanName" : "User" }, "beanName" : "Application" } , "data" : [ { "id" : 12 , "forItem" : { "id" : 12 , "shortname" : "Form item name' , "required" : false , "updatable" : true , "type" : "CHECKBOX" , "federationAttribute" : "" , "perunSourceAttribute" : "PERUNPEOPLE" , "perunDestinationAttribute" : "", "regex" : "", "applicationTypes" : ["INITIAL" , "EXTENSION"], "ordnum" : 5, "hiddenDependencyItemId" : 5, "disabledDependencyItemId" : 5, "disabled" : "NEVER", "hidden" : "NEVER", "beanName" : "ApplicationFormItem" } , "shortName" : "form data name" , "value" : "test value" , "assuranceLevel" : "0" , "beanName" : "ApplicationFormItemData" } , {...} , {...} ] }
Example response
[ { "id" : 12 , "forItem" : { "id" : 12 , "shortname" : "Form item name' , "required" : false , "updatable" : true , "type" : "CHECKBOX" , "federationAttribute" : "" , "perunSourceAttribute" : "PERUNPEOPLE" , "perunDestinationAttribute" : "", "regex" : "", "applicationTypes" : ["INITIAL" , "EXTENSION"], "ordnum" : 5, "hiddenDependencyItemId" : 5, "disabledDependencyItemId" : 5, "disabled" : "NEVER", "hidden" : "NEVER", "beanName" : "ApplicationFormItem" } , "shortName" : "form data name" , "value" : "test value" , "assuranceLevel" : "0" , "beanName" : "ApplicationFormItemData" } , {...} , {...} ]
Create application form for a VO.
Parameter name | Data type | Description |
---|---|---|
vo | int | VO id |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
Object | Always returned null |
Example URL
https://[hostname]/krb/rpc/json/registrarManager/createApplicationForm
Example params
{ "vo" : 1 }
Example response
{ ... TODO ... }
Create application form for a group.
Parameter name | Data type | Description |
---|---|---|
group | int | Group id |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
Object | Always returned null |
Example URL
https://[hostname]/krb/rpc/json/registrarManager/createApplicationForm
Example params
{ "group" : 1 }
Example response
{ ... TODO ... }
Deletes an application.
Parameter name | Data type | Description |
---|---|---|
id | int | Application id |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
void |
Example URL
https://[hostname]/krb/rpc/json/registrarManager/deleteApplication
Example params
{ "id" : 20 }
Example response
null
Deletes an e-mail notification from DB based on id
property.
Parameter name | Data type | Description |
---|---|---|
vo | int | VO id |
id | int | ApplicationMail id |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
Object | Always null |
Example URL
https://[hostname]/krb/rpc/json/registrarManager/deleteApplicationMail
Example params
{ "vo" : 12 , "id" : 53 }
Example response
{ ... TODO ... }
Deletes an e-mail notification from DB based on id
property.
Parameter name | Data type | Description |
---|---|---|
group | int | Group id |
id | int | ApplicationMail id |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
Object | Always null |
Example URL
https://[hostname]/krb/rpc/json/registrarManager/deleteApplicationMail
Example params
{ "group" : 22 , "id" : 95 }
Example response
{ ... TODO ... }
Manually delete multiple applications at once. Expected to be called as a result of direct VO administrator action in the web UI.
Parameter name | Data type | Description |
---|---|---|
ids | int[] | List of Application IDs |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
list | of ApplicationOperationResult |
Example URL
https://[hostname]/krb/rpc/json/registrarManager/deleteApplications
Example params
{ "ids" : [ 12 , 3 ] }
Example response
{ ... TODO ... }
Removes a form item permanently. The user data associated with it remains in the database, it just loses the foreign key reference which becomes null.
Parameter name | Data type | Description |
---|---|---|
vo | int | VO id |
ordnum | int | Item's ordnum |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
Object | Always null |
Example URL
https://[hostname]/krb/rpc/json/registrarManager/deleteFormItem
Example params
{ "vo" : 57 , "ordnum" : 7 }
Example response
{ ... TODO ... }
Removes a form item permanently. The user data associated with it remains in the database, it just loses the foreign key reference which becomes null.
Parameter name | Data type | Description |
---|---|---|
group | int | Group id |
ordnum | int | Item's ordnum |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
Object | Always null |
Example URL
https://[hostname]/krb/rpc/json/registrarManager/deleteFormItem
Example params
{ "group" : 10 , "ordnum" : 75 }
Example response
{ ... TODO ... }
Deletes groups from a list of groups which can be registered into during vo registration.
Parameter name | Data type | Description |
---|---|---|
ids | List<Integer> | list of groups IDs |
Thrown exception | Description |
---|---|
GroupNotExistsException | When the group doesn't exist |
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
void |
Example URL
https://[hostname]/krb/rpc/json/registrarManager/deleteGroupsFromAutoRegistration
Example params
{ "ids" : [ 25 , 24 ] }
Example response
null
Deletes groups from a list of groups which can be registered into during vo registration and are representing options for a particular form item.
Parameter name | Data type | Description |
---|---|---|
ids | List<Integer> | list of groups IDs |
formItem | int | id of the form item to which the options are assigned |
Thrown exception | Description |
---|---|
ApplicationFormItem | |
GroupNotExistsException | When the group doesn't exist |
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
void |
Example URL
https://[hostname]/krb/rpc/json/registrarManager/deleteGroupsFromAutoRegistration
Example params
{ "ids" : [ 11 , 50 ] , "formItem" : 71 }
Example response
null
Deletes groups from a list of groups which can be registered into during group registration and are representing options for a particular form item.
Parameter name | Data type | Description |
---|---|---|
ids | List<Integer> | list of groups IDs |
registrationGroup | id | of the group to which these groups are associated for the embedded registration |
formItem | int | id of the form item to which the options are assigned |
Thrown exception | Description |
---|---|
GroupIsNotASubgroup | When the specified groups contain an item which is not a subgroup of the registration group |
GroupNotExistsException | When the group doesn't exist |
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
void |
Example URL
https://[hostname]/krb/rpc/json/registrarManager/deleteGroupsFromAutoRegistration
Example params
{ "ids" : [ 44 , 86 ] , "registrationGroup" : {...} , "formItem" : 3 }
Example response
null
Returns all groups which can be registered into during any vo registration.
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
List<Group> | list of groups |
Example URL
https://[hostname]/krb/rpc/json/registrarManager/getAllGroupsForAutoRegistration
Example response
[ { "id" : 1061 , "name" : "My group" , "shortName" : "My group" , "description" : "My testing group" , "parentGroupId" : null , "voId" : 201 , "uuid" : "31e1014b-e994-4cb2-b238-e32aeef87670" , "beanName" : "Group" } , {...} , {...} ]
Returns application object by its id
.
Parameter name | Data type | Description |
---|---|---|
id | int | Application id |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
Application | Found application |
Example URL
https://[hostname]/krb/rpc/json/registrarManager/getApplicationById
Example params
{ "id" : 73 }
Example response
{ "id" : 12 , "vo" : { "id" : 123 , "name" : "My testing VO" , "shortName" : "test_vo" , "beanName" : "Vo" } , "type" : "INITIAL" , "fedInfo" : "" , "state" : "NEW" , "autoApproveError" : null , "extSourceName" : "PERUNPEOPLE" , "extSourceType" : "cz.metacentrum.perun.core.impl.ExtSourceSql" , "user" : { "firstName" : "Some" , "lastName" : "Body" , "middleName" : null , "titleBefore" : "Mgr." , "titleAfter" : null , "serviceUser" : false , "sponsoredUser" : false , "specificUser" : false , "majorSpecificType" : "NORMAL" , "id" : 34 , "uuid" : "5e5a02dd-f991-4706-a428-69c3ea6c5ce8" , "beanName" : "User" }, "beanName" : "Application" }
Returns data submitted by user in given application (by id).
Parameter name | Data type | Description |
---|---|---|
id | int | Application id |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
List<ApplicationFormItemData> | Form data |
Example URL
https://[hostname]/krb/rpc/json/registrarManager/getApplicationDataById
Example params
{ "id" : 3 }
Example response
[ { "id" : 12 , "forItem" : { "id" : 12 , "shortname" : "Form item name' , "required" : false , "updatable" : true , "type" : "CHECKBOX" , "federationAttribute" : "" , "perunSourceAttribute" : "PERUNPEOPLE" , "perunDestinationAttribute" : "", "regex" : "", "applicationTypes" : ["INITIAL" , "EXTENSION"], "ordnum" : 5, "hiddenDependencyItemId" : 5, "disabledDependencyItemId" : 5, "disabled" : "NEVER", "hidden" : "NEVER", "beanName" : "ApplicationFormItem" } , "shortName" : "form data name" , "value" : "test value" , "assuranceLevel" : "0" , "beanName" : "ApplicationFormItemData" } , {...} , {...} ]
Gets an application form for a given VO. There is exactly one form for membership per VO, one form is used for both initial registration and annual account expansion, just the form items are marked whether the should be present in one, the other, or both types of application.
Parameter name | Data type | Description |
---|---|---|
vo | int | VO id |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
ApplicationForm | Registration form description |
Example URL
https://[hostname]/krb/rpc/json/registrarManager/getApplicationForm
Example params
{ "vo" : 75 }
Example response
{ "id" : 12 , "vo" : { "id" : 123 , "name" : "My testing VO" , "shortName" : "test_vo" , "beanName" : "Vo" } , "automaticApproval" : true , "automaticApprovalExtension" : true , "moduleClassName" : "cz.metacentrum.perun.core.impl.modules.attributes.VirtualAttributesModule" , "beanName" : "ApplicationForm" }
Gets an application form for a given Group. There is exactly one form for membership per Group, one form is used for both initial registration and annual account expansion, just the form items are marked whether the should be present in one, the other, or both types of application.
Parameter name | Data type | Description |
---|---|---|
group | int | Group id |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
ApplicationForm | Registration form description |
Example URL
https://[hostname]/krb/rpc/json/registrarManager/getApplicationForm
Example params
{ "group" : 79 }
Example response
{ "id" : 12 , "vo" : { "id" : 123 , "name" : "My testing VO" , "shortName" : "test_vo" , "beanName" : "Vo" } , "automaticApproval" : true , "automaticApprovalExtension" : true , "moduleClassName" : "cz.metacentrum.perun.core.impl.modules.attributes.VirtualAttributesModule" , "beanName" : "ApplicationForm" }
Return mail definition including texts by id
.
Parameter name | Data type | Description |
---|---|---|
id | int | ApplicationMail id |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
ApplicationMail | ApplicationMail object |
Example URL
https://[hostname]/krb/rpc/json/registrarManager/getApplicationMailById
Example params
{ "id" : 28 }
Example response
{ ... TODO ... }
Returns all mail notifications related to specific app form.
Parameter name | Data type | Description |
---|---|---|
vo | int | VO id |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
List<ApplicationMail> | Application mails |
Example URL
https://[hostname]/krb/rpc/json/registrarManager/getApplicationMails
Example params
{ "vo" : 28 }
Example response
{ ... TODO ... }
Returns all mail notifications related to specific app form.
Parameter name | Data type | Description |
---|---|---|
group | int | Group id |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
List<ApplicationMail> | Application mails |
Example URL
https://[hostname]/krb/rpc/json/registrarManager/getApplicationMails
Example params
{ "group" : 62 }
Example response
{ ... TODO ... }
Gets all applications for a given Group.
Parameter name | Data type | Description |
---|---|---|
group | int | Group id |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
List<Application> | Found applications |
Example URL
https://[hostname]/krb/rpc/json/registrarManager/getApplicationsForGroup
Example params
{ "group" : 42 }
Example response
[ { "id" : 12 , "vo" : { "id" : 123 , "name" : "My testing VO" , "shortName" : "test_vo" , "beanName" : "Vo" } , "type" : "INITIAL" , "fedInfo" : "" , "state" : "NEW" , "autoApproveError" : null , "extSourceName" : "PERUNPEOPLE" , "extSourceType" : "cz.metacentrum.perun.core.impl.ExtSourceSql" , "user" : { "firstName" : "Some" , "lastName" : "Body" , "middleName" : null , "titleBefore" : "Mgr." , "titleAfter" : null , "serviceUser" : false , "sponsoredUser" : false , "specificUser" : false , "majorSpecificType" : "NORMAL" , "id" : 34 , "uuid" : "5e5a02dd-f991-4706-a428-69c3ea6c5ce8" , "beanName" : "User" }, "beanName" : "Application" } , {...} , {...} ]
Gets all applications in a given state for a given Group.
Parameter name | Data type | Description |
---|---|---|
group | int | Group id |
state | List<String> | List of states: NEW, VERIFIED, APPROVED, REJECTED |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
List<Application> | Found applications |
Example URL
https://[hostname]/krb/rpc/json/registrarManager/getApplicationsForGroup
Example params
{ "group" : 75 , "state" : [ "text" , "text" ] }
Example response
[ { "id" : 12 , "vo" : { "id" : 123 , "name" : "My testing VO" , "shortName" : "test_vo" , "beanName" : "Vo" } , "type" : "INITIAL" , "fedInfo" : "" , "state" : "NEW" , "autoApproveError" : null , "extSourceName" : "PERUNPEOPLE" , "extSourceType" : "cz.metacentrum.perun.core.impl.ExtSourceSql" , "user" : { "firstName" : "Some" , "lastName" : "Body" , "middleName" : null , "titleBefore" : "Mgr." , "titleAfter" : null , "serviceUser" : false , "sponsoredUser" : false , "specificUser" : false , "majorSpecificType" : "NORMAL" , "id" : 34 , "uuid" : "5e5a02dd-f991-4706-a428-69c3ea6c5ce8" , "beanName" : "User" }, "beanName" : "Application" } , {...} , {...} ]
Gets all applications in a given state for a given Group in a given date period.
Parameter name | Data type | Description |
---|---|---|
group | int | Group id |
state | List<String> | List of states: NEW, VERIFIED, APPROVED, REJECTED |
dateFrom | LocalDate | Earliest date for applications (format "YYYY-MM-DD") |
dateTo | LocalDate | Latest date for applications (format "YYYY-MM-DD") |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
List<Application> | Found applications |
Example URL
https://[hostname]/krb/rpc/json/registrarManager/getApplicationsForGroup
Example params
{ "group" : 30 , "state" : [ "text" , "text" ] , "dateFrom" : {...} , "dateTo" : {...} }
Example response
[ { "id" : 12 , "vo" : { "id" : 123 , "name" : "My testing VO" , "shortName" : "test_vo" , "beanName" : "Vo" } , "type" : "INITIAL" , "fedInfo" : "" , "state" : "NEW" , "autoApproveError" : null , "extSourceName" : "PERUNPEOPLE" , "extSourceType" : "cz.metacentrum.perun.core.impl.ExtSourceSql" , "user" : { "firstName" : "Some" , "lastName" : "Body" , "middleName" : null , "titleBefore" : "Mgr." , "titleAfter" : null , "serviceUser" : false , "sponsoredUser" : false , "specificUser" : false , "majorSpecificType" : "NORMAL" , "id" : 34 , "uuid" : "5e5a02dd-f991-4706-a428-69c3ea6c5ce8" , "beanName" : "User" }, "beanName" : "Application" } , {...} , {...} ]
Gets all applications for member
Parameter name | Data type | Description |
---|---|---|
member | int | id of member to get applications for |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
List<Application> | Found applications |
Example URL
https://[hostname]/krb/rpc/json/registrarManager/getApplicationsForMember
Example params
{ "member" : 65 }
Example response
[ { "id" : 12 , "vo" : { "id" : 123 , "name" : "My testing VO" , "shortName" : "test_vo" , "beanName" : "Vo" } , "type" : "INITIAL" , "fedInfo" : "" , "state" : "NEW" , "autoApproveError" : null , "extSourceName" : "PERUNPEOPLE" , "extSourceType" : "cz.metacentrum.perun.core.impl.ExtSourceSql" , "user" : { "firstName" : "Some" , "lastName" : "Body" , "middleName" : null , "titleBefore" : "Mgr." , "titleAfter" : null , "serviceUser" : false , "sponsoredUser" : false , "specificUser" : false , "majorSpecificType" : "NORMAL" , "id" : 34 , "uuid" : "5e5a02dd-f991-4706-a428-69c3ea6c5ce8" , "beanName" : "User" }, "beanName" : "Application" } , {...} , {...} ]
Gets all applications for member
Parameter name | Data type | Description |
---|---|---|
member | int | id of member to get applications for |
group | int | id of group to filter applications for |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
List<Application> | Found applications |
Example URL
https://[hostname]/krb/rpc/json/registrarManager/getApplicationsForMember
Example params
{ "member" : 86 , "group" : 28 }
Example response
[ { "id" : 12 , "vo" : { "id" : 123 , "name" : "My testing VO" , "shortName" : "test_vo" , "beanName" : "Vo" } , "type" : "INITIAL" , "fedInfo" : "" , "state" : "NEW" , "autoApproveError" : null , "extSourceName" : "PERUNPEOPLE" , "extSourceType" : "cz.metacentrum.perun.core.impl.ExtSourceSql" , "user" : { "firstName" : "Some" , "lastName" : "Body" , "middleName" : null , "titleBefore" : "Mgr." , "titleAfter" : null , "serviceUser" : false , "sponsoredUser" : false , "specificUser" : false , "majorSpecificType" : "NORMAL" , "id" : 34 , "uuid" : "5e5a02dd-f991-4706-a428-69c3ea6c5ce8" , "beanName" : "User" }, "beanName" : "Application" } , {...} , {...} ]
Gets all applications for the current user based on authz and internal user ID.
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
List<Application> | Found applications |
Example URL
https://[hostname]/krb/rpc/json/registrarManager/getApplicationsForUser
Example response
[ { "id" : 12 , "vo" : { "id" : 123 , "name" : "My testing VO" , "shortName" : "test_vo" , "beanName" : "Vo" } , "type" : "INITIAL" , "fedInfo" : "" , "state" : "NEW" , "autoApproveError" : null , "extSourceName" : "PERUNPEOPLE" , "extSourceType" : "cz.metacentrum.perun.core.impl.ExtSourceSql" , "user" : { "firstName" : "Some" , "lastName" : "Body" , "middleName" : null , "titleBefore" : "Mgr." , "titleAfter" : null , "serviceUser" : false , "sponsoredUser" : false , "specificUser" : false , "majorSpecificType" : "NORMAL" , "id" : 34 , "uuid" : "5e5a02dd-f991-4706-a428-69c3ea6c5ce8" , "beanName" : "User" }, "beanName" : "Application" } , {...} , {...} ]
Gets all applications for a specific user by user ID. Ignores session data.
Parameter name | Data type | Description |
---|---|---|
id | int | User id |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
List<Application> | Found applications |
Example URL
https://[hostname]/krb/rpc/json/registrarManager/getApplicationsForUser
Example params
{ "id" : 96 }
Example response
[ { "id" : 12 , "vo" : { "id" : 123 , "name" : "My testing VO" , "shortName" : "test_vo" , "beanName" : "Vo" } , "type" : "INITIAL" , "fedInfo" : "" , "state" : "NEW" , "autoApproveError" : null , "extSourceName" : "PERUNPEOPLE" , "extSourceType" : "cz.metacentrum.perun.core.impl.ExtSourceSql" , "user" : { "firstName" : "Some" , "lastName" : "Body" , "middleName" : null , "titleBefore" : "Mgr." , "titleAfter" : null , "serviceUser" : false , "sponsoredUser" : false , "specificUser" : false , "majorSpecificType" : "NORMAL" , "id" : 34 , "uuid" : "5e5a02dd-f991-4706-a428-69c3ea6c5ce8" , "beanName" : "User" }, "beanName" : "Application" } , {...} , {...} ]
Gets all applications in a given state for a given VO.
Parameter name | Data type | Description |
---|---|---|
vo | int | VO id |
state | List<String> | List of states: NEW, VERIFIED, APPROVED, REJECTED |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
List<Application> | Found applications |
Example URL
https://[hostname]/krb/rpc/json/registrarManager/getApplicationsForVo
Example params
{ "vo" : 65 , "state" : [ "text" , "text" ] }
Example response
[ { "id" : 12 , "vo" : { "id" : 123 , "name" : "My testing VO" , "shortName" : "test_vo" , "beanName" : "Vo" } , "type" : "INITIAL" , "fedInfo" : "" , "state" : "NEW" , "autoApproveError" : null , "extSourceName" : "PERUNPEOPLE" , "extSourceType" : "cz.metacentrum.perun.core.impl.ExtSourceSql" , "user" : { "firstName" : "Some" , "lastName" : "Body" , "middleName" : null , "titleBefore" : "Mgr." , "titleAfter" : null , "serviceUser" : false , "sponsoredUser" : false , "specificUser" : false , "majorSpecificType" : "NORMAL" , "id" : 34 , "uuid" : "5e5a02dd-f991-4706-a428-69c3ea6c5ce8" , "beanName" : "User" }, "beanName" : "Application" } , {...} , {...} ]
Gets all applications in a given state for a given VO in a given date period.
Parameter name | Data type | Description |
---|---|---|
vo | int | VO id |
state | List<String> | List of states: NEW, VERIFIED, APPROVED, REJECTED |
dateFrom | LocalDate | Earliest date for applications (format "YYYY-MM-DD") |
dateTo | LocalDate | Latest date for applications (format "YYYY-MM-DD") |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
List<Application> | Found applications |
Example URL
https://[hostname]/krb/rpc/json/registrarManager/getApplicationsForVo
Example params
{ "vo" : 84 , "state" : [ "text" , "text" ] , "dateFrom" : {...} , "dateTo" : {...} }
Example response
[ { "id" : 12 , "vo" : { "id" : 123 , "name" : "My testing VO" , "shortName" : "test_vo" , "beanName" : "Vo" } , "type" : "INITIAL" , "fedInfo" : "" , "state" : "NEW" , "autoApproveError" : null , "extSourceName" : "PERUNPEOPLE" , "extSourceType" : "cz.metacentrum.perun.core.impl.ExtSourceSql" , "user" : { "firstName" : "Some" , "lastName" : "Body" , "middleName" : null , "titleBefore" : "Mgr." , "titleAfter" : null , "serviceUser" : false , "sponsoredUser" : false , "specificUser" : false , "majorSpecificType" : "NORMAL" , "id" : 34 , "uuid" : "5e5a02dd-f991-4706-a428-69c3ea6c5ce8" , "beanName" : "User" }, "beanName" : "Application" } , {...} , {...} ]
Get page of applications from the given vo, with the given attributes. Query parameter specifies offset, page size, sorting order, sorting column, statuses of the applications, whether to include group applications if searching only in VO and string to search applications by (by default it searches in group names/descriptions, group and application ids, group uuids, logins of submitters and application_data values), dateFrom and dateTo are optional and specify dates when the applications were submitted, the last 2 parameters are optional and serve to search group/member specific applications.
Parameter name | Data type | Description |
---|---|---|
vo | int | Vo id |
query | ApplicationsPageQuery | Query with page information |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PerunException | |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
PrivilegeException | if user doesnt have sufficient privileges |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
VoNotExistsException | if there is no such vo |
Return type | Description |
---|---|
Paginated<RichApplication> | page of requested rich applications |
Example URL
https://[hostname]/krb/rpc/json/registrarManager/getApplicationsPage
Example params
{ "vo" : 56 , "query" : { "pageSize" : 3 , "offset" : 0 , "order" : "ASCENDING" , "sortColumn" : "ID" , "includeGroupApplications" : true , "searchString" : "Doe" , "states" : ["VERIFIED" , "NEW"] , "dateFrom" : "2011-05-17", "dateTo" : "2011-05-17", "memberId" : 10 , "groupId" : 10 } }
Example response
{ "offset" : 0 , "pageSize" : 3 , "totalCount" : 1 , "data" : [ { "id" : 12 , "vo" : { "id" : 123 , "name" : "My testing VO" , "shortName" : "test_vo" , "beanName" : "Vo" } , "type" : "INITIAL" , "fedInfo" : "" , "state" : "NEW" , "autoApproveError" : null , "extSourceName" : "PERUNPEOPLE" , "extSourceType" : "cz.metacentrum.perun.core.impl.ExtSourceSql" , "user" : { "firstName" : "Some" , "lastName" : "Body" , "middleName" : null , "titleBefore" : "Mgr." , "titleAfter" : null , "serviceUser" : false , "sponsoredUser" : false , "specificUser" : false , "majorSpecificType" : "NORMAL" , "id" : 34 , "uuid" : "5e5a02dd-f991-4706-a428-69c3ea6c5ce8" , "beanName" : "User" }, "beanName" : "RichApplication", "formData" : [ { "id" : 12 , "forItem" : { "id" : 12 , "shortname" : "Form item name' , "required" : false , "updatable" : true , "type" : "CHECKBOX" , "federationAttribute" : "" , "perunSourceAttribute" : "PERUNPEOPLE" , "perunDestinationAttribute" : "", "regex" : "", "applicationTypes" : ["INITIAL" , "EXTENSION"], "ordnum" : 5, "hiddenDependencyItemId" : 5, "disabledDependencyItemId" : 5, "disabled" : "NEVER", "hidden" : "NEVER", "beanName" : "ApplicationFormItem" } , "shortName" : "form data name" , "value" : "test value" , "assuranceLevel" : "0" , "beanName" : "ApplicationFormItemData" } , {...} , {...} ] } , {...} , {...} ] }
Get time-limited token proving user identity in external source (for now 3 minutes). It can be used to join user identity with another by calling consolidateIdentityUsingToken() method and passing the token. Please note, that different authz (identity) must be used to perform both calls.
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
String | Token to be used for joining identities. |
Example URL
https://[hostname]/krb/rpc/json/registrarManager/getConsolidatorToken
Example response
"text"
Return form item by its ID, you must be authorized to manipulate the form.
Parameter name | Data type | Description |
---|---|---|
id | int | ID of application form item |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
ApplicationFormItem | item of application form |
Example URL
https://[hostname]/krb/rpc/json/registrarManager/getFormItemById
Example params
{ "id" : 95 }
Example response
{ "id" : 12 , "shortname" : "Form item name' , "required" : false , "updatable" : true , "type" : "CHECKBOX" , "federationAttribute" : "" , "perunSourceAttribute" : "PERUNPEOPLE" , "perunDestinationAttribute" : "", "regex" : "", "applicationTypes" : ["INITIAL" , "EXTENSION"], "ordnum" : 5, "hiddenDependencyItemId" : 5, "disabledDependencyItemId" : 5, "disabled" : "NEVER", "hidden" : "NEVER", "beanName" : "ApplicationFormItem" }
Gets all items in VO application form.
Parameter name | Data type | Description |
---|---|---|
vo | int | VO id |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
List<ApplicationFormItem> | All form items regardless of type |
Example URL
https://[hostname]/krb/rpc/json/registrarManager/getFormItems
Example params
{ "vo" : 49 }
Example response
[ { "id" : 12 , "shortname" : "Form item name' , "required" : false , "updatable" : true , "type" : "CHECKBOX" , "federationAttribute" : "" , "perunSourceAttribute" : "PERUNPEOPLE" , "perunDestinationAttribute" : "", "regex" : "", "applicationTypes" : ["INITIAL" , "EXTENSION"], "ordnum" : 5, "hiddenDependencyItemId" : 5, "disabledDependencyItemId" : 5, "disabled" : "NEVER", "hidden" : "NEVER", "beanName" : "ApplicationFormItem" } , {...} , {...} ]
Gets items of specified type in VO application form, for initital registration or extension of account.
Parameter name | Data type | Description |
---|---|---|
vo | int | VO id |
type | String | Application type: INITIAL or EXTENSION |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
List<ApplicationFormItem> | Items of specified type |
Example URL
https://[hostname]/krb/rpc/json/registrarManager/getFormItems
Example params
{ "vo" : 69 , "type" : "text" }
Example response
[ { "id" : 12 , "shortname" : "Form item name' , "required" : false , "updatable" : true , "type" : "CHECKBOX" , "federationAttribute" : "" , "perunSourceAttribute" : "PERUNPEOPLE" , "perunDestinationAttribute" : "", "regex" : "", "applicationTypes" : ["INITIAL" , "EXTENSION"], "ordnum" : 5, "hiddenDependencyItemId" : 5, "disabledDependencyItemId" : 5, "disabled" : "NEVER", "hidden" : "NEVER", "beanName" : "ApplicationFormItem" } , {...} , {...} ]
Gets all items in Group application form.
Parameter name | Data type | Description |
---|---|---|
group | int | Group id |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
List<ApplicationFormItem> | All form items regardless of type |
Example URL
https://[hostname]/krb/rpc/json/registrarManager/getFormItems
Example params
{ "group" : 45 }
Example response
[ { "id" : 12 , "shortname" : "Form item name' , "required" : false , "updatable" : true , "type" : "CHECKBOX" , "federationAttribute" : "" , "perunSourceAttribute" : "PERUNPEOPLE" , "perunDestinationAttribute" : "", "regex" : "", "applicationTypes" : ["INITIAL" , "EXTENSION"], "ordnum" : 5, "hiddenDependencyItemId" : 5, "disabledDependencyItemId" : 5, "disabled" : "NEVER", "hidden" : "NEVER", "beanName" : "ApplicationFormItem" } , {...} , {...} ]
Gets items of specified type in Group application form, for initital registration or extension of account.
Parameter name | Data type | Description |
---|---|---|
group | int | Group id |
type | String | Application type: INITIAL, EXTENSION or EMBEDDED |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
List<ApplicationFormItem> | Items of specified type |
Example URL
https://[hostname]/krb/rpc/json/registrarManager/getFormItems
Example params
{ "group" : 92 , "type" : "text" }
Example response
[ { "id" : 12 , "shortname" : "Form item name' , "required" : false , "updatable" : true , "type" : "CHECKBOX" , "federationAttribute" : "" , "perunSourceAttribute" : "PERUNPEOPLE" , "perunDestinationAttribute" : "", "regex" : "", "applicationTypes" : ["INITIAL" , "EXTENSION"], "ordnum" : 5, "hiddenDependencyItemId" : 5, "disabledDependencyItemId" : 5, "disabled" : "NEVER", "hidden" : "NEVER", "beanName" : "ApplicationFormItem" } , {...} , {...} ]
Gets the content for an application form for a given type of application and user. The values are prefilled from database for extension applications, and always from federation values taken from the user argument.
Parameter name | Data type | Description |
---|---|---|
vo | int | VO id |
type | String | Application type: INITIAL or EXTENSION |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
List<ApplicationFormItemWithPrefilledValue> | Form items |
Example URL
https://[hostname]/krb/rpc/json/registrarManager/getFormItemsWithPrefilledValues
Example params
{ "vo" : 63 , "type" : "text" }
Example response
{ ... TODO ... }
Gets the content for an application form for a given type of application and user. The values are prefilled from database for extension applications, and always from federation values taken from the user argument.
Parameter name | Data type | Description |
---|---|---|
group | int | Group id |
type | String | Application type: INITIAL, EXTENSION or EMBEDDED |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
List<ApplicationFormItemWithPrefilledValue> | Form items |
Example URL
https://[hostname]/krb/rpc/json/registrarManager/getFormItemsWithPrefilledValues
Example params
{ "group" : 29 , "type" : "text" }
Example response
{ ... TODO ... }
Returns all groups which can be registered into during vo registration.
Parameter name | Data type | Description |
---|---|---|
vo | int | vo id |
formItem | int | id of the form item to which the options are assigned |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
VoNotExistsException | When the vo doesn't exist |
Return type | Description |
---|---|
List<Group> | list of groups |
Example URL
https://[hostname]/krb/rpc/json/registrarManager/getGroupsToAutoRegistration
Example params
{ "vo" : 47 , "formItem" : 15 }
Example response
[ { "id" : 1061 , "name" : "My group" , "shortName" : "My group" , "description" : "My testing group" , "parentGroupId" : null , "voId" : 201 , "uuid" : "31e1014b-e994-4cb2-b238-e32aeef87670" , "beanName" : "Group" } , {...} , {...} ]
Returns all groups which can be registered into during group registration.
Parameter name | Data type | Description |
---|---|---|
group | int | group id |
formItem | int | id of the form item to which the options are assigned |
Thrown exception | Description |
---|---|
GroupNotExistsException | When the group doesn't exist |
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
List<Group> | list of groups |
Example URL
https://[hostname]/krb/rpc/json/registrarManager/getGroupsToAutoRegistration
Example params
{ "group" : 60 , "formItem" : 36 }
Example response
[ { "id" : 1061 , "name" : "My group" , "shortName" : "My group" , "description" : "My testing group" , "parentGroupId" : null , "voId" : 201 , "uuid" : "31e1014b-e994-4cb2-b238-e32aeef87670" , "beanName" : "Group" } , {...} , {...} ]
Gets open applications for the current user based on authz and internal user ID.
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
List<Application> | Found open applications |
Example URL
https://[hostname]/krb/rpc/json/registrarManager/getOpenApplicationsForUser
Example response
[ { "id" : 12 , "vo" : { "id" : 123 , "name" : "My testing VO" , "shortName" : "test_vo" , "beanName" : "Vo" } , "type" : "INITIAL" , "fedInfo" : "" , "state" : "NEW" , "autoApproveError" : null , "extSourceName" : "PERUNPEOPLE" , "extSourceType" : "cz.metacentrum.perun.core.impl.ExtSourceSql" , "user" : { "firstName" : "Some" , "lastName" : "Body" , "middleName" : null , "titleBefore" : "Mgr." , "titleAfter" : null , "serviceUser" : false , "sponsoredUser" : false , "specificUser" : false , "majorSpecificType" : "NORMAL" , "id" : 34 , "uuid" : "5e5a02dd-f991-4706-a428-69c3ea6c5ce8" , "beanName" : "User" }, "beanName" : "Application" } , {...} , {...} ]
Gets open applications for a specific user by user ID. Ignores session data.
Parameter name | Data type | Description |
---|---|---|
id | int | User id |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
List<Application> | Found open applications |
Example URL
https://[hostname]/krb/rpc/json/registrarManager/getOpenApplicationsForUser
Example params
{ "id" : 92 }
Example response
[ { "id" : 12 , "vo" : { "id" : 123 , "name" : "My testing VO" , "shortName" : "test_vo" , "beanName" : "Vo" } , "type" : "INITIAL" , "fedInfo" : "" , "state" : "NEW" , "autoApproveError" : null , "extSourceName" : "PERUNPEOPLE" , "extSourceType" : "cz.metacentrum.perun.core.impl.ExtSourceSql" , "user" : { "firstName" : "Some" , "lastName" : "Body" , "middleName" : null , "titleBefore" : "Mgr." , "titleAfter" : null , "serviceUser" : false , "sponsoredUser" : false , "specificUser" : false , "majorSpecificType" : "NORMAL" , "id" : 34 , "uuid" : "5e5a02dd-f991-4706-a428-69c3ea6c5ce8" , "beanName" : "User" }, "beanName" : "Application" } , {...} , {...} ]
Retrieves all necessary data about VO under registrar session.
Parameter name | Data type | Description |
---|---|---|
voShortName | String | VO's shortname to get info about |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
List<Attribute> | List of VO attributes |
Example URL
https://[hostname]/krb/rpc/json/registrarManager/initialize
Example params
{ "voShortName" : "text" }
Example response
[ { "id" : 2820 , "friendlyName" : "createdAt" , "namespace" : "urn:perun:vo:attribute-def:core" , "value" : "2011-05-17 00:50:06.3" , "type" : "java.lang.String" , "entity" : "vo" , "writable" : true , "baseFriendlyName" : "createdAt" , "friendlyNameParameter" : "" , "unique" : false , "displayName" : "VO created date" , "description" : "Date when VO was created." , "beanName" : "Attribute" } , {...} , {...} ]
Retrieves all necessary data about VO and Group under registrar session.
Parameter name | Data type | Description |
---|---|---|
voShortName | String | VO's shortname to get info about |
groupName | String | Group's full name (including groups structure) to get info about |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
List<Attribute> | List of VO attributes |
Example URL
https://[hostname]/krb/rpc/json/registrarManager/initialize
Example params
{ "voShortName" : "text" , "groupName" : "text" }
Example response
[ { "id" : 2820 , "friendlyName" : "createdAt" , "namespace" : "urn:perun:vo:attribute-def:core" , "value" : "2011-05-17 00:50:06.3" , "type" : "java.lang.String" , "entity" : "vo" , "writable" : true , "baseFriendlyName" : "createdAt" , "friendlyNameParameter" : "" , "unique" : false , "displayName" : "VO created date" , "description" : "Date when VO was created." , "beanName" : "Attribute" } , {...} , {...} ]
Checks if invitation form and invitation notification exist.
Parameter name | Data type | Description |
---|---|---|
vo | Vo | id |
group | Group | id |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
true | if invitation form and invitation notification exist, false otherwise |
Example URL
https://[hostname]/krb/rpc/json/registrarManager/invitationFormExists
Example params
{ "vo" : { "id" : 123 , "name" : "My testing VO" , "shortName" : "test_vo" , "beanName" : "Vo" } , "group" : { "id" : 1061 , "name" : "My group" , "shortName" : "My group" , "description" : "My testing group" , "parentGroupId" : null , "voId" : 201 , "uuid" : "31e1014b-e994-4cb2-b238-e32aeef87670" , "beanName" : "Group" } }
Example response
{ ... TODO ... }
Invite member candidates. If candidate contains richUser, then his preferred mail is retrieved and used, otherwise email must be passed in candidate's attributes.
Parameter name | Data type | Description |
---|---|---|
vo | Vo | id |
lang | language | |
candidates | List<MemberCandidate> | list of member candidates |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
void |
Example URL
https://[hostname]/krb/rpc/json/registrarManager/inviteMemberCandidates
Example params
{ "vo" : { "id" : 123 , "name" : "My testing VO" , "shortName" : "test_vo" , "beanName" : "Vo" } , "lang" : {...} , "candidates" : [ { "candidate" : { "id" : 0 , "serviceUser" : false , "firstName" : "Random" , "lastName" : "Name" , "middleName" : null , "titleBefore" : "Dr." , "titleAfter" : null , userExtSource : { "userId": 34 , "loa" : 0 , "extSource" : { "name" : "PERUNPEOPLE" , "type" : "cz.metacentrum.perun.core.impl.ExtSourceSql" , "attributes" : {} , "id" : 2 , "beanName" : "ExtSource" } , "login" : "my_login" , "persistent" : true , "id" : 312 , "lastAccess" : "2019-06-10 14:07:42.2767" , "beanName" : "UserExtSource" } , additionalUserExtSources : null , attributes : { "urn:perun:member:attribute-def:def:organization" : "Masarykova univerzita" , "urn:perun:member:attribute-def:def:mail" : "random@name.cz" } } , "member" : { "id" : 12 , "userId" : 34 , "voId" : 42 , "sourceGroupId" : null , "membershipType" : "DIRECT" , "status" : "VALID" , "sponsored" : false , "beanName" : "Member" } , "richUser" : { "firstName" : "Some" , "lastName" : "Body" , "middleName" : null , "titleBefore" : "Mgr." , "titleAfter" : null , "serviceUser" : false , "sponsoredUser" : false , "specificUser" : false , "majorSpecificType" : "NORMAL" , "id" : 34 , "uuid" : "5e5a02dd-f991-4706-a428-69c3ea6c5ce8" , "beanName" : "RichUser" , "userExtSources" : [ { "userId": 34 , "loa" : 0 , "extSource" : { "name" : "PERUNPEOPLE" , "type" : "cz.metacentrum.perun.core.impl.ExtSourceSql" , "attributes" : {} , "id" : 2 , "beanName" : "ExtSource" } , "login" : "my_login" , "persistent" : true , "id" : 312 , "lastAccess" : "2019-06-10 14:07:42.2767" , "beanName" : "UserExtSource" } , {...} , {...} ], "userAttributes" : [ { "value" : "my_login" , "type" : "java.lang.String" , "entity" : "user" , "namespace" : "urn:perun:user:attribute-def:def" , "friendlyName" : "login-namespace:perun" , "writable" : true , "baseFriendlyName" : "login-namespace" , "friendlyNameParameter" : "perun" , "unique" : false , "displayName" : "Login in namespace: perun" , "description" : "Logname in namespace 'perun'." , "id" : 1905 , "beanName" : "Attribute" } ] } } , {...} , {...} ] }
Example response
null
Invite member candidates to group. If candidate contains richUser, then his preferred mail is retrieved and used, otherwise email must be passed in candidate's attributes.
Parameter name | Data type | Description |
---|---|---|
vo | Vo | id |
lang | language | |
candidates | List<MemberCandidate> | list of member candidates |
group | Group | id |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
void |
Example URL
https://[hostname]/krb/rpc/json/registrarManager/inviteMemberCandidates
Example params
{ "vo" : { "id" : 123 , "name" : "My testing VO" , "shortName" : "test_vo" , "beanName" : "Vo" } , "lang" : {...} , "candidates" : [ { "candidate" : { "id" : 0 , "serviceUser" : false , "firstName" : "Random" , "lastName" : "Name" , "middleName" : null , "titleBefore" : "Dr." , "titleAfter" : null , userExtSource : { "userId": 34 , "loa" : 0 , "extSource" : { "name" : "PERUNPEOPLE" , "type" : "cz.metacentrum.perun.core.impl.ExtSourceSql" , "attributes" : {} , "id" : 2 , "beanName" : "ExtSource" } , "login" : "my_login" , "persistent" : true , "id" : 312 , "lastAccess" : "2019-06-10 14:07:42.2767" , "beanName" : "UserExtSource" } , additionalUserExtSources : null , attributes : { "urn:perun:member:attribute-def:def:organization" : "Masarykova univerzita" , "urn:perun:member:attribute-def:def:mail" : "random@name.cz" } } , "member" : { "id" : 12 , "userId" : 34 , "voId" : 42 , "sourceGroupId" : null , "membershipType" : "DIRECT" , "status" : "VALID" , "sponsored" : false , "beanName" : "Member" } , "richUser" : { "firstName" : "Some" , "lastName" : "Body" , "middleName" : null , "titleBefore" : "Mgr." , "titleAfter" : null , "serviceUser" : false , "sponsoredUser" : false , "specificUser" : false , "majorSpecificType" : "NORMAL" , "id" : 34 , "uuid" : "5e5a02dd-f991-4706-a428-69c3ea6c5ce8" , "beanName" : "RichUser" , "userExtSources" : [ { "userId": 34 , "loa" : 0 , "extSource" : { "name" : "PERUNPEOPLE" , "type" : "cz.metacentrum.perun.core.impl.ExtSourceSql" , "attributes" : {} , "id" : 2 , "beanName" : "ExtSource" } , "login" : "my_login" , "persistent" : true , "id" : 312 , "lastAccess" : "2019-06-10 14:07:42.2767" , "beanName" : "UserExtSource" } , {...} , {...} ], "userAttributes" : [ { "value" : "my_login" , "type" : "java.lang.String" , "entity" : "user" , "namespace" : "urn:perun:user:attribute-def:def" , "friendlyName" : "login-namespace:perun" , "writable" : true , "baseFriendlyName" : "login-namespace" , "friendlyNameParameter" : "perun" , "unique" : false , "displayName" : "Login in namespace: perun" , "description" : "Logname in namespace 'perun'." , "id" : 1905 , "beanName" : "Attribute" } ] } } , {...} , {...} ] , "group" : { "id" : 1061 , "name" : "My group" , "shortName" : "My group" , "description" : "My testing group" , "parentGroupId" : null , "voId" : 201 , "uuid" : "31e1014b-e994-4cb2-b238-e32aeef87670" , "beanName" : "Group" } }
Example response
null
Checks if invitation via notification is enabled (invitation notification exists, application form exists and application form can be submitted)
Parameter name | Data type | Description |
---|---|---|
vo | Vo | id |
group | Group | id |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
true | if invitation notification exists, application form exists and application form can be submitted |
Example URL
https://[hostname]/krb/rpc/json/registrarManager/isInvitationEnabled
Example params
{ "vo" : { "id" : 123 , "name" : "My testing VO" , "shortName" : "test_vo" , "beanName" : "Vo" } , "group" : { "id" : 1061 , "name" : "My group" , "shortName" : "My group" , "description" : "My testing group" , "parentGroupId" : null , "voId" : 201 , "uuid" : "31e1014b-e994-4cb2-b238-e32aeef87670" , "beanName" : "Group" } }
Example response
{ ... TODO ... }
Checks if invitation via link is enabled (application form exists and application form can be submitted)
Parameter name | Data type | Description |
---|---|---|
vo | Vo | id |
group | Group | id |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
true | if application form exists and application form can be submitted |
Example URL
https://[hostname]/krb/rpc/json/registrarManager/isLinkInvitationEnabled
Example params
{ "vo" : { "id" : 123 , "name" : "My testing VO" , "shortName" : "test_vo" , "beanName" : "Vo" } , "group" : { "id" : 1061 , "name" : "My group" , "shortName" : "My group" , "description" : "My testing group" , "parentGroupId" : null , "voId" : 201 , "uuid" : "31e1014b-e994-4cb2-b238-e32aeef87670" , "beanName" : "Group" } }
Example response
{ ... TODO ... }
Checks if pre-approved invitation via notification is enabled (pre-approved invitation notification exists, application form exists and application form can be submitted)
Parameter name | Data type | Description |
---|---|---|
vo | Vo | id |
group | Group | id |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
true | if pre-approved invitation notification exists, application form exists and application form can be submitted |
Example URL
https://[hostname]/krb/rpc/json/registrarManager/isPreApprovedInvitationEnabled
Example params
{ "vo" : { "id" : 123 , "name" : "My testing VO" , "shortName" : "test_vo" , "beanName" : "Vo" } , "group" : { "id" : 1061 , "name" : "My group" , "shortName" : "My group" , "description" : "My testing group" , "parentGroupId" : null , "voId" : 201 , "uuid" : "31e1014b-e994-4cb2-b238-e32aeef87670" , "beanName" : "Group" } }
Example response
{ ... TODO ... }
Manually rejects an application. Expected to be called as a result of direct VO administrator action in the web UI.
Parameter name | Data type | Description |
---|---|---|
id | int | Application id |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
Application | Rejected application |
Example URL
https://[hostname]/krb/rpc/json/registrarManager/rejectApplication
Example params
{ "id" : 42 }
Example response
{ "id" : 12 , "vo" : { "id" : 123 , "name" : "My testing VO" , "shortName" : "test_vo" , "beanName" : "Vo" } , "type" : "INITIAL" , "fedInfo" : "" , "state" : "NEW" , "autoApproveError" : null , "extSourceName" : "PERUNPEOPLE" , "extSourceType" : "cz.metacentrum.perun.core.impl.ExtSourceSql" , "user" : { "firstName" : "Some" , "lastName" : "Body" , "middleName" : null , "titleBefore" : "Mgr." , "titleAfter" : null , "serviceUser" : false , "sponsoredUser" : false , "specificUser" : false , "majorSpecificType" : "NORMAL" , "id" : 34 , "uuid" : "5e5a02dd-f991-4706-a428-69c3ea6c5ce8" , "beanName" : "User" }, "beanName" : "Application" }
Manually rejects an application with a reason. Expected to be called as a result of direct VO administrator action in the web UI.
Parameter name | Data type | Description |
---|---|---|
id | int | Application id |
reason | String | Reason description |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
Application | Rejected application |
Example URL
https://[hostname]/krb/rpc/json/registrarManager/rejectApplication
Example params
{ "id" : 86 , "reason" : "text" }
Example response
{ "id" : 12 , "vo" : { "id" : 123 , "name" : "My testing VO" , "shortName" : "test_vo" , "beanName" : "Vo" } , "type" : "INITIAL" , "fedInfo" : "" , "state" : "NEW" , "autoApproveError" : null , "extSourceName" : "PERUNPEOPLE" , "extSourceType" : "cz.metacentrum.perun.core.impl.ExtSourceSql" , "user" : { "firstName" : "Some" , "lastName" : "Body" , "middleName" : null , "titleBefore" : "Mgr." , "titleAfter" : null , "serviceUser" : false , "sponsoredUser" : false , "specificUser" : false , "majorSpecificType" : "NORMAL" , "id" : 34 , "uuid" : "5e5a02dd-f991-4706-a428-69c3ea6c5ce8" , "beanName" : "User" }, "beanName" : "Application" }
Manually rejects multiple applications at once. Expected to be called as a result of direct VO administrator action in the web UI.
Parameter name | Data type | Description |
---|---|---|
ids | int[] | List of Application IDs |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
void |
Example URL
https://[hostname]/krb/rpc/json/registrarManager/rejectApplications
Example params
{ "ids" : [ 14 , 28 ] }
Example response
null
Manually rejects multiple applications at once with a reason. Expected to be called as a result of direct VO administrator action in the web UI.
Parameter name | Data type | Description |
---|---|---|
ids | int[] | List of Application IDs |
reason | String | Reason description |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
list | of ApplicationOperationResult |
Example URL
https://[hostname]/krb/rpc/json/registrarManager/rejectApplications
Example params
{ "ids" : [ 97 , 43 ] , "reason" : "text" }
Example response
{ ... TODO ... }
Sends invitation email to user which is not member of VO
Parameter name | Data type | Description |
---|---|---|
userId | int | id of user to send invitation to |
voId | int | id of VO to send invitation into |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
void |
Example URL
https://[hostname]/krb/rpc/json/registrarManager/sendInvitation
Example params
{ "userId" : 91 , "voId" : 82 }
Example response
null
Sends invitation email to user which is not member of Group If user is not even member of VO, invitation link targets VO application form fist, after submission, Group application form is displayed.
Parameter name | Data type | Description |
---|---|---|
userId | int | id of user to send invitation to |
voId | int | id of VO to send invitation into |
groupId | int | id of Group to send invitation into |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
void |
Example URL
https://[hostname]/krb/rpc/json/registrarManager/sendInvitation
Example params
{ "userId" : 75 , "voId" : 76 , "groupId" : 77 }
Example response
null
Sends invitation email to user which is not member of VO
Parameter name | Data type | Description |
---|---|---|
voId | int | id of VO to send invitation into |
name | String | name of person used in invitation email (optional) |
String | email address to send invitation to | |
language | String | preferred language to use |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
void |
Example URL
https://[hostname]/krb/rpc/json/registrarManager/sendInvitation
Example params
{ "voId" : 50 , "name" : "text" , "email" : "text" , "language" : "text" }
Example response
null
Sends invitation email to user which is not member of VO and Group Invitation link targets VO application form fist, after submission, Group application form is displayed.
Parameter name | Data type | Description |
---|---|---|
voId | int | id of VO to send invitation into |
groupId | int | id of Group to send invitation into |
name | String | name of person used in invitation email (optional) |
String | email address to send invitation to | |
language | String | preferred language to use |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
void |
Example URL
https://[hostname]/krb/rpc/json/registrarManager/sendInvitation
Example params
{ "voId" : 86 , "groupId" : 6 , "name" : "text" , "email" : "text" , "language" : "text" }
Example response
null
Send invitations with link to VO / Group application form from provided csv data If VO or Group have non-empty attribute urn:perun:[vo/group]:attribute-def:def:applicationURL content is used as link to application form. Otherwise link is automatically generated based on required AUTHZ in template and registrar url set in /etc/perun/perun-registrar.properties. General errors result in exception being thrown, single failures are skipped and added to result
Parameter name | Data type | Description |
---|---|---|
invitationData | csv | file values separated by semicolon ';'. Only [email; name] or [email] is valid format. |
voId | int | id of VO to send invitation into |
groupId | int | id of Group to send invitation into |
language | String | Language used in notification (if not specified, VO settings is used, if not set, "en" is used). |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
s | GroupNotExistsException |
s | PrivilegeException |
s | RegistrarException |
s | VoNotExistsException |
Return type | Description |
---|---|
Map | of {firstValue (should be email) : result}. Result can be 'OK' or 'ERROR: |
Example URL
https://[hostname]/krb/rpc/json/registrarManager/sendInvitationsFromCsv
Example params
{ "invitationData" : ["mail@mail.cz", "mail2@mail.cz;user2"] , "voId" : 8 , "groupId" : 63 , "language" : "text" }
Example response
{ ... TODO ... }
Re-send mail notification for existing application. Message of specified type is sent only, when application is in expected state related to the notification. Note, that some data related to processing application are not available (e.g. list of exceptions during approval), since this method doesn't perform any action with Application itself. Perun admin can send any notification except USER_INVITE type, see #sendInvitation() for this.
Parameter name | Data type | Description |
---|---|---|
mailType | MailType | type of mail notification |
appId | int | id of application to send notification for |
reason | String | you can specify reason for case: mailType == APP_REJECTED_USER |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
s | ApplicationNotCreatedException if message of type MAIL_VERIFICATION and application is no longer 'NEW' |
s | RegistrarException if notification can't be sent |
Return type | Description |
---|---|
void |
Example URL
https://[hostname]/krb/rpc/json/registrarManager/sendMessage
Example params
{ "mailType" : {...} , "appId" : 28 , "reason" : "text" }
Example response
null
Manually re-send multiple notifications at once. Expected to be called as a result of direct VO administrator action in the web UI.
Parameter name | Data type | Description |
---|---|---|
ids | int[] | List of Application IDs |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
void |
Example URL
https://[hostname]/krb/rpc/json/registrarManager/sendMessages
Example params
{ "ids" : [ 90 , 76 ] }
Example response
null
Enable or disable sending for list of mail definitions.
Parameter name | Data type | Description |
---|---|---|
mails | List<ApplicationMail> | Mail definitions to update |
enabled | boolean | true for enabled, false for disabled |
Thrown exception | Description |
---|---|
ApplicationMailNotExistsException | When application mail does not exist |
ApplicationMailTextMissingException | When trying to update application mail with text not filled for any locale |
FormNotExistsException | When application form related to the mail template not exists |
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
PrivilegeException | When caller is not authorized |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
Object | Always null |
Example URL
https://[hostname]/krb/rpc/json/registrarManager/setSendingEnabled
Example params
{ "mails" : {...} , "enabled" : true }
Example response
{ ... TODO ... }
Creates a new application. The method triggers approval for VOs with auto-approved applications.
Parameter name | Data type | Description |
---|---|---|
app | Application | Application JSON object |
data | List<ApplicationFormItemData> | List of ApplicationFormItemData JSON objects |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
Application | Submitted application |
Example URL
https://[hostname]/krb/rpc/json/registrarManager/submitApplication
Example params
{ "app" : { "id" : 12 , "vo" : { "id" : 123 , "name" : "My testing VO" , "shortName" : "test_vo" , "beanName" : "Vo" } , "type" : "INITIAL" , "fedInfo" : "" , "state" : "NEW" , "autoApproveError" : null , "extSourceName" : "PERUNPEOPLE" , "extSourceType" : "cz.metacentrum.perun.core.impl.ExtSourceSql" , "user" : { "firstName" : "Some" , "lastName" : "Body" , "middleName" : null , "titleBefore" : "Mgr." , "titleAfter" : null , "serviceUser" : false , "sponsoredUser" : false , "specificUser" : false , "majorSpecificType" : "NORMAL" , "id" : 34 , "uuid" : "5e5a02dd-f991-4706-a428-69c3ea6c5ce8" , "beanName" : "User" }, "beanName" : "Application" } , "data" : [ { "id" : 12 , "forItem" : { "id" : 12 , "shortname" : "Form item name' , "required" : false , "updatable" : true , "type" : "CHECKBOX" , "federationAttribute" : "" , "perunSourceAttribute" : "PERUNPEOPLE" , "perunDestinationAttribute" : "", "regex" : "", "applicationTypes" : ["INITIAL" , "EXTENSION"], "ordnum" : 5, "hiddenDependencyItemId" : 5, "disabledDependencyItemId" : 5, "disabled" : "NEVER", "hidden" : "NEVER", "beanName" : "ApplicationFormItem" } , "shortName" : "form data name" , "value" : "test value" , "assuranceLevel" : "0" , "beanName" : "ApplicationFormItemData" } , {...} , {...} ] }
Example response
{ "id" : 12 , "vo" : { "id" : 123 , "name" : "My testing VO" , "shortName" : "test_vo" , "beanName" : "Vo" } , "type" : "INITIAL" , "fedInfo" : "" , "state" : "NEW" , "autoApproveError" : null , "extSourceName" : "PERUNPEOPLE" , "extSourceType" : "cz.metacentrum.perun.core.impl.ExtSourceSql" , "user" : { "firstName" : "Some" , "lastName" : "Body" , "middleName" : null , "titleBefore" : "Mgr." , "titleAfter" : null , "serviceUser" : false , "sponsoredUser" : false , "specificUser" : false , "majorSpecificType" : "NORMAL" , "id" : 34 , "uuid" : "5e5a02dd-f991-4706-a428-69c3ea6c5ce8" , "beanName" : "User" }, "beanName" : "Application" }
Creates a new application from pre-approved invitation. The method triggers approval for VOs with auto-approved applications.
Parameter name | Data type | Description |
---|---|---|
app | Application | Application JSON object |
data | List<ApplicationFormItemData> | List of ApplicationFormItemData JSON objects |
token | uuid | corresponding to pre-approved invitation |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
Application | Submitted application |
Example URL
https://[hostname]/krb/rpc/json/registrarManager/submitApplication
Example params
{ "app" : { "id" : 12 , "vo" : { "id" : 123 , "name" : "My testing VO" , "shortName" : "test_vo" , "beanName" : "Vo" } , "type" : "INITIAL" , "fedInfo" : "" , "state" : "NEW" , "autoApproveError" : null , "extSourceName" : "PERUNPEOPLE" , "extSourceType" : "cz.metacentrum.perun.core.impl.ExtSourceSql" , "user" : { "firstName" : "Some" , "lastName" : "Body" , "middleName" : null , "titleBefore" : "Mgr." , "titleAfter" : null , "serviceUser" : false , "sponsoredUser" : false , "specificUser" : false , "majorSpecificType" : "NORMAL" , "id" : 34 , "uuid" : "5e5a02dd-f991-4706-a428-69c3ea6c5ce8" , "beanName" : "User" }, "beanName" : "Application" } , "data" : [ { "id" : 12 , "forItem" : { "id" : 12 , "shortname" : "Form item name' , "required" : false , "updatable" : true , "type" : "CHECKBOX" , "federationAttribute" : "" , "perunSourceAttribute" : "PERUNPEOPLE" , "perunDestinationAttribute" : "", "regex" : "", "applicationTypes" : ["INITIAL" , "EXTENSION"], "ordnum" : 5, "hiddenDependencyItemId" : 5, "disabledDependencyItemId" : 5, "disabled" : "NEVER", "hidden" : "NEVER", "beanName" : "ApplicationFormItem" } , "shortName" : "form data name" , "value" : "test value" , "assuranceLevel" : "0" , "beanName" : "ApplicationFormItemData" } , {...} , {...} ] , "token" : {...} }
Example response
{ "id" : 12 , "vo" : { "id" : 123 , "name" : "My testing VO" , "shortName" : "test_vo" , "beanName" : "Vo" } , "type" : "INITIAL" , "fedInfo" : "" , "state" : "NEW" , "autoApproveError" : null , "extSourceName" : "PERUNPEOPLE" , "extSourceType" : "cz.metacentrum.perun.core.impl.ExtSourceSql" , "user" : { "firstName" : "Some" , "lastName" : "Body" , "middleName" : null , "titleBefore" : "Mgr." , "titleAfter" : null , "serviceUser" : false , "sponsoredUser" : false , "specificUser" : false , "majorSpecificType" : "NORMAL" , "id" : 34 , "uuid" : "5e5a02dd-f991-4706-a428-69c3ea6c5ce8" , "beanName" : "User" }, "beanName" : "Application" }
Updates an e-mail notification.
Parameter name | Data type | Description |
---|---|---|
ApplicationMail | ApplicationMail JSON object |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
Object | Always null |
Example URL
https://[hostname]/krb/rpc/json/registrarManager/updateApplicationMail
Example params
{ "mail" : {...} }
Example response
{ ... TODO ... }
Updates the form attributes, not the form items. - update automatic approval style - update module_names
Parameter name | Data type | Description |
---|---|---|
form | ApplicationForm | Application form JSON object |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
ApplicationForm | Updated application form or null when update failed |
Example URL
https://[hostname]/krb/rpc/json/registrarManager/updateForm
Example params
{ "form" : { "id" : 12 , "vo" : { "id" : 123 , "name" : "My testing VO" , "shortName" : "test_vo" , "beanName" : "Vo" } , "automaticApproval" : true , "automaticApprovalExtension" : true , "moduleClassName" : "cz.metacentrum.perun.core.impl.modules.attributes.VirtualAttributesModule" , "beanName" : "ApplicationForm" } }
Example response
{ "id" : 12 , "vo" : { "id" : 123 , "name" : "My testing VO" , "shortName" : "test_vo" , "beanName" : "Vo" } , "automaticApproval" : true , "automaticApprovalExtension" : true , "moduleClassName" : "cz.metacentrum.perun.core.impl.modules.attributes.VirtualAttributesModule" , "beanName" : "ApplicationForm" }
Update data of specific application form item, which was originally submitted by the user. Only PerunAdmin can use this. Only applications in NEW or VERIFIED state can have form items updated. Form items of types: USERNAME, PASSWORD, HEADING, HTML_COMMENT, SUBMIT_BUTTON and AUTO_SUBMIT_BUTTON are not updatable by this method.
Parameter name | Data type | Description |
---|---|---|
appId | int | ID of Application this data belongs to. |
data | ApplicationFormItemData | Form item data to be updated by its ID. |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
void |
Example URL
https://[hostname]/krb/rpc/json/registrarManager/updateFormItemData
Example params
{ "appId" : 13 , "data" : { "id" : 12 , "forItem" : { "id" : 12 , "shortname" : "Form item name' , "required" : false , "updatable" : true , "type" : "CHECKBOX" , "federationAttribute" : "" , "perunSourceAttribute" : "PERUNPEOPLE" , "perunDestinationAttribute" : "", "regex" : "", "applicationTypes" : ["INITIAL" , "EXTENSION"], "ordnum" : 5, "hiddenDependencyItemId" : 5, "disabledDependencyItemId" : 5, "disabled" : "NEVER", "hidden" : "NEVER", "beanName" : "ApplicationFormItem" } , "shortName" : "form data name" , "value" : "test value" , "assuranceLevel" : "0" , "beanName" : "ApplicationFormItemData" } }
Example response
null
Update label, options, help and error message for specified form item and locale. FormItem is specified by its ID.
Parameter name | Data type | Description |
---|---|---|
formItem | ApplicationFormItem | Form item to update |
locale | String | Locale specified like: cs, en, ... |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
void |
Example URL
https://[hostname]/krb/rpc/json/registrarManager/updateFormItemTexts
Example params
{ "formItem" : { "id" : 12 , "shortname" : "Form item name' , "required" : false , "updatable" : true , "type" : "CHECKBOX" , "federationAttribute" : "" , "perunSourceAttribute" : "PERUNPEOPLE" , "perunDestinationAttribute" : "", "regex" : "", "applicationTypes" : ["INITIAL" , "EXTENSION"], "ordnum" : 5, "hiddenDependencyItemId" : 5, "disabledDependencyItemId" : 5, "disabled" : "NEVER", "hidden" : "NEVER", "beanName" : "ApplicationFormItem" } , "locale" : "text" }
Example response
null
Replace label, options, help and error message for specified form item and all locales by current value. FormItem is specified by its ID.
Parameter name | Data type | Description |
---|---|---|
formItem | ApplicationFormItem | Form item to update |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
void |
Example URL
https://[hostname]/krb/rpc/json/registrarManager/updateFormItemTexts
Example params
{ "formItem" : { "id" : 12 , "shortname" : "Form item name' , "required" : false , "updatable" : true , "type" : "CHECKBOX" , "federationAttribute" : "" , "perunSourceAttribute" : "PERUNPEOPLE" , "perunDestinationAttribute" : "", "regex" : "", "applicationTypes" : ["INITIAL" , "EXTENSION"], "ordnum" : 5, "hiddenDependencyItemId" : 5, "disabledDependencyItemId" : 5, "disabled" : "NEVER", "hidden" : "NEVER", "beanName" : "ApplicationFormItem" } }
Example response
null
Updates form items sent in list.
Parameter name | Data type | Description |
---|---|---|
vo | int | VO id |
items | List<ApplicationFormItem> | Application form items |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
int | Number of updated items |
Example URL
https://[hostname]/krb/rpc/json/registrarManager/updateFormItems
Example params
{ "vo" : 16 , "items" : [ { "id" : 12 , "shortname" : "Form item name' , "required" : false , "updatable" : true , "type" : "CHECKBOX" , "federationAttribute" : "" , "perunSourceAttribute" : "PERUNPEOPLE" , "perunDestinationAttribute" : "", "regex" : "", "applicationTypes" : ["INITIAL" , "EXTENSION"], "ordnum" : 5, "hiddenDependencyItemId" : 5, "disabledDependencyItemId" : 5, "disabled" : "NEVER", "hidden" : "NEVER", "beanName" : "ApplicationFormItem" } , {...} , {...} ] }
Example response
19
Updates form items sent in list.
Parameter name | Data type | Description |
---|---|---|
group | int | Group id |
items | List<ApplicationFormItem> | Application form items |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
int | Number of updated items |
Example URL
https://[hostname]/krb/rpc/json/registrarManager/updateFormItems
Example params
{ "group" : 56 , "items" : [ { "id" : 12 , "shortname" : "Form item name' , "required" : false , "updatable" : true , "type" : "CHECKBOX" , "federationAttribute" : "" , "perunSourceAttribute" : "PERUNPEOPLE" , "perunDestinationAttribute" : "", "regex" : "", "applicationTypes" : ["INITIAL" , "EXTENSION"], "ordnum" : 5, "hiddenDependencyItemId" : 5, "disabledDependencyItemId" : 5, "disabled" : "NEVER", "hidden" : "NEVER", "beanName" : "ApplicationFormItem" } , {...} , {...} ] }
Example response
48
Update data of application form items, which were originally submitted by the user. Only user who submitted the application can use this. Only applications in NEW or VERIFIED state can have form items updated. Form items of types: USERNAME, PASSWORD, HEADING, HTML_COMMENT, SUBMIT_BUTTON and AUTO_SUBMIT_BUTTON are not updatable by this method. If VALIDATED_EMAIL is changed to non-verified value, it will change application state from VERIFIED to NEW and trigger new verification and auto approval (if possible).
Parameter name | Data type | Description |
---|---|---|
appId | int | ID of Application this data belongs to. |
data | List<ApplicationFormItemData> | Form items data to be updated by their IDs. |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
void |
Example URL
https://[hostname]/krb/rpc/json/registrarManager/updateFormItemsData
Example params
{ "appId" : 79 , "data" : [ { "id" : 12 , "forItem" : { "id" : 12 , "shortname" : "Form item name' , "required" : false , "updatable" : true , "type" : "CHECKBOX" , "federationAttribute" : "" , "perunSourceAttribute" : "PERUNPEOPLE" , "perunDestinationAttribute" : "", "regex" : "", "applicationTypes" : ["INITIAL" , "EXTENSION"], "ordnum" : 5, "hiddenDependencyItemId" : 5, "disabledDependencyItemId" : 5, "disabled" : "NEVER", "hidden" : "NEVER", "beanName" : "ApplicationFormItem" } , "shortName" : "form data name" , "value" : "test value" , "assuranceLevel" : "0" , "beanName" : "ApplicationFormItemData" } , {...} , {...} ] }
Example response
null
Validates an email. This method should receive all URL parameters from a URL sent by an email to validate the email address that was provided by a user. The parameters describe the user, application, email and contain a message authentication code to prevent spoofing.
Parameter name | Data type | Description |
---|---|---|
m | String | Parameter m |
i | String | Parameter i |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
boolean | True for validated, false for non-valid |
Example URL
https://[hostname]/krb/rpc/json/registrarManager/validateEmail
Example params
{ "m" : "text" , "i" : "text" }
Example response
true
Forcefully marks application as verified (only when application was in NEW state)
Parameter name | Data type | Description |
---|---|---|
id | int | Application id |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
Application | Verified application |
Example URL
https://[hostname]/krb/rpc/json/registrarManager/verifyApplication
Example params
{ "id" : 69 }
Example response
{ "id" : 12 , "vo" : { "id" : 123 , "name" : "My testing VO" , "shortName" : "test_vo" , "beanName" : "Vo" } , "type" : "INITIAL" , "fedInfo" : "" , "state" : "NEW" , "autoApproveError" : null , "extSourceName" : "PERUNPEOPLE" , "extSourceType" : "cz.metacentrum.perun.core.impl.ExtSourceSql" , "user" : { "firstName" : "Some" , "lastName" : "Body" , "middleName" : null , "titleBefore" : "Mgr." , "titleAfter" : null , "serviceUser" : false , "sponsoredUser" : false , "specificUser" : false , "majorSpecificType" : "NORMAL" , "id" : 34 , "uuid" : "5e5a02dd-f991-4706-a428-69c3ea6c5ce8" , "beanName" : "User" }, "beanName" : "Application" }
Verify Captcha answer.
Parameter name | Data type | Description |
---|---|---|
response | String | User response |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
boolean | True if it is valid, False if failed |
Example URL
https://[hostname]/krb/rpc/json/registrarManager/verifyCaptcha
Example params
{ "response" : "text" }
Example response
true