Skip to content

Commit

Permalink
MID-7976 request access docs, wip
Browse files Browse the repository at this point in the history
  • Loading branch information
1azyman committed Sep 9, 2022
1 parent ec01506 commit d024b3a
Show file tree
Hide file tree
Showing 2 changed files with 38 additions and 3 deletions.
39 changes: 36 additions & 3 deletions docs/admin-gui/request-access/configuration.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,46 @@

Following document describes different options and configuration possibilities for request access UI.

Configuration can be placed in admin gui configuration element - globally set is system configuration or in all roles.
See xref:../admin-gui-config/index.adoc#how-it-works[Admin GUI configuration] on how configuration is compiled when user logs in.

As for request access UI, configuration is merged on level of wizard steps, e.g.:

* Person of interest: `targetSelection`
* Relations: `relationSelection`
* Role catalog: `roleCatalog`
* Shopping cart: `checkout`
== Person of interest

[options="header", cols=3]
[options="header", cols=4]
|===
|as
|Element
|Type
|Default value
|Description

|defaultSelection
|boolean
|
|Identifier of group that should be preselected or constant "myself" to preselect option which represents user currently logged in.

|allowRequestForMyself
|boolean
|true
|This is simple override if currently authenticated user has authorization to request for him/herself assign other relations, but we don't want them to do it via shopping cart.

|allowRequestForOthers
|boolean
|true
|This is simple override if currently authenticated user has authorization to assign other relations, but we don't want them to do it via shopping cart.

|group
|GroupSelectionType
|
|Group selection structure creates new tile in first step of request access wizard UI (person of interest).
Tile button will allow user requesting access to select other users from collections specified by collectionRef or filter.
Identifier and display elements are mandatory.
|===

== Relations
Expand All @@ -20,7 +53,7 @@ Following document describes different options and configuration possibilities f
== Role catalog


== Shopping cart (checkout)
== Shopping cart

== Examples

2 changes: 2 additions & 0 deletions docs/admin-gui/request-access/index.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,8 @@ New UI takes form of proper wizard with up to four steps:
First two steps may be hidden, or skipped based on configuration or authorizations of user that is currently logged in.

Configuration and some examples can be found xref:configuration.adoc[here].

== Person of interest

.Person of interest
Expand Down

0 comments on commit d024b3a

Please sign in to comment.