User (hand-written)
Generated by
scripts/generate_docs.py(scripts/regen_docs.sh). Do not edit by hand.
Methods of client.user (reportnet_api.resources.user_ext.UserResource). Every method also exists on AsyncReportnetClient as await a_client.user.<name>(...) with the same arguments. Roles are copied from the API spec; where it states none, this page says so rather than guessing.
Methods
refresh_token
renew a web-app login.
HTTP: POST /user/refreshToken
Call: client.user.refresh_token(...) (async client: await a_client.user.refresh_token(...))
| Argument | Type | Required | Default | Description |
|---|---|---|---|---|
refresh_token |
str |
yes |
Returns: dict[str, Any]
Allowed roles:
Not stated in the API spec.
refresh_token is the refresh token (a JWT) issued together with the
login, not the UUID accessToken. Returns the TokenVO dict: a new UUID
accessToken (Reportnet's cache key for the fresh JWT), a new
refreshToken (use it for the next refresh), accessTokenExpiration,
preferredUsername, userId, roles, groups.
The route has no auth rule (the web app calls it after a 401, with its expired token), so the client's own credential doesn't matter.