One Identity Safeguard for Privileged Sessions 7.2.1 - REST API Reference Guide

URL

GET https://<IP-address-of-SPS>/api/configuration/mssql/authentication_policies

Cookies

Sample request

The following command lists MSSQL authentication policies.

curl --cookie cookies https://<IP-address-of-SPS>/api/configuration/mssql/authentication_policies

The following command retrieves the properties of a specific policy.

curl --cookie cookies https://<IP-address-of-SPS>/api/configuration/mssql/authentication_policies<object-id>

Response

The following is a sample response received when listing MSSQL authentication policies.

For more information on the meta object, see Message format.

{
  "items": [
    {
      "key": "-200",
      "meta": {
        "href": "/api/configuration/mssql/authentication_policies/-200"
      }
    },
    {
      "key": "-304002001",
      "meta":  { 
        "href": "/api/configuration/mssql/authentication_policies/-304002001"
      }
    }
  ],
  "meta": {
    "first": "/api/configuration/mssql/authentication_policies",
    "href": "/api/configuration/mssql/authentication_policies",
    "last": "/api/configuration/mssql/settings_policies",
    "next": "/api/configuration/mssql/channel_policies",
    "parent": "/api/configuration/mssql",
    "previous": null,
    "transaction": "/api/transaction"
  }
}

When retrieving the endpoint of a specific policy, the response is the following.

{
  "body": {
    "backend": {
      "selection": "ldap"
    },
    "name": "mssql_auth_policy_with_ldap"
  }
}

Examples:

Querying base authentication policy without gateway authentication:

{
  "key": "-304002001",
  "body": {
    "name": "base",
    "backend": {
      "selection": "none"
    }
  }
}

Querying authentication policy with LDAP backend:

{
  "key": "mssql-auth-pol-2",
  "body": {
    "name": "mssql_ldap",
    "backend": {
      "selection": "ldap",
      "timeout": 3600,
      "keepalive": true
    }
  }
}

Querying authentication policy with local backend:

{
  "key": "mssql-auth-pol-3",
  "body": {
    "name": "mssql_local",
    "backend": {
      "selection": "local",
      "user_database": {
        "key": "local-user-database-1",
        "meta": { "href": "/api/configuration/policies/user_databases/local-user-database-1" }
      },
      "timeout": 3600,
      "keepalive": true
    }
  }
}

Querying authentication policy with RADIUS backend:

{
  "key": "mssql-auth-pol-4",
  "body": {
    "name": "mssql_radius",
    "backend": {
      "selection": "radius",
      "servers": [
        {
          "address": {
            "selection": "ip",
            "value": "1.2.3.4"
          },
          "port": 1812,
          "shared_secret": {
            "key": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
            "meta": { "href": "/api/configuration/passwords#XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX" }
          }
        }
      ],
      "authentication_protocol": "pap",
      "timeout": 3600,
      "keepalive": true
    }
  }
}

Add a MSSQL authentication policy

To add a MSSQL authentication policy, you have to:

1. Open a transaction

   For more information, see Open a transaction.

2. Create the JSON object for the new policy.

   POST the JSON object to the https://<IP-address-of-SPS>/api/configuration/mssql/authentication_policies/ endpoint. You can find a detailed description of the available parameters listed in MSSQL authentication policies.

   If the POST request is successful, the response includes the key of the new policy. For example:

   {
     "key": "6f924f39-e4c9-4b0f-8018-8842e2115ebd",
     "meta": {
       "href": "/api/configuration/mssql/authentication_policies/6f924f39-e4c9-4b0f-8018-8842e2115ebd",
       "parent": "/api/configuration/mssql/authentication_policies",
       "transaction": "/api/transaction"
     }
   }

3. Commit your changes

   For more information, see Commit a transaction.

Modify a MSSQL authentication policy

To modify a MSSQL authentication policy, you have to:

1. Open a transaction

   For more information, see Open a transaction.

2. Modify the JSON object of the policy.

   PUT the modified JSON object to the https://<IP-address-of-SPS>/api/configuration/mssql/authentication_policies/<key-of-the-object> endpoint. You can find a detailed description of the available parameters listed in MSSQL authentication policies.

3. Commit your changes

   For more information, see Commit a transaction.