[Architecture] [IAM][IS 5.10.0] REST APIs For Identity Provider Management

2019-11-01 Thread Sathya Bandara 
Hi all,

WSO2 Identity Server currently supports IDP related operations using SOAP
APIs. I'm currently working on introducing a REST API layer for IDP
management in 5.10.0. Please find the API definition in [1].

The internal implementation for the above APIs will use the
IdentityProviderManager[2] OSGi service. As per the team discussions, we
have introduced the following framework level changes to support RESTful
operations for the IDPs.

   - Introduce UUID, Image URL to identity provider model.
   - Change DDL of IDP table to store UUID and Image URL.
   - Introduce Regex, Options and SubProperties to Property model.
   - Introduce OSGi methods and DAO layer methods to do IDP operations with
   resource ID (UUID).
   - Listeners for IDP operations based on resource ID.

[1] https://app.swaggerhub.com/apis/emswbandara/IAM_IDP/0.1.0

Highly appreciate your valuable suggestions.

Thanks,
Sathya
-- 
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
Architecture@wso2.org
https://mail.wso2.org/cgi-bin/mailman/listinfo/architecture

[Architecture] WSO2 Product Installation Resources Released!!!

2019-11-01 Thread Chamindi Abayadeera 
WSO2 Installation Experience team is pleased to announce the release of
Ansible, AWS, Docker, Puppet and Vagrant resources for WSO2 products.

Ansible

Related artifacts:

   -

   WSO2 API Manager v3.0.0 -
   https://github.com/wso2/ansible-apim/releases/tag/v3.0.0.1


Issues:

   -

   WSO2 API Manager - https://github.com/wso2/ansible-apim/issues



AWS

Related artifacts:

   -

   WSO2 API Manager v3.0.0 -
   https://github.com/wso2/aws-apim/releases/tag/v3.0.0.1


Issues:

   -

   WSO2 API Manager - https://github.com/wso2/aws-apim/issues
   



Docker and Docker Compose

Related artifacts:

   -

   WSO2 API Manager v3.0.0 -
   https://github.com/wso2/docker-apim/releases/tag/v3.0.0.1


Issues:

   -

   WSO2 API Manager - https://github.com/wso2/docker-apim
   /issues
   



Puppet

Related artifacts:

   -

   WSO2 API Manager v3.0.0  -
   https://github.com/wso2/puppet-apim/releases/tag/v3.0.0.1
   -

   WSO2 Identity Server v5.9.0 -
   https://github.com/wso2/puppet-is/releases/tag/v5.9.0.1


Issues:

   -

   WSO2 API Manager - https://github.com/wso2/puppet-apim/issues
   -

   WSO2 Identity Server - ttps://github.com/wso2/puppet-is/issues



Vagrant

Related artifacts:

   -

   WSO2 API Manager v3.0.0  -
   https://github.com/wso2/vagrant-apim/releases/tag/v3.0.0.1
   -

   WSO2 Vagrant Resources to create boxes for WSO2 Products v1.4.0 -
   https://github.com/wso2/vagrant-boxes/releases/tag/v1.4.0


Issues:

   -

   WSO2 API Manager - https://github.com/wso2/puppet-apim/issues
   -

   WSO2 Vagrant Resources to create boxes for WSO2 Products -  https://
   github.com/wso2/vagrant-boxes/issues




How You Can Contribute

Join our mailing list and correspond with the developers directly.

Developer List: d...@wso2.org

User List: u...@wso2.org

Reporting Issues

We encourage you to report issues and documentation faults regarding
WSO2 Ansible,
AWS, Docker, Puppet and Vagrant resource resources through respective
repositories by creating issues.

Thank you!

WSO2 Installation Experience Team
___
Architecture mailing list
Architecture@wso2.org
https://mail.wso2.org/cgi-bin/mailman/listinfo/architecture

Re: [Architecture] WSO2 Identity Server REST API Error Response Standardization

2019-11-01 Thread Isura Karunaratne 
Hi Sominda,

I think it is better to start all the client errors with 400 (Ex USR-400xx)
and server errors with 500 (Ex USR-500xx). In this way, we can get some
understanding of the error by looking at the error code.

Cheers,
Isura.

On Thu, Aug 29, 2019 at 2:44 PM Sominda Gamage  wrote:

> Hi all,
>
> Currently, the REST APIs of Identity Server have different error codes
> such as (20018, 20048, etc.). The error codes in this format have less
> information regarding the cause or where it has occurred.
>
> Therefore, we would like to maintain the error codes which are used in our
> REST APIs in one commonplace. Currently, we are standardizing error codes
> along with their details and this is still a work in progress.
>
> According to this effort, sample error code will look like “
> -
>
> Eg: CQM-10005
>
> The Prefix (first part) indicates the component. In this case, CQM
> indicates Challenge Questions Management.
> The error-identifier-number (the second part of the error code) reflects
> the numerical identifier for the error.
>
> For the rest APIs, we have defined 2 types of codes for both user and
> server APIs.
>
>-
>
>Success codes: For successful operations
>-
>
>Error codes: For error scenarios
>-
>
>   Client Errors
>   -
>
>   Server Errors
>
>
>
> *Success Codes*
>
> Despite the API type, all the success codes will start from 02000 onwards.
> To maintain consistency, a zero will be added at the beginning.
>
> Eg: USR-02001
>
> The above Success Code indicates a successful User Self Registration.
>
>
> *Error Codes*
>
> With the introduction of API error standards, we wish to standardize the
> error response from an API. Therefore, a sample API error response will be
> as follows.
>
> {
>
> “code” : “some_error_code”,
>
> “Message” : “some_error_message”,
>
> “Description” : “some_error_description”,
>
> “traceID” : “correlation_id”
>
> }
>
> A correlationId has been introduced to log the error and send with the
> response
>
>
> *User API errors*
>
> User APIs has two types of errors.
>
>1.
>
>Client errors
>2.
>
>Server errors
>
> *Client Errors in user APIs*
>
> For client errors in user APIs, we have allocated the range starting from
> 100.
>
> Eg: USR-100xx
>
> *Server Errors in user APIs*
>
> For server errors in user APIs, we have allocated the range starting from
> 100.
>
> Eg: USR-150xx
>
>
> *Server API Errors*
>
> Server APIs has two types of errors.
>
>1.
>
>Client errors
>2.
>
>Server errors
>
> *Client errors in server APIs*
>
> For client errors in server APIs, we have allocated the range starting
> from 500.
>
> Eg: USR-500xx
>
> *Server Errors in server APIs*
>
> For server errors in server APIs, we have allocated the range starting
> from 550.
>
> Eg: USR-550xx
>
>
> This will be the new standardization for Rest API Success and Error
> responses.
>
>
> Thanks & Regards,
>
> Sominda.
>
> --
> *Sominda Gamage* | Software Engineer| WSO2 Inc. 
> (M)+94 719873902 | (E) somi...@wso2.com
> 
> ___
> Architecture mailing list
> Architecture@wso2.org
> https://mail.wso2.org/cgi-bin/mailman/listinfo/architecture
>


-- 

*Isura Dilhara Karunaratne*
Technical Lead | WSO2 
*lean.enterprise.middleware*
Email: is...@wso2.com
Mob : +94 772 254 810
Blog : https://medium.com/@isurakarunaratne
___
Architecture mailing list
Architecture@wso2.org
https://mail.wso2.org/cgi-bin/mailman/listinfo/architecture