@boxyhq/saml-jackson 0.1.5-beta.124 → 0.1.5-beta.125
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +9 -6
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -129,14 +129,15 @@ Kubernetes and docker-compose deployment files will be coming soon.
|
|
|
129
129
|
Please follow the instructions [here](https://docs.google.com/document/d/1fk---Z9Ln59u-2toGKUkyO3BF6Dh3dscT2u4J2xHANE) to guide your customers in setting up SAML correctly for your product(s). You should create a copy of the doc and modify it with your custom settings, we have used the values that work for our demo apps.
|
|
130
130
|
|
|
131
131
|
### 1.1 SAML profile/claims/attributes mapping
|
|
132
|
+
|
|
132
133
|
As outlined in the guide above we try and support 4 attributes in the SAML claims - `id`, `email`, `firstName`, `lastName`. This is how the common SAML aattributes map over for most providers, but some providers have custom mappings. Please refer to the documentation on Identity Provider to understand the exact mapping.
|
|
133
134
|
|
|
134
|
-
| SAML Attribute
|
|
135
|
-
|
|
136
|
-
|http://schemas.xmlsoap.org/ws/2005/05/identity/claims/nameidentifier|id|
|
|
137
|
-
|http://schemas.xmlsoap.org/ws/2005/05/identity/claims/emailaddress|email|
|
|
138
|
-
|http://schemas.xmlsoap.org/ws/2005/05/identity/claims/givenname|firstName|
|
|
139
|
-
|http://schemas.xmlsoap.org/ws/2005/05/identity/claims/surname|lastName|
|
|
135
|
+
| SAML Attribute | Jackson mapping |
|
|
136
|
+
| -------------------------------------------------------------------- | --------------- |
|
|
137
|
+
| http://schemas.xmlsoap.org/ws/2005/05/identity/claims/nameidentifier | id |
|
|
138
|
+
| http://schemas.xmlsoap.org/ws/2005/05/identity/claims/emailaddress | email |
|
|
139
|
+
| http://schemas.xmlsoap.org/ws/2005/05/identity/claims/givenname | firstName |
|
|
140
|
+
| http://schemas.xmlsoap.org/ws/2005/05/identity/claims/surname | lastName |
|
|
140
141
|
|
|
141
142
|
### 2. SAML config API
|
|
142
143
|
|
|
@@ -148,6 +149,7 @@ The following API call sets up the configuration in Jackson:
|
|
|
148
149
|
|
|
149
150
|
```
|
|
150
151
|
curl --location --request POST 'http://localhost:6000/api/v1/saml/config' \
|
|
152
|
+
--header 'Authorization: Api-Key <Jackson API Key>' \
|
|
151
153
|
--header 'Content-Type: application/x-www-form-urlencoded' \
|
|
152
154
|
--data-urlencode 'rawMetadata=<IdP/SP metadata XML>' \
|
|
153
155
|
--data-urlencode 'defaultRedirectUrl=http://localhost:3000/login/saml' \
|
|
@@ -276,6 +278,7 @@ The following options are supported and will have to be configured during deploy
|
|
|
276
278
|
| EXTERNAL_URL (npm: externalUrl) | The public URL to reach this service, used internally for documenting the SAML configuration instructions. | `http://{HOST_URL}:{HOST_PORT}` |
|
|
277
279
|
| INTERNAL_HOST_URL | The URL to bind to expose the internal APIs. Do not configure this to a public network. | `localhost` |
|
|
278
280
|
| INTERNAL_HOST_PORT | The port to bind to for the internal APIs. | `6000` |
|
|
281
|
+
| JACKSON_API_KEYS | A comma separated list of API keys that will be validated when serving the Config API requests | |
|
|
279
282
|
| SAML_AUDIENCE (npm: samlAudience) | This is just an identifier to validate the SAML audience, this value will also get configured in the SAML apps created by your customers. Once set do not change this value unless you get your customers to reconfigure their SAML again. It is case-sensitive. This does not have to be a real URL. | `https://saml.boxyhq.com` |
|
|
280
283
|
| IDP_ENABLED (npm: idpEnabled) | Set to `true` to enable IdP initiated login for SAML. SP initiated login is the only recommended flow but you might have to support IdP login at times. | `false` |
|
|
281
284
|
| DB_ENGINE (npm: db.engine) | Supported values are `redis`, `sql`, `mongo`, `mem`. | `sql` |
|