RPC API documentation v17.2.0

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

ExtSourcesManager

Associate an external source definition with a VO.

Parameter nameData typeDescription
vointVO id
sourceintExtSource id
Thrown exceptionDescription
InternalErrorExceptionWhen unspecified error occur. See exception param message for explanation.
PrivilegeExceptionWhen caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values.
RpcExceptionWrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation.
Return typeDescription
void

Example URL

https://[hostname]/krb/rpc/json/extSourcesManager/addExtSource

Example params

{ "vo" : 51 , "source" : 34 }

Example response

null

Associate an external source definition with a GROUP.

Parameter nameData typeDescription
groupintGROUP id
sourceintExtSource id
Thrown exceptionDescription
InternalErrorExceptionWhen unspecified error occur. See exception param message for explanation.
PrivilegeExceptionWhen caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values.
RpcExceptionWrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation.
Return typeDescription
void

Example URL

https://[hostname]/krb/rpc/json/extSourcesManager/addExtSource

Example params

{ "group" : 60 , "source" : 69 }

Example response

null

Creates an external source. ExtSource object must contain: name, type. Other parameters are ignored.

Parameter nameData typeDescription
extSourceExtSourceJSON object
Thrown exceptionDescription
InternalErrorExceptionWhen unspecified error occur. See exception param message for explanation.
PrivilegeExceptionWhen caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values.
RpcExceptionWrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation.
Return typeDescription
ExtSourceCreated ExtSource

Example URL

https://[hostname]/krb/rpc/json/extSourcesManager/createExtSource

Example params

{ "extSource" : { "name" : "PERUNPEOPLE" , "type" : "cz.metacentrum.perun.core.impl.ExtSourceSql" , "attributes" : {} , "id" : 2 , "beanName" : "ExtSource" } }

Example response

{ "name" : "PERUNPEOPLE" , "type" : "cz.metacentrum.perun.core.impl.ExtSourceSql" , "attributes" : {} , "id" : 2 , "beanName" : "ExtSource" }

Creates an external source.

Parameter nameData typeDescription
nameStringname of ExtSource
typeStringtype of ExtSource
Thrown exceptionDescription
InternalErrorExceptionWhen unspecified error occur. See exception param message for explanation.
PrivilegeExceptionWhen caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values.
RpcExceptionWrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation.
Return typeDescription
ExtSourceCreated ExtSource

Example URL

https://[hostname]/krb/rpc/json/extSourcesManager/createExtSource

Example params

{ "name" : "text" , "type" : "text" }

Example response

{ "name" : "PERUNPEOPLE" , "type" : "cz.metacentrum.perun.core.impl.ExtSourceSql" , "attributes" : {} , "id" : 2 , "beanName" : "ExtSource" }

Delete an external source.

Parameter nameData typeDescription
idintExtSource id
Thrown exceptionDescription
InternalErrorExceptionWhen unspecified error occur. See exception param message for explanation.
PrivilegeExceptionWhen caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values.
RpcExceptionWrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation.
Return typeDescription
void

Example URL

https://[hostname]/krb/rpc/json/extSourcesManager/deleteExtSource

Example params

{ "id" : 81 }

Example response

null

Returns an external source by its id.

Parameter nameData typeDescription
idintExtSource id
Thrown exceptionDescription
InternalErrorExceptionWhen unspecified error occur. See exception param message for explanation.
PrivilegeExceptionWhen caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values.
RpcExceptionWrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation.
Return typeDescription
ExtSourceFound ExtSource

Example URL

https://[hostname]/krb/rpc/json/extSourcesManager/getExtSourceById

Example params

{ "id" : 52 }

Example response

{ "name" : "PERUNPEOPLE" , "type" : "cz.metacentrum.perun.core.impl.ExtSourceSql" , "attributes" : {} , "id" : 2 , "beanName" : "ExtSource" }

Returns an external source by its name.

Parameter nameData typeDescription
nameStringExtSource name
Thrown exceptionDescription
InternalErrorExceptionWhen unspecified error occur. See exception param message for explanation.
PrivilegeExceptionWhen caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values.
RpcExceptionWrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation.
Return typeDescription
ExtSourceFound ExtSource

Example URL

https://[hostname]/krb/rpc/json/extSourcesManager/getExtSourceByName

Example params

{ "name" : "text" }

Example response

{ "name" : "PERUNPEOPLE" , "type" : "cz.metacentrum.perun.core.impl.ExtSourceSql" , "attributes" : {} , "id" : 2 , "beanName" : "ExtSource" }

Returns the list of all external sources.

Thrown exceptionDescription
InternalErrorExceptionWhen unspecified error occur. See exception param message for explanation.
PrivilegeExceptionWhen caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values.
RpcExceptionWrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation.
Return typeDescription
List<ExtSource>all external sources

Example URL

https://[hostname]/krb/rpc/json/extSourcesManager/getExtSources

Example response

[ { "name" : "PERUNPEOPLE" , "type" : "cz.metacentrum.perun.core.impl.ExtSourceSql" , "attributes" : {} , "id" : 2 , "beanName" : "ExtSource" } , {...} , {...} ]

Returns the list of external sources associated with a GROUP.

Parameter nameData typeDescription
groupintGROUP id
Thrown exceptionDescription
InternalErrorExceptionWhen unspecified error occur. See exception param message for explanation.
PrivilegeExceptionWhen caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values.
RpcExceptionWrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation.
Return typeDescription
List<ExtSource>GROUP external sources

Example URL

https://[hostname]/krb/rpc/json/extSourcesManager/getGroupExtSources

Example params

{ "group" : 5 }

Example response

[ { "name" : "PERUNPEOPLE" , "type" : "cz.metacentrum.perun.core.impl.ExtSourceSql" , "attributes" : {} , "id" : 2 , "beanName" : "ExtSource" } , {...} , {...} ]

Returns the list of external sources associated with a VO.

Parameter nameData typeDescription
vointVO id
Thrown exceptionDescription
InternalErrorExceptionWhen unspecified error occur. See exception param message for explanation.
PrivilegeExceptionWhen caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values.
RpcExceptionWrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation.
Return typeDescription
List<ExtSource>VO external sources

Example URL

https://[hostname]/krb/rpc/json/extSourcesManager/getVoExtSources

Example params

{ "vo" : 56 }

Example response

[ { "name" : "PERUNPEOPLE" , "type" : "cz.metacentrum.perun.core.impl.ExtSourceSql" , "attributes" : {} , "id" : 2 , "beanName" : "ExtSource" } , {...} , {...} ]

Loads ext source definitions from the configuration file and updates entries stored in the DB.

Thrown exceptionDescription
InternalErrorExceptionWhen unspecified error occur. See exception param message for explanation.
PrivilegeExceptionWhen caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values.
RpcExceptionWrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation.
Return typeDescription
void

Example URL

https://[hostname]/krb/rpc/json/extSourcesManager/loadExtSourcesDefinitions

Example response

null

Remove an association of an external source from a VO.

Parameter nameData typeDescription
vointVO id
sourceintExtSource id
Thrown exceptionDescription
InternalErrorExceptionWhen unspecified error occur. See exception param message for explanation.
PrivilegeExceptionWhen caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values.
RpcExceptionWrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation.
Return typeDescription
void

Example URL

https://[hostname]/krb/rpc/json/extSourcesManager/removeExtSource

Example params

{ "vo" : 98 , "source" : 16 }

Example response

null

Remove an association of an external source from a GROUP.

Parameter nameData typeDescription
groupintGROUP id
sourceintExtSource id
Thrown exceptionDescription
InternalErrorExceptionWhen unspecified error occur. See exception param message for explanation.
PrivilegeExceptionWhen caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values.
RpcExceptionWrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation.
Return typeDescription
void

Example URL

https://[hostname]/krb/rpc/json/extSourcesManager/removeExtSource

Example params

{ "group" : 42 , "source" : 48 }

Example response

null