Skip to content

Commit

Permalink
adding Glossary Item for justInTimeEntitlements
Browse files Browse the repository at this point in the history
  • Loading branch information
simonredfern committed Oct 27, 2023
1 parent 4d1e6e3 commit 6054cf6
Showing 1 changed file with 28 additions and 28 deletions.
56 changes: 28 additions & 28 deletions obp-api/src/main/scala/code/api/util/Glossary.scala
Original file line number Diff line number Diff line change
Expand Up @@ -588,33 +588,6 @@ object Glossary extends MdcLoggable {
)


val justInTimeEntitlements : String = if (APIUtil.getPropsAsBoolValue("create_just_in_time_entitlements", false))
{"Just in Time Entitlements are ENABLED on this instance."} else {"Just in Time Entitlements are NOT enabled on this instance"}


glossaryItems += GlossaryItem(
title = "Entitlements.Just.In.Time.Entitlements",
description =
s"""
|
|{$justInTimeEntitlements}
|
|This is how Just in Time Entitlements work:
|
|If Just in Time Entitlements are enabled then OBP does the following:
|If a user is trying to use a Role (via an endpoint) and the user *could* grant them selves the required Role(s), then OBP automatically grants the Role.
|i.e. if the User already has canCreateEntitlementAtOneBank or canCreateEntitlementAtAnyBank then OBP will automatically grant a role that would be granted by a manual process anyway.
|This speeds up the process of granting of roles. Certain roles are excluded from this automation.
|If create_just_in_time_entitlements is again set to false after it was true for a while, any auto granted Entitlements to roles are kept in place.
|Note: In the entitlements model we set createdbyprocess="create_just_in_time_entitlements". For manual operations we set createdbyprocess="manual"
|
|To enable / disable this feature set the Props create_just_in_time_entitlements=true or false. The default is false.
|
|"""
)





glossaryItems += GlossaryItem(
Expand Down Expand Up @@ -654,11 +627,38 @@ object Glossary extends MdcLoggable {



val justInTimeEntitlements : String = if (APIUtil.getPropsAsBoolValue("create_just_in_time_entitlements", false))
{"Just in Time Entitlements are ENABLED on this instance."} else {"Just in Time Entitlements are NOT enabled on this instance."}


glossaryItems += GlossaryItem(
title = "Just In Time Entitlements",
description =
s"""
|
|${justInTimeEntitlements}
|
|This is how Just in Time Entitlements work:
|
|If Just in Time Entitlements are enabled then OBP does the following:
|If a user is trying to use a Role (via an endpoint) and the user could grant them selves the required Role(s), then OBP automatically grants the Role.
|i.e. if the User already has canCreateEntitlementAtOneBank or canCreateEntitlementAtAnyBank then OBP will automatically grant a role that would be granted by a manual process anyway.
|This speeds up the process of granting of roles. Certain roles are excluded from this automation.
|If create_just_in_time_entitlements is again set to false after it was true for a while, any auto granted Entitlements to roles are kept in place.
|Note: In the entitlements model we set createdbyprocess=create_just_in_time_entitlements. For manual operations we set createdbyprocess=manual
|
|To enable / disable this feature set the Props create_just_in_time_entitlements=true or false. The default is false.
|
|"""
)


glossaryItems += GlossaryItem(





glossaryItems += GlossaryItem(
title =
"Account",
description =
Expand Down

0 comments on commit 6054cf6

Please sign in to comment.