Tenable Security Center API: SAML

This resource may only be used by administrators. Only 1 SAML association is currently supported (which will always be ID "1").

/saml

Methods
GET

Gets the list of SAML associations.

Fields Parameter
Expand

The fields parameter should be specified along the query string, and it takes the syntax

    ?fields=<field>,...

Allowed Fields

**id
**name
**samlEnabled
*type
*entityID
*description
*idp
*usernameAttribute
*singleSignOnService
*singleLogoutService
*certData
*createdTime
*modifiedTime

Legend

* = always comes back
** = comes back if fields list not specified on GET all

Example Response
Expand
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
{
    "type" : "regular",
    "response": [
        {
            "id" : "1",
            "name" : "",
            "description" : "SAML Association",
            "entityID" : "http://www.samlprovider.com/str",
            "idp" : "http://www.samlprovider.com/str",
            "usernameAttribute" : "",
            "singleSignOnService" : "https://dev-x.y.com/app/tenabledev/str/sso/saml",
            "singleLogoutService" : "https://dev-x.y.com/app/tenabledev/str/sso/saml",
            "certData" : "certdata",
            "createdTime" : "1543852867",
            "modifiedTime" : "1546641092",
            "type" : "saml2",
            "samlEnabled" : "true"      }
    ],
    "error_code": 0,
    "error_msg" : "",
    "warnings": [],
    "timestamp": 1546642280
}

/saml/{id}

Methods
GET

Gets the SAML associated with {id}.

Fields Parameter
Expand

The fields parameter should be specified along the query string, and it takes the syntax

    ?fields=<field>,...

Allowed Fields

**id
**name
**samlEnabled
*type
*entityID
*description
*idp
*usernameAttribute
*singleSignOnService
*singleLogoutService
*certData
*createdTime
*modifiedTime

Legend

* = always comes back
** = comes back if fields list not specified on GET all

Request Parameters

None

Example Response
Expand
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
{
    "type" : "regular",
    "response": {
        "id" : "1",
        "name" : "",
        "description" : "SAML Association",
        "entityID" : "http://www.samlprovider.com/str",
        "idp" : "http://www.samlprovider.com/str",
        "usernameAttribute" : "",
        "singleSignOnService" : "https://dev-x.y.com/app/tenabledev/str/sso/saml",
        "singleLogoutService" : "https://dev-x.y.com/app/tenabledev/str/sso/saml",
        "certData" : "certdata",
        "createdTime" : "1543852867",
        "modifiedTime" : "1546641092",
        "type" : "saml2",
        "samlEnabled" : "true"  },
    "error_code": 0,
    "error_msg" : "",
    "warnings": [],
    "timestamp": 1546642280
}
PATCH

Edits the SAML associated with {id} , changing only the passed in fields.

Request Parameters

(All fields are optional EXCEPT samlEnabled, which must be set to "true" or "false")

Expand
1
2
3
4
5
6
7
8
9
10
11
{
    "name" : <string>,
    "description" : <string>,
    "type" : <string> "saml2" | "shibboleth",
    "entityID" : <string>,
    "idp" : <string>,
    "usernameAttribute" : <string>,
    "singleSignOnService" : <string>,
    "singleLogoutService" : <string>,
    "certData" : <string>,
    "samlEnabled" : <string> "false" | "true"}
Example Response
See /saml/{id}::GET

/saml/getMetadata

Methods
GET

Gets the SC XML metadata file.

Example Response
Expand
1
2
3
4
5
6
7
8
9
{
    "type" : "regular",
    "response": {
        "filePath" : "saml/module.php/saml/sp/metadata.php/1"   },
    "error_code": 0,
    "error_msg" : "",
    "warnings": [],
    "timestamp": 1546642827
}