> For the complete documentation index, see [llms.txt](https://cbsso.ortusbooks.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://cbsso.ortusbooks.com/introduction.md).
# Introduction
Welcome to cbSSO a ColdBox module to help integrate SSO into your application easily.
Bundled in this module are several SSO provider implementations that allow you to quickly and easily integrate with Identity Providers such as Microsoft, Google, GitHub or Facebook using standard protocols like SAML and oAuth.
To install run
`box install cbsso`
Once installed you can configure your settings like so
```cfscript
// config/modules/cbsso.cfc
component {
function configure(){
return {
"providers": [
{
type: "GoogleProvider@cbsso",
clientId: getJavaSystem().getProperty( "GOOGLE_CLIENT_ID" ),
clientSecret: getJavaSystem().getProperty( "GOOGLE_CLIENT_SECRET" )
}
]
};
}
}
```
Your app now has the ability to direct users to Google for authentication!
The rest of this documentation will cover topics like
* Built-in Providers
* Custom Providers
* Configuration
* Accessing User Data
* SAML request replay protection and CacheBox configuration
The Microsoft SAML provider validates the signed assertion and binds it to the AuthNRequest that started the login. The resulting response exposes the complete claim set, SAML `NameID`, and `NameID` format. See [Configuration](/usage/configuration.md#saml-request-replay-cache), [MicrosoftSAMLProvider](/providers/built-in-providers/mircosoftsamlprovider.md#validation-and-replay-protection), and [Handling the Identity Provider Response](/usage/handling-the-identity-provider-response.md#reading-the-response) for details.
## Versioning
The cbSSO module is maintained under the [Semantic Versioning](http://semver.org/) guidelines as much as possible. Releases will be numbered in the following format:
```
..
```
And constructed with the following guidelines:
* Breaking backward compatibility bumps the major (and resets the minor and patch)
* New additions without breaking backward compatibility bumps the minor (and resets the patch)
* Bug fixes and misc changes bumps the patch
## License
Apache 2 License: [http://www.apache.org/licenses/LICENSE-2.0](https://www.apache.org/licenses/LICENSE-2.0)
## Important Links
* Code:
* Issues:
## Professional Open Source
The cbSSO module is a professional open-source software backed by [Ortus Solutions, Corp](http://www.ortussolutions.com/services) offering services like:
* Custom Development
* Professional Support & Mentoring
* Training
* Server Tuning
* Security Hardening
* Code Reviews
* [Much More](http://www.ortussolutions.com/services)
### HONOR GOES TO GOD ABOVE ALL
Because of His grace, this project exists. If you don't like this, then don't read it; it's not for you.
> "Therefore being justified by **faith**, we have peace with God through our Lord Jesus Christ: By whom also we have access by **faith** into this **grace** wherein we stand, and rejoice in hope of the glory of God." Romans 5:5
---
# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.
## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.
Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:
```
GET https://cbsso.ortusbooks.com/introduction.md?ask=&goal=
```
`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `build a script that syncs our docs to a CMS` lets GitBook tailor the answer to that use case.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.