Skip to content

geOrchestra Python library

Console

georchestra/geo-utils

geOrchestra Python library

georchestra/geo-utils

Home
Technical guides
Technical guides
- Overview
- geOrchestra
- GeoNetwork
- Console Console
  Table of contents
  - Console: Console_api
    
    Example
    
    Users
    
    Organizations
    
    Roles
- GeoServer
- Metadata helpers

Console

Console: `Console_api`

The top-level client's console attribute is an instance of Console_api. It sends requests to /console/private/... using HTTP Basic authentication.

Example

Update a user description, then create and delete a test user and a test organization (from the __main__ block of the sources):

import json

console = geOr_api.console

user = json.loads(console.getusers(uid="testadmin"))
user["orgObj"] = json.loads(console.getorgs(uid=user["org"]))
user["description"] = "Description changed with the API"
print(console.updateuserdetails(uid=user["uid"], json=json.dumps(user)))

print(console.createnewuser(org="PSC", sn="testapi", givenname="test",
                            mail="testapi@example.org",
                            description="This user was created with the API"))
print(console.deluser(id="testapi"))

print(console.createneworgs(name="TESTAPI", shortName="testapi", orgType="Other"))
print(console.delorgs(id="testapi"))

Users

Method	Purpose	Result notes
`getusers(uid="", filter=None)`	Read a user by UID or request the users endpoint	Response text on HTTP 200; otherwise `None`. The `filter` parameter is currently unused.
`createnewuser(org, sn, givenname, mail, description)`	Create a user	Response text on HTTP 200; otherwise an error string.
`updateuserdetails(uid, json)`	Update a user; `json` is a JSON-encoded request body	Response text on HTTP 200; otherwise `None`.
`deluser(id)`	Delete a user	Response text on HTTP 200; otherwise an error string.

Organizations

Method	Purpose	Result notes
`getorgs(uid="", filter=None)`	Read an organization by UID or request the organizations endpoint	Response text on HTTP 200; otherwise `None`. The `filter` parameter is currently unused.
`createneworgs(name, shortName, orgType, address="", description="", note="", mail="", url="", b64logo="")`	Create an organization	`orgType` should be a Console-supported type such as `Association`, `Company`, `NGO`, `Individual`, or `Other`. Returns response text on HTTP 200; otherwise an error string.
`delorgs(id)`	Delete an organization	Response text on HTTP 200; otherwise an error string.

Roles

Method	Purpose	Result notes
`getroles(uid="")`	Read roles, optionally scoped by `uid`	Response text on HTTP 200; otherwise `None`.
`createnewroles(cn="NEWROLE", description="Default description")`	Create a role	Response text on HTTP 200; otherwise an error string.
`updaterolesuser(uuid="testadmin", cn="ROLE")`	Assign a role to a user	Response text on HTTP 200; otherwise an error string.

These operations may require administrator privileges. Return values are response text, None, or an error string rather than a common response type. Check each result before continuing.