RPC API documentation v34.4.0

Add specific user owner (the user).

Example URL

https://[hostname]/krb/rpc/json/usersManager/addSpecificUserOwner

• see URL structure

Example params

{ "user" : 54 , "specificUser" : 94 }

• see Passing params

Example response

null

• see Return values
• see HTTP return codes

Adds user's external sources.

Example URL

https://[hostname]/krb/rpc/json/usersManager/addUserExtSource

• see URL structure

Example params

{ "user" : 84 , "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" } }

• see Passing params

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

• see Return values
• see HTTP return codes

Adds user's external source and its attributes.

Example URL

https://[hostname]/krb/rpc/json/usersManager/addUserExtSourceWithAttributes

• see URL structure

Example params

{ "user" : 64 , "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" } , "attributes" : [ { "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" } , {...} , {...} ] }

• see Passing params

Example response

{ ... TODO ... }

• see Return values
• see HTTP return codes

Anonymizes user - according to configuration, each of user's attributes is either anonymized, kept untouched or deleted. Also deletes other user's related data, e.g. authorships of users publications, mail change and password reset requests, bans... the anonymization process or if the anonymization is not supported at this instance.

Example URL

https://[hostname]/krb/rpc/json/usersManager/anonymizeUser

• see URL structure

Example params

{ "user" : 32 }

• see Passing params

Example response

null

• see Return values
• see HTTP return codes

Anonymizes user (force) - according to configuration, each of user's attributes is either anonymized, kept untouched or deleted. Also deletes other user's related data, e.g. authorships of users publications, mail change and password reset requests, bans... Also removes associated members. the anonymization process or if the anonymization is not supported at this instance.

Example URL

https://[hostname]/krb/rpc/json/usersManager/anonymizeUser

• see URL structure

Example params

{ "user" : 56 , "force" : true }

• see Passing params

Example response

null

• see Return values
• see HTTP return codes

Block logins for given namespace

Example URL

https://[hostname]/krb/rpc/json/usersManager/blockLogins

• see URL structure

Example params

{ "logins" : [ "text" , "text" ] , "namespace" : "text" }

• see Passing params

Example response

null

• see Return values
• see HTTP return codes

Block logins globally (for all namespaces)

Example URL

https://[hostname]/krb/rpc/json/usersManager/blockLogins

• see URL structure

Example params

{ "logins" : [ "text" , "text" ] }

• see Passing params

Example response

null

• see Return values
• see HTTP return codes

Changes user password in defined login-namespace. checkOldPassword is set to true.

Example URL

https://[hostname]/krb/rpc/json/usersManager/changePassword

• see URL structure

Example params

{ "login" : "text" , "namespace" : "text" , "newPassword" : "text" , "oldPassword" : "text" , "checkOldPassword" : true }

• see Passing params

Example response

null

• see Return values
• see HTTP return codes

Changes user password in defined login-namespace. checkOldPassword is set to true.

Example URL

https://[hostname]/krb/rpc/json/usersManager/changePassword

• see URL structure

Example params

{ "user" : 50 , "namespace" : "text" , "newPassword" : "text" , "oldPassword" : "text" , "checkOldPassword" : true }

• see Passing params

Example response

null

• see Return values
• see HTTP return codes

Generates new random password for given user and returns PDF file with information about the new password.

The HTML template is taken from entityless attribute randomPwdResetTemplate and the loginNamespace is used as a key.

Warning: No matter which serializer you specify, this method always returns .pdf file as an attachment.

Example URL

https://[hostname]/krb/rpc/json/usersManager/changePasswordRandom

• see URL structure

Example params

{ "userId" : {...} , "loginNamespace" : "text" }

• see Passing params

Example response

{ ... TODO ... }

• see Return values
• see HTTP return codes

Check password strength for the given namespace. If the password is too weak, the PasswordStrengthException is thrown

Example URL

https://[hostname]/krb/rpc/json/usersManager/checkPasswordStrength

• see URL structure

Example params

{ "password" : "text" , "namespace" : "text" }

• see Passing params

Example response

null

• see Return values
• see HTTP return codes

Check password strength for the given namespace. If the password is too weak, the PasswordStrengthException is thrown

Example URL

https://[hostname]/krb/rpc/json/usersManager/checkPasswordStrength

• see URL structure

Example params

{ "password" : "text" , "namespace" : "text" , "login" : "text" }

• see Passing params

Example response

null

• see Return values
• see HTTP return codes

Creates alternative password in external system.

Example URL

https://[hostname]/krb/rpc/json/usersManager/createAlternativePassword

• see URL structure

Example params

{ "user" : 83 , "description" : "text" , "loginNamespace" : "text" , "password" : "text" }

• see Passing params

Example response

null

• see Return values
• see HTTP return codes

From given candidate, creates a service user and assign given owners to him. This method also checks if some of given userExtSources do exist. If so, this method throws a UserExtSourceExistsException. This method can also set only user-def and user-opt attributes for the given candidate. some other attribute constraint

Example URL

https://[hostname]/krb/rpc/json/usersManager/createServiceUser

• see URL structure

Example params

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

• see Passing params

Example response

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

• see Return values
• see HTTP return codes

Deletes alternative password in external system.

Example URL

https://[hostname]/krb/rpc/json/usersManager/deleteAlternativePassword

• see URL structure

Example params

{ "user" : 5 , "loginNamespace" : "text" , "passwordId" : "text" }

• see Passing params

Example response

null

• see Return values
• see HTTP return codes

Delete password for a user in specified login-namespace.

Example URL

https://[hostname]/krb/rpc/json/usersManager/deletePassword

• see URL structure

Example params

{ "login" : "text" , "namespace" : "text" }

• see Passing params

Example response

null

• see Return values
• see HTTP return codes

Deletes a user. User is not deleted, if is member of any VO or is associated with any service identity. from DB

Example URL

https://[hostname]/krb/rpc/json/usersManager/deleteUser

• see URL structure

Example params

{ "user" : 97 }

• see Passing params

Example response

null

• see Return values
• see HTTP return codes

Deletes a user (force). Also removes associated members. from DB

Example URL

https://[hostname]/krb/rpc/json/usersManager/deleteUser

• see URL structure

Example params

{ "user" : 25 , "force" : true }

• see Passing params

Example response

null

• see Return values
• see HTTP return codes

Returns list of RichUsers with attributes who matches the searchString, searching name, id, uuid, email, logins.

Example URL

https://[hostname]/krb/rpc/json/usersManager/findRichUsers

• see URL structure

Example params

{ "searchString" : "text" }

• see Passing params

Example response

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

• see Return values
• see HTTP return codes

Returns list of RichUsers with attributes who matches the searchString

Example URL

https://[hostname]/krb/rpc/json/usersManager/findRichUsersWithAttributes

• see URL structure

Example params

{ "searchString" : "text" , "attrsNames" : [ "text" , "text" ] }

• see Passing params

Example response

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

• see Return values
• see HTTP return codes

Return list of RichUsers who matches the searchString and are not member in specific VO and with selected attributes.

Example URL

https://[hostname]/krb/rpc/json/usersManager/findRichUsersWithoutSpecificVoWithAttributes

• see URL structure

Example params

{ "vo" : {...} , "searchString" : "text" , "attrsName" : [ "text" , "text" ] }

• see Passing params

Example response

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

• see Return values
• see HTTP return codes

Returns list of users who matches the searchString, searching name, id, uuid, email, logins.

Example URL

https://[hostname]/krb/rpc/json/usersManager/findUsers

• see URL structure

Example params

{ "searchString" : "text" }

• see Passing params

Example response

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

• see Return values
• see HTTP return codes

Returns list of users who matches the searchString.

Example URL

https://[hostname]/krb/rpc/json/usersManager/findUsersByName

• see URL structure

Example params

{ "searchString" : "text" }

• see Passing params

Example response

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

• see Return values
• see HTTP return codes

Returns list of users who matches the parameters. All parameters must be present, even if empty.

Example URL

https://[hostname]/krb/rpc/json/usersManager/findUsersByName

• see URL structure

Example params

{ "titleBefore" : "text" , "firstName" : "text" , "middleName" : "text" , "lastName" : "text" , "titleAfter" : "text" }

• see Passing params

Example response

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

• see Return values
• see HTTP return codes

Generate user account in a backend system associated with login-namespace in Perun. This method consumes optional parameters map. Requirements are implementation-dependant for each login-namespace. Returns map with 1: key=login-namespace attribute urn, value=generated login 2: rest of opt response attributes...

Example URL

https://[hostname]/krb/rpc/json/usersManager/generateAccount

• see URL structure

Example params

{ "namespace" : "text" , "parameters" : {...} }

• see Passing params

Example response

{ ... TODO ... }

• see Return values
• see HTTP return codes

Generate user account in a backend system associated with login-namespace in Perun. Login-namespace might require more parameters, call this method with map of all parameters in a map then. Returns map with 1: key=login-namespace attribute urn, value=generated login 2: rest of opt response attributes...

Example URL

https://[hostname]/krb/rpc/json/usersManager/generateAccount

• see URL structure

Example params

{ "namespace" : "text" , "name" : "text" }

• see Passing params

Example response

{ ... TODO ... }

• see Return values
• see HTTP return codes

Returns all blocked logins in namespaces (if namespace is null, then this login is blocked globally)

Example URL

https://[hostname]/krb/rpc/json/usersManager/getAllBlockedLoginsInNamespaces

• see URL structure

Example response

{ ... TODO ... }

• see Return values
• see HTTP return codes

Get All richUsers with or without specificUsers.

Example URL

https://[hostname]/krb/rpc/json/usersManager/getAllRichUsers

• see URL structure

Example params

{ "includedSpecificUsers" : true }

• see Passing params

Example response

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

• see Return values
• see HTTP return codes

Get All richUsers with or without specificUsers.

Example URL

https://[hostname]/krb/rpc/json/usersManager/getAllRichUsersWithAttributes

• see URL structure

Example params

{ "includedSpecificUsers" : true }

• see Passing params

Example response

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

• see Return values
• see HTTP return codes

Get all resources from the facility which have the user access on.

Example URL

https://[hostname]/krb/rpc/json/usersManager/getAllowedResources

• see URL structure

Example params

{ "user" : 20 , "facility" : 45 }

• see Passing params

Example response

[ { "id" : 493 , "name" : "host1.host.cz" , "description" : "ROOT access to host1.host.cz" , "facilityId" : 24 , "voId" : 21 , "uuid" : "542d676f-99b2-4d1c-bc80-a46fd7f34e62" , "beanName" : "Resource" } , {...} , {...} ]

• see Return values
• see HTTP return codes

Get all resources which have the user access on.

Example URL

https://[hostname]/krb/rpc/json/usersManager/getAllowedResources

• see URL structure

Example params

{ "user" : 90 }

• see Passing params

Example response

[ { "id" : 493 , "name" : "host1.host.cz" , "description" : "ROOT access to host1.host.cz" , "facilityId" : 24 , "voId" : 21 , "uuid" : "542d676f-99b2-4d1c-bc80-a46fd7f34e62" , "beanName" : "Resource" } , {...} , {...} ]

• see Return values
• see HTTP return codes

Get all rich resources which have the user assigned.

Example URL

https://[hostname]/krb/rpc/json/usersManager/getAssignedRichResources

• see URL structure

Example params

{ "user" : 96 }

• see Passing params

Example response

[ { "id" : 493 , "name" : "host1.host.cz" , "description" : "ROOT access to host1.host.cz" , "facilityId" : 24 , "voId" : 123 , "uuid" : "542d676f-99b2-4d1c-bc80-a46fd7f34e62" , "beanName" : "RichResource" , "vo" : { "id" : 123 , "name" : "My testing VO" , "shortName" : "test_vo" , "beanName" : "Vo" }, "facility" : { "id" : 24 , "name" : "host.facility.cz" , "description" : "is optional" , "beanName" : "Facility" } , "resourceTags" : [ { "id" : 3 , "tagName" : "comp_cluster" , "voId" : 123 , "beanName" : "ResourceTag" } , {...} , {...} ] } , {...} , {...} ]

• see Return values
• see HTTP return codes

Return all resources of specified facility with which user is associated through all his members. Does not require ACTIVE group-resource assignment.

Example URL

https://[hostname]/krb/rpc/json/usersManager/getAssociatedResources

• see URL structure

Example params

{ "facility" : 62 , "user" : 52 }

• see Passing params

Example response

[ { "id" : 493 , "name" : "host1.host.cz" , "description" : "ROOT access to host1.host.cz" , "facilityId" : 24 , "voId" : 123 , "uuid" : "542d676f-99b2-4d1c-bc80-a46fd7f34e62" , "beanName" : "RichResource" , "vo" : { "id" : 123 , "name" : "My testing VO" , "shortName" : "test_vo" , "beanName" : "Vo" }, "facility" : { "id" : 24 , "name" : "host.facility.cz" , "description" : "is optional" , "beanName" : "Facility" } , "resourceTags" : [ { "id" : 3 , "tagName" : "comp_cluster" , "voId" : 123 , "beanName" : "ResourceTag" } , {...} , {...} ] } , {...} , {...} ]

• see Return values
• see HTTP return codes

Get a page of blocked logins

Example URL

https://[hostname]/krb/rpc/json/usersManager/getBlockedLoginsPage

• see URL structure

Example params

{ "query" : {...} }

• see Passing params

Example response

{ ... TODO ... }

• see Return values
• see HTTP return codes

Get list of groups of user on specified resource where use is active, that means User is a VALID in the VO and the Group and groups are assigned to the resource.

Example URL

https://[hostname]/krb/rpc/json/usersManager/getGroupsWhereUserIsActive

• see URL structure

Example params

{ "resource" : {...} , "user" : {...} }

• see Passing params

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

• see Return values
• see HTTP return codes

Get list of groups of user on specified resource where use is active, that means User is a VALID in the VO and the Group and groups are assigned to the facility.

Example URL

https://[hostname]/krb/rpc/json/usersManager/getGroupsWhereUserIsActive

• see URL structure

Example params

{ "facility" : {...} , "user" : {...} }

• see Passing params

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

• see Return values
• see HTTP return codes

Returns list of Groups in Perun, where the User is a direct Administrator or he is a VALID member of any group which is Administrator of some of these Groups.

Example URL

https://[hostname]/krb/rpc/json/usersManager/getGroupsWhereUserIsAdmin

• see URL structure

Example params

{ "user" : 98 }

• see Passing params

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

• see Return values
• see HTTP return codes

Returns list of Groups in selected Vo, where the User is a direct Administrator or he is a VALID member of any group which is Administrator of some of these Groups.

Example URL

https://[hostname]/krb/rpc/json/usersManager/getGroupsWhereUserIsAdmin

• see URL structure

Example params

{ "user" : 11 , "vo" : 42 }

• see Passing params

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

• see Return values
• see HTTP return codes

Return list of email addresses of user, which are awaiting validation and are inside time window for validation. If there is no preferred email change request pending or requests are outside time window for validation, returns empty list.

Example URL

https://[hostname]/krb/rpc/json/usersManager/getPendingPreferredEmailChanges

• see URL structure

Example params

{ "user" : 76 }

• see Passing params

Example response

{ ... TODO ... }

• see Return values
• see HTTP return codes

Get list of rich groups of user on specified resource with group attributes specified by the list of their names. Groups where user is active are returned, that means groups, where User is a VALID in the VO and the Group and groups are assigned to the resource.

Example URL

https://[hostname]/krb/rpc/json/usersManager/getRichGroupsWhereUserIsActive

• see URL structure

Example params

{ "resource" : {...} , "user" : {...} , "attrNames" : [ "text" , "text" ] }

• see Passing params

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" : "RichGroup" , "attributes" : [ { "value" : null , "type" : "java.lang.String" , "entity" : "group" , "namespace" : "urn:perun:group:attribute-def:def" , "friendlyName" : "synchronizationEnabled" , "writable" : true , "baseFriendlyName" : "synchronizationEnabled" , "friendlyNameParameter" : "" , "unique" : false , "displayName" : "Synchronization enabled" , "description" : "Enables group synchronization from external source." , "id" : 103 , "beanName" : "Attribute" } ] } , {...} , {...} ]

• see Return values
• see HTTP return codes

Get list of rich groups of user on specified resource with group attributes specified by the list of their names. Groups where user is active are returned, that means groups, where User is a VALID in the VO and the Group and groups are assigned to the facility.

Example URL

https://[hostname]/krb/rpc/json/usersManager/getRichGroupsWhereUserIsActive

• see URL structure

Example params

{ "facility" : {...} , "user" : {...} , "attrNames" : [ "text" , "text" ] }

• see Passing params

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" : "RichGroup" , "attributes" : [ { "value" : null , "type" : "java.lang.String" , "entity" : "group" , "namespace" : "urn:perun:group:attribute-def:def" , "friendlyName" : "synchronizationEnabled" , "writable" : true , "baseFriendlyName" : "synchronizationEnabled" , "friendlyNameParameter" : "" , "unique" : false , "displayName" : "Synchronization enabled" , "description" : "Enables group synchronization from external source." , "id" : 103 , "beanName" : "Attribute" } ] } , {...} , {...} ]

• see Return values
• see HTTP return codes

Get User to RichUser without attributes.

Example URL

https://[hostname]/krb/rpc/json/usersManager/getRichUser

• see URL structure

Example params

{ "user" : 78 }

• see Passing params

Example response

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

• see Return values
• see HTTP return codes

Gets list of all user's external sources with attributes.

Example URL

https://[hostname]/krb/rpc/json/usersManager/getRichUserExtSources

• see URL structure

Example params

{ "user" : 17 }

• see Passing params

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

• see Return values
• see HTTP return codes

Gets list of all user's external sources with specified attributes. If attrsNames is empty return no attributes. If attrsNames is null, this methods returns all attributes.

Example URL

https://[hostname]/krb/rpc/json/usersManager/getRichUserExtSources

• see URL structure

Example params

{ "user" : 2 , "attrsNames" : [ "text" , "text" ] }

• see Passing params

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

• see Return values
• see HTTP return codes

Get User to RichUser with attributes.

Example URL

https://[hostname]/krb/rpc/json/usersManager/getRichUserWithAttributes

• see URL structure

Example params

{ "user" : 2 }

• see Passing params

Example response

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

• see Return values
• see HTTP return codes

Returns rich users without attributes by their IDs.

Example URL

https://[hostname]/krb/rpc/json/usersManager/getRichUsersByIds

• see URL structure

Example params

{ "ids" : [ 52 , 75 ] }

• see Passing params

Example response

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

• see Return values
• see HTTP return codes

Get All richUsers with or without specificUsers with selected attributes.

Example URL

https://[hostname]/krb/rpc/json/usersManager/getRichUsersWithAttributes

• see URL structure

Example params

{ "attrsNames" : [ "text" , "text" ] , "includedSpecificUsers" : true }

• see Passing params

Example response

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

• see Return values
• see HTTP return codes

Get All richUsers with or without specificUsers with all included attributes.

Example URL

https://[hostname]/krb/rpc/json/usersManager/getRichUsersWithAttributes

• see URL structure

Example params

{ "includedSpecificUsers" : true }

• see Passing params

Example response

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

• see Return values
• see HTTP return codes

Returns rich users with attributes by their IDs.

Example URL

https://[hostname]/krb/rpc/json/usersManager/getRichUsersWithAttributesByIds

• see URL structure

Example params

{ "ids" : [ 13 , 35 ] }

• see Passing params

Example response

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

• see Return values
• see HTTP return codes

Returns all RichUsers with attributes who are not member of any VO.

Example URL

https://[hostname]/krb/rpc/json/usersManager/getRichUsersWithoutVoAssigned

• see URL structure

Example response

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

• see Return values
• see HTTP return codes

Returns list of RichUsers which are not members of any VO and with selected attributes

Example URL

https://[hostname]/krb/rpc/json/usersManager/getRichUsersWithoutVoWithAttributes

• see URL structure

Example params

{ "attrsNames" : [ "text" , "text" ] }

• see Passing params

Example response

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

• see Return values
• see HTTP return codes

Returns all specific users in Perun.

Example URL

https://[hostname]/krb/rpc/json/usersManager/getSpecificUsers

• see URL structure

Example response

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

• see Return values
• see HTTP return codes

Return all specific users who are owned by the user.

Example URL

https://[hostname]/krb/rpc/json/usersManager/getSpecificUsersByUser

• see URL structure

Example params

{ "user" : 88 }

• see Passing params

Example response

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

• see Return values
• see HTTP return codes

Gets users sponsoring a given user in a VO.

Example URL

https://[hostname]/krb/rpc/json/usersManager/getSponsorsForMember

• see URL structure

Example params

{ "member" : 85 , "attrNames" : [ "text" , "text" ] }

• see Passing params

Example response

{ ... TODO ... }

• see Return values
• see HTTP return codes

Gets users sponsoring a given user in a VO.

Example URL

https://[hostname]/krb/rpc/json/usersManager/getSponsorsForMember

• see URL structure

Example params

{ "vo" : 24 , "extSourceName" : "text" , "extLogin" : "text" , "attrNames" : [ "text" , "text" ] }

• see Passing params

Example response

{ ... TODO ... }

• see Return values
• see HTTP return codes

Returns user by his login in external source and external source.

Example URL

https://[hostname]/krb/rpc/json/usersManager/getUserByExtSourceNameAndExtLogin

• see URL structure

Example params

{ "extSourceName" : "text" , "extLogin" : "text" }

• see Passing params

Example response

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

• see Return values
• see HTTP return codes

Returns user by its id.

Example URL

https://[hostname]/krb/rpc/json/usersManager/getUserById

• see URL structure

Example params

{ "id" : 73 }

• see Passing params

Example response

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

• see Return values
• see HTTP return codes

Returns user by VO member.

Example URL

https://[hostname]/krb/rpc/json/usersManager/getUserByMember

• see URL structure

Example params

{ "member" : 20 }

• see Passing params

Example response

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

• see Return values
• see HTTP return codes

Returns user based on one of the userExtSource.

Example URL

https://[hostname]/krb/rpc/json/usersManager/getUserByUserExtSource

• see URL structure

Example params

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

• see Passing params

Example response

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

• see Return values
• see HTTP return codes

Gets user's external source by the user's external login and external source.

Example URL

https://[hostname]/krb/rpc/json/usersManager/getUserExtSourceByExtLogin

• see URL structure

Example params

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

• see Passing params

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

• see Return values
• see HTTP return codes

Gets user's external source by the user's external login and external source name

Example URL

https://[hostname]/krb/rpc/json/usersManager/getUserExtSourceByExtLoginAndExtSourceName

• see URL structure

Example params

{ "extSourceName" : "text" , "extSourceLogin" : "text" }

• see Passing params

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

• see Return values
• see HTTP return codes

Get the user ext source by its id.

Example URL

https://[hostname]/krb/rpc/json/usersManager/getUserExtSourceById

• see URL structure

Example params

{ "userExtSource" : 87 }

• see Passing params

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

• see Return values
• see HTTP return codes

Return userExtSource for specific attribute definition (specified by id) and unique value. If not found, throw and exception. It looks for exactly one value of the specific attribute type: - Integer -> exactly match - String -> exactly match - Map -> exactly match of "key=value" - ArrayList -> exactly match of one of the value userExtSource namespace

Example URL

https://[hostname]/krb/rpc/json/usersManager/getUserExtSourceByUniqueAttributeValue

• see URL structure

Example params

{ "attributeId" : 31 , "attributeValue" : "text" }

• see Passing params

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

• see Return values
• see HTTP return codes

Return userExtSource for specific attribute definition (specified by name) and unique value. If not found, throw and exception. It looks for exactly one value of the specific attribute type: - Integer -> exactly match - String -> exactly match - Map -> exactly match of "key=value" - ArrayList -> exactly match of one of the value userExtSource namespace

Example URL

https://[hostname]/krb/rpc/json/usersManager/getUserExtSourceByUniqueAttributeValue

• see URL structure

Example params

{ "attributeName" : "text" , "attributeValue" : "text" }

• see Passing params

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

• see Return values
• see HTTP return codes

Gets list of all user's external sources of the user.

Example URL

https://[hostname]/krb/rpc/json/usersManager/getUserExtSources

• see URL structure

Example params

{ "user" : 33 }

• see Passing params

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

• see Return values
• see HTTP return codes

Returns user ext sources by their IDs.

Example URL

https://[hostname]/krb/rpc/json/usersManager/getUserExtSourcesByIds

• see URL structure

Example params

{ "ids" : [ 3 , 25 ] }

• see Passing params

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

• see Return values
• see HTTP return codes

Returns all users in Perun.

Example URL

https://[hostname]/krb/rpc/json/usersManager/getUsers

• see URL structure

Example response

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

• see Return values
• see HTTP return codes

Returns all users who have set the attribute with the value. Searching only def and opt attributes.

Example URL

https://[hostname]/krb/rpc/json/usersManager/getUsersByAttribute

• see URL structure

Example params

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

• see Passing params

Example response

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

• see Return values
• see HTTP return codes

Returns all users who have set the attribute with the value. Searching only def and opt attributes.

Example URL

https://[hostname]/krb/rpc/json/usersManager/getUsersByAttribute

• see URL structure

Example params

{ "attributeName" : "text" , "attributeValue" : {...} }

• see Passing params

Example response

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

• see Return values
• see HTTP return codes

Returns all users who have attribute which have value which contains searchString.

Example URL

https://[hostname]/krb/rpc/json/usersManager/getUsersByAttributeValue

• see URL structure

Example params

{ "attributeName" : "text" , "attributeValue" : "text" }

• see Passing params

Example response

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

• see Return values
• see HTTP return codes

Returns users by their IDs.

Example URL

https://[hostname]/krb/rpc/json/usersManager/getUsersByIds

• see URL structure

Example params

{ "ids" : [ 87 , 4 ] }

• see Passing params

Example response

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

• see Return values
• see HTTP return codes

Return all users who owns the specific user.

Example URL

https://[hostname]/krb/rpc/json/usersManager/getUsersBySpecificUser

• see URL structure

Example params

{ "specificUser" : 63 }

• see Passing params

Example response

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

• see Return values
• see HTTP return codes

Gets count of all users.

Example URL

https://[hostname]/krb/rpc/json/usersManager/getUsersCount

• see URL structure

Example response

90

• see Return values
• see HTTP return codes

Get page of users with the given attributes. Query parameter specifies offset, page size, sorting order, and sorting column, by default it finds all users, but the search can be customized by optional parameters: whether to return only users without vo, string to search users by (by default it searches in names, user and member ids, user uuids, emails, logins of member or other attributes based on perun configuration), facility id, vo id, service id and resource id to filter users to search only for those assigned to these entities, and option whether to return only allowed users.

Example URL

https://[hostname]/krb/rpc/json/usersManager/getUsersPage

• see URL structure

Example params

{ "query" : { "pageSize" : 3 , "offset" : 0 , "order" : "ASCENDING" , "sortColumn" : "ID" , "searchString" : "Doe" , "withoutVo" : false } , "attrNames" : [ "text" , "text" ] }

• see Passing params

Example response

{ "offset" : 0 , "pageSize" : 3 , "totalCount" : 1 , "data" : [ { "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" } ] } , {...} , {...} ]  }

• see Return values
• see HTTP return codes

Return list of users who matches the searchString, searching name, email and logins and are not member of specific VO.

Example URL

https://[hostname]/krb/rpc/json/usersManager/getUsersWithoutSpecificVo

• see URL structure

Example params

{ "vo" : 27 , "searchString" : "text" }

• see Passing params

Example response

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

• see Return values
• see HTTP return codes

Returns all users who are not member of any VO.

Example URL

https://[hostname]/krb/rpc/json/usersManager/getUsersWithoutVoAssigned

• see URL structure

Example response

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

• see Return values
• see HTTP return codes

Returns list of VOs, where the user is an Administrator. Including VOs, where the user is a VALID member of authorized group.

Example URL

https://[hostname]/krb/rpc/json/usersManager/getVosWhereUserIsAdmin

• see URL structure

Example params

{ "user" : 54 }

• see Passing params

Example response

[ { "id" : 123 , "name" : "My testing VO" , "shortName" : "test_vo" , "beanName" : "Vo" } , {...} , {...} ]

• see Return values
• see HTTP return codes

Returns list of VOs, where the user is a Member.

Example URL

https://[hostname]/krb/rpc/json/usersManager/getVosWhereUserIsMember

• see URL structure

Example params

{ "user" : 67 }

• see Passing params

Example response

[ { "id" : 123 , "name" : "My testing VO" , "shortName" : "test_vo" , "beanName" : "Vo" } , {...} , {...} ]

• see Return values
• see HTTP return codes

Checks if the login is available in the namespace. Return 1 if yes, 0 if no.

Example URL

https://[hostname]/krb/rpc/json/usersManager/isLoginAvailable

• see URL structure

Example params

{ "loginNamespace" : "text" , "login" : "text" }

• see Passing params

Example response

1

• see Return values
• see HTTP return codes

Move user's external source from sourceUser to targetUser.

Example URL

https://[hostname]/krb/rpc/json/usersManager/moveUserExtSource

• see URL structure

Example params

{ "sourceUser" : 51 , "targetUser" : 77 , "userExtSource" : 75 }

• see Passing params

Example response

null

• see Return values
• see HTTP return codes

Remove specific user owner (the user).

Example URL

https://[hostname]/krb/rpc/json/usersManager/removeSpecificUserOwner

• see URL structure

Example params

{ "user" : 51 , "specificUser" : 32 }

• see Passing params

Example response

null

• see Return values
• see HTTP return codes

Remove user's external source. Persistent UserExtSources are not removed unless force param is present and set to true.

Example URL

https://[hostname]/krb/rpc/json/usersManager/removeUserExtSource

• see URL structure

Example params

{ "user" : 91 , "userExtSource" : 12 , "force" : true }

• see Passing params

Example response

null

• see Return values
• see HTTP return codes

Remove user's external sources. Persistent UserExtSources are not removed unless force param is present and set to true.

Example URL

https://[hostname]/krb/rpc/json/usersManager/removeUserExtSources

• see URL structure

Example params

{ "user" : 65 , "userExtSources" : [ 65 , 70 ] , "force" : true }

• see Passing params

Example response

null

• see Return values
• see HTTP return codes

Reserves password for a user in specified login-namespace.

Example URL

https://[hostname]/krb/rpc/json/usersManager/reservePassword

• see URL structure

Example params

{ "login" : "text" , "namespace" : "text" , "password" : "text" }

• see Passing params

Example response

null

• see Return values
• see HTTP return codes

Set specific user type for specific user and set ownership of this user for the owner.

Example URL

https://[hostname]/krb/rpc/json/usersManager/setSpecificUser

• see URL structure

Example params

{ "specificUser" : 31 , "specificUserType" : "text" , "owner" : 5 }

• see Passing params

Example response

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

• see Return values
• see HTTP return codes

Unblock logins for given namespace

Example URL

https://[hostname]/krb/rpc/json/usersManager/unblockLogins

• see URL structure

Example params

{ "logins" : [ "text" , "text" ] , "namespace" : "text" }

• see Passing params

Example response

null

• see Return values
• see HTTP return codes

Unblock logins globally (for all namespaces)

Example URL

https://[hostname]/krb/rpc/json/usersManager/unblockLogins

• see URL structure

Example params

{ "logins" : [ "text" , "text" ] }

• see Passing params

Example response

null

• see Return values
• see HTTP return codes

Unblock logins by id

Example URL

https://[hostname]/krb/rpc/json/usersManager/unblockLoginsById

• see URL structure

Example params

{ "logins" : [ 62 , 68 ] }

• see Passing params

Example response

null

• see Return values
• see HTTP return codes

Remove all ownerships of this specific user and unset this specific user type from this specific user.

Example URL

https://[hostname]/krb/rpc/json/usersManager/unsetSpecificUser

• see URL structure

Example params

{ "specificUser" : 63 , "specificUserType" : "text" }

• see Passing params

Example response

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

• see Return values
• see HTTP return codes

Updates titles before/after users name Titles must be set in User object. Setting any title to null will remove title from name. Other user's properties are ignored.

Example URL

https://[hostname]/krb/rpc/json/usersManager/updateNameTitles

• see URL structure

Example params

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

• see Passing params

Example response

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

• see Return values
• see HTTP return codes

Updates users data in DB.

Example URL

https://[hostname]/krb/rpc/json/usersManager/updateUser

• see URL structure

Example params

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

• see Passing params

Example response

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

• see Return values
• see HTTP return codes

Updates user's userExtSource in DB.

Example URL

https://[hostname]/krb/rpc/json/usersManager/updateUserExtSource

• see URL structure

Example params

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

• see Passing params

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

• see Return values
• see HTTP return codes

Updates user's userExtSource last access time in DB. We can get information which userExtSource has been used as a last one.

Example URL

https://[hostname]/krb/rpc/json/usersManager/updateUserExtSourceLastAccess

• see URL structure

Example params

{ "userExtSource" : 43 }

• see Passing params

Example response

null

• see Return values
• see HTTP return codes

Validates password for a user in specified login-namespace. After that, user should be able to log-in in external authz system using his credentials. It also creates UserExtSources and sets some required attributes.

Example URL

https://[hostname]/krb/rpc/json/usersManager/validatePassword

• see URL structure

Example params

{ "login" : "text" , "namespace" : "text" }

• see Passing params

Example response

null

• see Return values
• see HTTP return codes

Validate new preferred email address. Request to validate is determined based on token parameter sent in email notice by requestPreferredEmailChange() method.

Example URL

https://[hostname]/krb/rpc/json/usersManager/validatePreferredEmailChange

• see URL structure

Example params

{ "token" : "text" , "u" : 61 }

• see Passing params

Example response

"text"

• see Return values
• see HTTP return codes

Validate ssh public key, throws exception if validation fails

Example URL

https://[hostname]/krb/rpc/json/usersManager/validateSSHKey

• see URL structure

Example params

{ "sshKey" : "text" }

• see Passing params

Example response

null

• see Return values
• see HTTP return codes