Welcome to NodeConductor SAML2 plugin’s documentation!¶

NodeConductor plugin bringing SAML2-based authentication support.

Guide¶

Clone NodeConductor SAML2 repository

git clone https://github.com/opennode/nodeconductor-saml2.git

Install NodeConductor SAML2 into NodeConductor virtual environment
```
cd /path/to/nodeconductor-saml2/
python setup.py install
```

Endpoint URL: /api-auth/saml2/

Valid request example:

POST /api-auth/saml2/ HTTP/1.1
Accept: application/json
Content-Type: application/json
Host: example.com

{
    "saml2response": "SAML_PAYLOAD",
}

Success response example:

HTTP/1.0 200 OK
Allow: POST, OPTIONS
Content-Type: application/json
Vary: Accept, Cookie

{
    "token": "c84d653b9ec92c6cbac41c706593e66f567a7fa4"
}

Invalid token can result in a failure like in the example below. In this case please enable/check concrete problem in SAML2 log file.

HTTP/1.0 401 UNAUTHORIZED
Allow: POST, OPTIONS
Content-Type: application/json

{
    "saml2response": ["SAML2 response has errors."]
}

SAML2

Supported actions and methods:

/api-auth/saml2/

Methods: POST

Supported fields for creation:

NodeConductor SAML2 plugin is open-source under Apache v2 license.