Users

Users

Name App Type Scope Auth Type Resource URI Civic Platform version
Get All User Groups Agency users Access token GET /v4/users/{user_id}/groups 9.0.0
Get My User Account Agency users Access token GET /v4/users/me 9.0.0

Overview:

Users

Agency Users

Although "users" is a broad and general term, the Construct API's User object (user API resource) represents the agency user. An agency user is a staff member of the agency who logs in the Civic Platform back-office application.

Citizen Users

The other type of users is the citizen user. A citizen is any public user who logs in citizen-facing app such as Citizen Access or other civic-engagement apps using Construct API. The citizen user is represented by one of the following objects:
  • Citizen Access User - user who logs in Citizen Access (citizenaccess/citizen API resource).
  • CivicId - a registered user on the Construct User Portal, and can be linked to multiple user accounts (civicid API resource)