Hi Ayesha,

Thank you for the suggestions. I'm +1 for the 1st approach as it is
providing all the server configs in a single call instead of requiring the
client to perform multiple calls. I have introduced slight modifications to
the inbound config. Please see the final configs model and let me know what
you think.

{
  "homeRealmIdentifiers": [
    "localhost"
  ],
  "idleSessionTimeoutPeriod": "15",
  "rememberMePeriod": "20160",
  "provisioning": {
    "inbound": {
      "scim": {
        "provisioningUserstore": "PRIMARY",
        "enableDumbMode": false
      }
    }
  },
  "authenticators": [
    {
      "id": "QmFzaWNBdXRoZW50aWNhdG9y",
      "name": "BasicAuthenticator",
      "displayName": "basic",
      "isEnabled": true,
      "self": 
"/t/carbon.super/api/server/v1/configs/authenticators/QmFzaWNBdXRoZW50aWNhdG9y"
    }
  ]}

With this new approach, instead of giving PUT operation support for the
/configs resource, shall we give PATCH operation for root level attributes
in configs API, and PUT for sub-level provisioning resource? WDYT?


On Mon, Apr 20, 2020 at 12:39 PM Ayesha Dissanayaka <[email protected]> wrote:

> Hi Sathya,
>
> What if api/server/v1/configs returns everything like below.
>
> {
>   "homeRealmIdentifier": [
>     "localhost"
>   ],
>   "idleSessionTimeoutPeriod": "15",
>   "rememberMePeriod": "20160",
>   "provisioning" : {
>      "inbound" : {
>      "provisioningUserstore": "PRIMARY",
>      "enableDumbMode": false
>       }
>    },
>   "authenticators": [
>   {
>     "id": "QmFzaWNBdXRoZW50aWNhdG9y",
>     "name": "BasicAuthenticator",
>     "displayName": "basic",
>     "isEnabled": true,
>     "self":
> "/t/carbon.super/api/server/v1/configs/authenticators/QmFzaWNBdXRoZW50aWNhdG9y"
>   }
>  ]
> }
>
> Or  give links like below
>
> {
>
>   "homeRealmIdentifier": [
>     "localhost"
>   ],
>   "idleSessionTimeoutPeriod": "15",
>   "rememberMePeriod": "20160",
>   "provisioning" : {
>
>      "link": ""
>
>    },
>   "authenticators": {
>
>      "link": ""
>
>    }
> }
>
>
> Then to manage sub-content use
>
> api/server/v1/configs/provisioning
>
> api/server/v1/configs/authenticators
>
> Thanks!
> -Ayesha
>
> On Fri, Apr 17, 2020 at 5:58 PM Sathya Bandara <[email protected]> wrote:
>
>> Hi all,
>>
>> Currently in Identity Server, we do not have a capability to retrieve
>> following resident configurations in a restful manner.
>>
>> *Resident IDP*
>>
>>    - Home realm identifier
>>    - Idle session timeout
>>    - Remember me period
>>
>> *Resident SP*
>>
>> As a solution to this we have decided to introduce a new API under the
>> existing *t/carbon.super/api/server/v1/configs* context in order to
>> retrieve and update those configs.
>>
>> *For resident IDP related properties*
>>
>> *API Context*
>> api/server/v1/configs/realm
>>
>> *Model*
>>
>> {
>>   "homeRealmIdentifier": [
>>     "localhost"
>>   ],
>>   "idleSessionTimeoutPeriod": "15",
>>   "rememberMePeriod": "20160"}
>>
>> *Supported operations*
>> GET, PUT
>>
>> *For resident SP related properties*
>>
>> *API Context*
>> api/server/v1/configs/inbound/scim
>>
>> *Model*
>>
>>
>> *{ "provisioningUserstore": "PRIMARY", "enableDumbMode": false }*
>> *Supported operations*
>> GET, PUT
>>
>> Complete swagger definition can be found in [1]
>>
>> Highly appreciate your suggestions and concerns regarding this.
>>
>> [1] https://app.swaggerhub.com/apis/emswbandara/IAM_CONFIGS/0.1.0#/
>>
>> Thanks,
>> --
>> Sathya Bandara
>> Senior Software Engineer
>> Blog: https://medium.com/@technospace
>> WSO2 Inc. http://wso2.com
>> Mobile: (+94) 715 360 421
>>
>> <+94%2071%20411%205032>
>> _______________________________________________
>> Iam-dev mailing list
>> [email protected]
>> http://wso2.org/cgi-bin/mailman/listinfo/iam-dev
>>
>
>
> --
> *Ayesha Dissanayaka*
> Technical Lead
> WSO2, Inc: http://wso2.com
> <http://www.google.com/url?q=http%3A%2F%2Fwso2.com&sa=D&sntz=1&usg=AFQjCNEZvyc0uMD1HhBaEGCBxs6e9fBObg>
> 20, Palm Grove Avenue, Colombo 3
> E-Mail: [email protected] <[email protected]>
> Mobile: +94713580922
>


-- 
Sathya Bandara
Senior Software Engineer
Blog: https://medium.com/@technospace
WSO2 Inc. http://wso2.com
Mobile: (+94) 715 360 421

<+94%2071%20411%205032>
_______________________________________________
Architecture mailing list
[email protected]
https://mail.wso2.org/cgi-bin/mailman/listinfo/architecture

Reply via email to