Portal user mapping
The entity that feeds the portal users: each of its records becomes a user, by e-mail, with the tenant taken from a field. update replaces the mapping and syncs right away; delete stops syncing but keeps the users already created.
| Command | HTTP | Description |
|---|---|---|
portal-user-mappings list | GET /v1/portal_user_mappings | Get portal user mapping |
portal-user-mappings update | PUT /v1/portal_user_mappings | Map entity to portal users |
portal-user-mappings delete | DELETE /v1/portal_user_mappings | Remove portal user mapping |
Examples
--params carries query, path and header parameters (id, page, filters, X-Workspace-Id); --json carries the request body; --fields limits which fields come back — worth using on every list/get to save context. See Global flags for the full reference.
# Get portal user mapping
kobana dashboards portal-user-mappings list
# Map entity to portal users
kobana dashboards portal-user-mappings update \
--json '{"entity_type_id": "ENTITY_ID", "tenant_id_field_key": "cnpj", "email_field_key": "email", "name_field_key": "nome"}'
# Remove portal user mapping
kobana dashboards portal-user-mappings delete --dry-run
Next steps
- Portal users
- Entities
- Schema introspection — every parameter this resource accepts.