User API
User API provides an interface for user access administration. Back-end for this API is an OIDC provider).
Get User Info
This API endpoint accepts a “Bearer” access token of a user. It returns claims related to the user.
- POST /user/info
Example request:
{}
- Response JSON Object:
id (str) – unique OIDC ID of the user.
email (str) – user’s e-mail.
name (str) – user’s full name.
accounting (str) – name of user’s accounting.
permissions (list) – list of permissions the user is granted. See permission mechanics for more information.
Example response:
{ "id": "auth0|mGochhH3Pz5SiCWo8m44", "email": "john-smith@example.com", "name": "John Smith", "accounting": "development", "permissions": [ "imagery.availability", "imagery.scene-info" ] }
Create Guardian User
This API endpoint allows Guardian managers to create accounts.
Needed Permissions: admin.users.create-guardian-user
- POST /user/guardian-user/create
- Response JSON Object:
email (str) – user’s e-mail.
password (str) – user’s initial password.
name (str) – user’s full name.
Example request:
{ "email": "john-smith@example.com", "password": "secret", "name": "John Smith" }
Example response:
{}
Delete Guardian User
This API endpoint allows Guardian managers to delete accounts from their group.
Needed Permissions: admin.users.delete-guardian-user
- POST /user/guardian-user/delete
- Response JSON Object:
email (str) – user’s e-mail.
Example request:
{ "email": "john-smith@example.com" }
Example response:
{}