Skip to content

Commit

Permalink
chore(docs): update User Manager Service documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
bot-targa committed Nov 27, 2024
1 parent a5a9575 commit e313394
Show file tree
Hide file tree
Showing 3 changed files with 32 additions and 7 deletions.
13 changes: 7 additions & 6 deletions docs/runtime_suite/user-manager-service/20_configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ To prevent the insertion of duplicated users in the database is necessary to def
## User Manager Configuration CRUD collection

The User Manager Service requires a CRUD collection to store user group schemas and other group properties.
This collection can be managed directly from the Backoffice, allowing also users that do not have access to the console
This collection can be managed directly from the [Microfrontend Composer][microfrontend-composer], allowing also users that do not have access to the console
to configure the user Manager Service.
The collection can have any name you want, as long as you specify the correct name in the
`UMS_CONFIG_CRUD_ENDPOINT` [environment variable][environment-variables].
Expand All @@ -60,7 +60,7 @@ The configuration collection needs the following service-specific fields.

- **userGroup (required)** - `string`: unique group type for users (eg. admin, secretary, etc.).
- **crudSchema (required)** - `object`: the JSON schema of the CRUD that stores the user data for the specific group.
- **label (required)** - `string`: label displayed in the Backoffice lookup.
- **label (required)** - `string`: label displayed in the [Microfrontend Composer][microfrontend-composer] lookup.
- **authUserCreationDisabled** - `boolean`: if `true`, it disables the user creation in the authentication service for the given group (the user is only created in the CRUD).

## Auth0 Users Imports Jobs CRUD collection
Expand Down Expand Up @@ -175,10 +175,7 @@ When no file is provided, no additional properties will be added.

## Console Endpoint

In order to use the User Manager Service from the Backoffice, you must create a dedicated endpoint to expose routes.
If the Auth0 Client is used as authentication service, the API Key must be enabled in the endpoint,
since it is used by the Auth0 Client to infer the client-type.

In order to use the User Manager Service with [Microfrontend Composer][microfrontend-composer], you must [configure the API Gateway][api-gateway] and [create an endpoint][console-endpoint] to expose the service routes.

## Job Scheduler

Expand Down Expand Up @@ -218,7 +215,11 @@ sequenceDiagram
UMS-->>-UI: completed job results
```


[agenda-package]: https://www.npmjs.com/package/agenda "Agenda package documentation"
[api-gateway]: /runtime_suite/api-gateway/10_overview.md
[console-endpoint]: /development_suite/api-console/api-design/endpoints.md
[microfrontend-composer]: /microfrontend-composer/overview.md
[rond-config]: https://rond-authz.io/docs/configuration
[rond-policy-integration]: https://rond-authz.io/docs/policy-integration

Expand Down
19 changes: 18 additions & 1 deletion docs/runtime_suite/user-manager-service/30_usage.md
Original file line number Diff line number Diff line change
Expand Up @@ -444,7 +444,24 @@ Note that in any case a user set to `DELETED` is never deleted from the CRUD wit

#### Body

The body of this request has the same interface of a CRUD service `POST /users/state` request, if used with the filters.
The body of this request has the same interface of the CRUD service `POST /users/state` endpoint and expects a list of filters and transitions in the body, like:

```json
[
{
"filter": {
"_id": "66e19957f72ba7349eb7b7b2"
},
"stateTo": "TRASH"
},
{
"filter": {
"_id": "66e19957f72ba7349eb7b7b3"
},
"stateTo": "DELETED"
}
]
```

#### Response

Expand Down
7 changes: 7 additions & 0 deletions docs/runtime_suite/user-manager-service/changelog.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,13 @@ All notable changes to this project will be documented in this file.
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## [1.5.2] 2024-11-26

### [Fixed]

- Fix unit tests and upgrade `custom-plugin-lib` (v6) and other dependencies
- Fix bug causing malformed _q query parameter when fetching users while processing job for bulk activation of users in Auth0

## [1.5.1] 2024-03-27

### [Fixed]
Expand Down

0 comments on commit e313394

Please sign in to comment.