I prefer *GET /validate-role?role=rolename* over the HEAD request. WDYT?
Thanks,
Bhathiya
On Wed, Aug 7, 2019 at 3:33 PM Mushthaq Rumy <musht...@wso2.com> wrote:
> Adding [Architecture]
>
> On Wed, Aug 7, 2019 at 3:30 PM Mushthaq Rumy <musht...@wso2.com> wrote:
>
>> Since we will be UserStoreManager, this should cover the secondary user
>> stores as well.
>>
>> Thanks & Regards,
>> Mushthaq
>>
>> On Wed, Aug 7, 2019 at 3:28 PM Harsha Kumara <hars...@wso2.com> wrote:
>>
>>> What happen if the role is from secondary user store?
>>>
>>> On Wed, Aug 7, 2019 at 3:24 PM Naduni Pamudika <nad...@wso2.com> wrote:
>>>
>>>> Hi All,
>>>>
>>>> We are planning to add a REST API endpoint to APIM 3.0 Publisher Rest
>>>> APIs and the intention is to check the existence of a particular role name.
>>>> This will be used in order to manage roles when enabling Publisher Access
>>>> Control and Store Visibility and when adding Scopes.
>>>>
>>>> The swagger definition for the new endpoint would be as follows.
>>>>
>>>> ######################################################
>>>> # The Role Name Existence
>>>> ######################################################
>>>> /roles/{roleName}:
>>>> #-----------------------------------------------------
>>>> # The role name existence check resource
>>>> #-----------------------------------------------------
>>>> head:
>>>> security:
>>>> - OAuth2Security:
>>>> - apim:api_view
>>>> summary: |
>>>> Check given role name is already exist
>>>> description: |
>>>> Using this operation, you can check a given role name is
>>>> already used. You need to provide the role name you want to check.
>>>> parameters:
>>>> - $ref : '#/parameters/roleName'
>>>> responses:
>>>> 200:
>>>> description: |
>>>> OK.
>>>> Requested role name is returned.
>>>> 404:
>>>> description: |
>>>> Not Found.
>>>> Requested role name does not exist.
>>>> ######################################################
>>>> # Role Name
>>>> roleName:
>>>> name: roleName
>>>> in: path
>>>> description: |
>>>> The role name
>>>> required: true
>>>> type: string
>>>>
>>>>
>>>> It is a HEAD method (*/roles/{roleName}*) which will return a 200
>>>> status code if the given role name exists and a 404 status code if the give
>>>> role name is not found. Sample requests and responses are given below.
>>>>
>>>> Request:
>>>> HEAD https://localhost:9443/api/am/publisher/v1.0/roles/valid-role
>>>> HTTP/1.1
>>>> Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8
>>>>
>>>> Response:
>>>> HTTP/1.1 200 OK
>>>> Connection: keep-alive
>>>> Content-Length: 0
>>>>
>>>>
>>>> Request:
>>>> HEAD https://localhost:9443/api/am/publisher/v1.0/roles/invalid-role
>>>> HTTP/1.1
>>>> Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8
>>>>
>>>> Response:
>>>> HTTP/1.1 404 Not Found
>>>> Connection: keep-alive
>>>> Content-Length: 0
>>>>
>>>>
>>>> Are we good to have the endpoint definition as this? Appreciate your
>>>> inputs to proceed further.
>>>>
>>>> Thanks,
>>>> Naduni
>>>>
>>>> --
>>>> *Naduni Pamudika* | Senior Software Engineer | WSO2 Inc.
>>>> (m) +94 (71) 9143658 | (w) +94 (11) 2145345 | (e) nad...@wso2.com
>>>> [image: http://wso2.com/signature] <http://wso2.com/signature>
>>>>
>>>>
>>>
>>> --
>>>
>>> *Harsha Kumara*
>>>
>>> Technical Lead, WSO2 Inc.
>>> Mobile: +94775505618
>>> Email: hars...@wso2.coim
>>> Blog: harshcreationz.blogspot.com
>>>
>>> GET INTEGRATION AGILE
>>> Integration Agility for Digitally Driven Business
>>>
>>
>>
>> --
>> Mushthaq Rumy
>> *Senior Software Engineer*
>> Mobile : +94 (0) 779 492140
>> Email : musht...@wso2.com
>> WSO2, Inc.; http://wso2.com/
>> lean . enterprise . middleware.
>>
>> <http://wso2.com/signature>
>>
>
>
> --
> Mushthaq Rumy
> *Senior Software Engineer*
> Mobile : +94 (0) 779 492140
> Email : musht...@wso2.com
> WSO2, Inc.; http://wso2.com/
> lean . enterprise . middleware.
>
> <http://wso2.com/signature>
>
--
*Bhathiya Jayasekara* | Technical Lead | WSO2 Inc.
(m) +94 71 547 8185 | (e) bhathiya-@t-wso2-d0t-com
_______________________________________________
Architecture mailing list
Architecture@wso2.org
https://mail.wso2.org/cgi-bin/mailman/listinfo/architecture
