One Identity Safeguard for Privileged Sessions 6.9.2

Message format How to configure SPS using REST How to configure SPS using REST: a sample transaction

Authenticate to the SPS REST API Authenticate to the SPS REST API using X.509 certificate Retrieve user information Checking the transaction status Open a transaction Commit a transaction Delete a transaction Reviewing the changelog of a transaction Application level error codes Navigating the configuration of SPS Modifying the configuration of SPS

Delete an object Create a new object Change an object

Basic settings

Retrieve basic firmware and host information Network settings

Web interface Network configuration options DNS servers Routing between interfaces Naming options Network addresses Routing table Local services of SPS Local services: Web login for administrators Local services: Web login for users Local services: cluster interface System backup policy Encrypting system backup policy

Date and time

Date & time NTP servers Timezone

Logs, monitoring and alerts

Management options Syslog server settings Disk fill-up prevention Mail settings Health monitoring SNMP settings SNMP traps Local services: access for SNMP agents Alerting System alerts Traffic alerts

Trust stores

User management and access control

User management and access control Authentication and user database settings Privileges of usergroups Audit data access rules Active sessions Manage users and usergroups locally on SPS Manage usergroups locally on SPS Manage users locally on SPS

Managing SPS

Troubleshooting options Internal certificates Passwords stored on SPS Private keys stored on SPS Certificates stored on SPS Local services: enabling SSH access to the SPS host RPC API Manage the SPS license Change contact information Splunk integration Splunk integration Manage Safeguard for Privileged Sessions clusters

Promote a Safeguard for Privileged Sessions node to be the Central Management node in a new cluster Join node(s) to the cluster Query join status Assign a role to a node Query nodes Query one particular node Query the status of all nodes in the cluster Query the status of one particular node Upload and enable a configuration synchronization plugin Disable a configuration synchronization plugin

General connection settings

Channel policy Policies Archive/Cleanup policy Audit policies Backup policy Real-time content monitoring with Content Policies LDAP servers Signing CA policies Time policy Trusted Certificate Authorities Local user databases User lists

HTTP connections

HTTP connections HTTP connection policies HTTP channels HTTP authentication policies Global HTTP options HTTP settings policies

Citrix ICA connections

ICA connections ICA connection policies ICA channels Global ICA options ICA settings policies

MSSQL connections

Limitations in handling MSSQL connections MSSQL connections MSSQL connection policies MSSQL channels MSSQL authentication policies Global MSSQL options MSSQL settings policies

RDP connections

RDP connections RDP connection policies RDP channels Configuring domain membership Global RDP options RDP settings policies

SSH connections

SSH connections SSH connection policies SSH channels SSH authentication policies Global SSH options SSH settings policies SSH host keys and certificates

Telnet connections

Telnet connections Telnet connection policies Telnet channels Telnet authentication policies Global Telnet options Telnet pattern sets

VNC connections

VNC connections VNC connection policies Global VNC options

Search, download, and index sessions

Audited sessions Download audit trails Searching in the session database Searching in connection content Generate and retrieve screenshot for content search Session statistics Session histogram Session alerts Session events Indexing sessions Session audit trail downloads Local services: configuring the indexer Indexer policies

Reporting

Reporting Reports Built-in subchapters Pre-defined reports Content subchapters Custom subchapters Connection statistics subchapters

Health and maintenance

Monitor appliance health status

Advanced authentication and authorization

Usermapping policy Plugins

Upload a plugin Delete a plugin Check the integrity of a plugin

Authentication and authorization plugins

Configuring Authentication and Authorization plugin instances

Credential store plugins Credential stores

Completing the Welcome Wizard using REST

Enable and configure analytics using REST

Enable One Identity Safeguard for Privileged Analytics Configure One Identity Safeguard for Privileged Analytics

MSSQL connections

MSSQL connections > MSSQL connections

List of endpoints for configuring the policies, options and connection rules of MSSQL connections.

URL

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

Cookies

Cookie name	Description	Required	Values
session_id	Contains the authentication token of the user	Required	The value of the session ID cookie received from the REST server in the authentication response, for example, a1f71d030e657634730b9e887cb59a5e56162860. For details on authentication, see Authenticate to the SPS REST API. Note that this session ID refers to the connection between the REST client and the SPS REST API. It is not related to the sessions that SPS records (and which also have a session ID, but in a different format).

Cookie name

Description

Required

Values

session_id

Contains the authentication token of the user

Required

The value of the session ID cookie received from the REST server in the authentication response, for example, a1f71d030e657634730b9e887cb59a5e56162860. For details on authentication, see Authenticate to the SPS REST API.

Note that this session ID refers to the connection between the REST client and the SPS REST API. It is not related to the sessions that SPS records (and which also have a session ID, but in a different format).

Sample request

The following command lists the available settings for configuring for MSSQL connections.

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

Response

The following is a sample response received when listing the configuration settings.

For details of the meta object, see Message format.

{
  "items": [
    {
      "key": "authentication_policies",
      "meta": {
        "href": "/api/configuration/mssql/authentication_policies"
      }
    },
    {
      "key": "channel_policies",
      "meta": {
        "href": "/api/configuration/mssql/channel_policies"
      }
    },
    {
      "key": "connections",
      "meta": {
        "href": "/api/configuration/mssql/connections"
      }
    },
    {
      "key": "options",
      "meta": {
        "href": "/api/configuration/mssql/options"
      }
    },
    {
      "key": "settings_policies",
      "meta": {
        "href": "/api/configuration/mssql/settings_policies"
      }
    }
  ],
  "meta": {
    "first": "/api/configuration/aaa",
    "href": "/api/configuration/mssql",
    "last": "/api/configuration/x509",
    "next": "/api/configuration/network",
    "parent": "/api/configuration",
    "previous": "/api/configuration/management",
    "remaining_seconds": 600,
    "transaction": "/api/transaction"
  }
}

Item	Description
connections	List of connection policies.
authentication_policies	List of the default and custom authentication policies.
channel_policies	List of the default and custom channel policies.
options	List of global MSSQL options that affect all connections.
settings_policies	List of protocol-level settings (idle and session timeout). You can create multiple variations, and choose the appropriate one for each connection policy.

Status and error codes

The following table lists the typical status and error codes for this request. For a complete list of error codes, see Application level error codes.

Code	Description	Notes
401	Unauthenticated	The requested resource cannot be retrieved because the client is not authenticated and the resource requires authorization to access it. The details section contains the path that was attempted to be accessed, but could not be retrieved.
403	Unauthorized	The requested resource cannot be retrieved because the client is not authorized to access it. The details section contains the path that was attempted to be accessed, but could not be retrieved.
404	NotFound	The requested object does not exist.

MSSQL connection policies

MSSQL connections > MSSQL connection policies

Connection policies determine if a server can be accessed from a particular client. Connection policies reference other resources (policies, usergroups, keys) that must be configured and available before creating a connection policy.

URL

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

Cookies

Cookie name	Description	Required	Values
session_id	Contains the authentication token of the user	Required	The value of the session ID cookie received from the REST server in the authentication response, for example, a1f71d030e657634730b9e887cb59a5e56162860. For details on authentication, see Authenticate to the SPS REST API. Note that this session ID refers to the connection between the REST client and the SPS REST API. It is not related to the sessions that SPS records (and which also have a session ID, but in a different format).

Cookie name

Description

Required

Values

session_id

Contains the authentication token of the user

Required

Sample request

The following command lists MSSQL connection policies.

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

The following command retrieves the properties of a specific policy.

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

Response

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

For details of the meta object, see Message format.

{
  "items": [
    {
      "key": "19443158785dee0621437ad",
      "meta": {
        "href": "/api/configuration/mssql/connections/19443158785dee0621437ad"
      }
    }
  ],
  "meta": {
    "first": "/api/configuration/mssql/channel_policies",
    "href": "/api/configuration/mssql/connections",
    "last": "/api/configuration/mssql/options",
    "next": "/api/configuration/mssql/options",
    "order": "/api/configuration/mssql/connections/@order",
    "parent": "/api/configuration/mssql",
    "previous": "/api/configuration/mssql/channel_policies",
    "remaining_seconds": 600,
    "transaction": "/api/transaction"
  }
}

When retrieving the endpoint of a specific MSSQL Connection Policy, the response is the following.

{
  "body": {
    "access_control": [],
    "active": true,
    "channel_database_cleanup": {
      "enabled": false
    },
    "indexing": {
      "enabled": true,
      "policy": {
        "key": "-50000",
        "meta": {
          "href": "/api/configuration/policies/indexing/-50000"
        }
      },
      "priority": 3
    },
    "log_audit_trail_downloads": true,
    "name": "demo_mssql",
    "network": {
      "clients": [
        "0.0.0.0/0"
      ],
      "ports": [
        1433
      ],
      "targets": [
        "192.168.1.1/24"
      ]
    },
    "override_log_level": {
      "enabled": false
    },
    "policies": {
      "aa_plugin": null,
      "analytics_policy": {
        "key": "20509709385cd578654cdab",
        "meta": {
          "href": "/api/configuration/policies/analytics/20509709385cd578654cdab"
        }
      },
      "archive_cleanup_policy": null,
      "audit_policy": {
        "key": "78101850949e47437dd91d",
        "meta": {
          "href": "/api/configuration/policies/audit_policies/78101850949e47437dd91d"
        }
      },
      "authentication_policy": {
        "key": "-30700201",
        "meta": {
          "href": "/api/configuration/mssql/authentication_policies/-30700201"
        }
      },
      "backup_policy": null,
      "channel_policy": {
        "key": "-30700102",
        "meta": {
          "href": "/api/configuration/mssql/channel_policies/-30700102"
        }
      },
      "credential_store": null,
      "ldap_server": null,
      "settings": {
        "key": "-30700301",
        "meta": {
          "href": "/api/configuration/mssql/settings_policies/-30700301"
        }
      },
      "usermapping_policy": null
    },
    "rate_limit": {
      "enabled": false
    },
    "server_address": {
      "custom_dns": {
        "enabled": false
      },
      "selection": "original"
    },
    "source_address": {
      "selection": "box_address"
    },
    "transport_security": {
      "selection": "disabled"
    },
    "web_gateway_authentication": {
      "enabled": false
    }
  },
  "key": "19443158785dee0621437ad",
  "meta": {
    "first": "/api/configuration/mssql/connections/19443158785dee0621437ad",
    "href": "/api/configuration/mssql/connections/19443158785dee0621437ad",
    "last": "/api/configuration/mssql/connections/19443158785dee0621437ad",
    "next": null,
    "parent": "/api/configuration/mssql/connections",
    "previous": null,
    "remaining_seconds": 600,
    "transaction": "/api/transaction"
  }
}

Element			Type	Description
key			string	Top level element, contains the ID of the connection policy.
body			Top level element (string)	The elements of the connection policy.
	access_control		Top level list	Collection of access policies. Access policies define who can authorize and audit a connection.
	active		boolean	Set to false to suspend the connection policy. Connection settings are preserved.
	channel_database_cleanup		Top level item	Configures cleanup of the connection metadata on the connection policy's level.
		days	int	Retention time, in days. Must not exceed the retention time of the archive_cleanup_policy, and the retention time configured in the global settings of the protocol. The global settings of the MSSQL protocol are available at the api/configuration/mssql/options endpoint.
		enabled	boolean	Set to true to enable periodical cleanup of the connection metadata.
	indexing		Top level item	Configures indexing for the connection policy.
		enabled	boolean	Set to true to enable indexing the connections.
		policy	string	References the identifier of the indexing policy. You can configure indexing policies at the /api/configuration/policies/indexing/ endpoint. To modify or add an indexing policy, use the value of the returned key as the value of the policy element, and remove any child elements (including the key).
		priority	int	Specifies the indexing priority for the connection. Possible values are: 5 Very low priority. 4 Low priority. 3 Normal (default) priority. 2 High priority. 1 Very high priority. 0 Near real-time priority.
	log_audit_trail_downloads		boolean	Set to true to log audit trail downloads.
	name		string	The name of the connection policy.
	network
		clients	list, string	List of client ("from") IP addresses.
		ports	list, integers	List of target ports.
		targets	list, string	List of target IP addresses.
	override_log_level		Top level item	Specifies the verbosity level of sessions handled by this connection policy. The log level of other connection policies is not affected. If disabled, the log level set at the /api/configuration/<protocol>/options endpoint is used. To use the default log level, disable this option: "override_log_level": { "enabled": false }, To use a custom log level for the connection policy, enable this option and set the log level to use: "override_log_level": { "enabled": true, "log_level": 5 },
	policies		Top level item	List of policies referenced by the connection policy.
		aa_plugin	string	References the identifier of the AA plug-in. You can configure AA plug-ins at the /api/configuration/plugins/aa/ endpoint. To modify or add an AA plug-in, use the value of the returned key as the value of the aa_plugin element, and remove any child elements (including the key).
		analytics_policy	string	References the identifier of the analytics policy. You can configure analytics policies at the /api/configuration/analytics/ endpoint. To add or modify an analytics policy, use the value of the returned key as the value of the analytics element, and remove any child elements (including the key).
		archive_cleanup_policy	string	References the identifier of the archive/cleanup policy. You can configure archive and cleanup policies at the /api/configuration/policies/archive_cleanup_policies/ endpoint. To modify or add an archive/cleanup policy, use the value of the returned key as the value of the archive_cleanup_policy element, and remove any child elements (including the key).
		audit_policy	string	Cannot be null. References the identifier of the audit policy. You can configure audit policies at the /api/configuration/policies/audit_policies/ endpoint. To modify or add an audit policy, use the value of the returned key as the value of the audit_policy element, and remove any child elements (including the key).
		authentication_policy	string	Cannot be null. References the identifier of the authentication policy. Note that currently you cannot create or modify MSSQL Authentication Policies using the REST API. Use the web UI instead. To modify or add an authentication policy, use the value of the returned key as the value of the authentication_policy element, and remove any child elements (including the key).
		backup_policy	string	References the identifier of the backup policy. You can configure backup policies at the /api/configuration/policies/backup_policies/ endpoint. To modify or add a backup policy, use the value of the returned key as the value of the backup_policy element, and remove any child elements (including the key).
		channel_policy	string	References the identifier of the channel policy. The value of this option cannot be null. To modify or add a channel policy, use the value of the returned key as the value of the channel_policy element, and remove any child elements (including the key). You can configure MSSQL channel policies at the /api/configuration/mssql/channel_policies/ endpoint.
		credential_store	string	References the identifier of the credential store. You can configure credential stores at the /api/configuration/policies/credentialstores/ endpoint. To modify or add a credential store, use the value of the returned key as the value of the credential_store element, and remove any child elements (including the key).
		ldap_server	string	References the identifier of the LDAP server. You can configure LDAP servers at the /api/configuration/policies/ldap_servers/ endpoint. To modify or add an LDAP server, use the value of the returned key as the value of the ldap_server element, and remove any child elements (including the key).
		settings	string	References the identifier of the settings policy. The value of this option cannot be null. To modify or add a settings policy for this protocol, use the value of the returned key as the value of the settings element, and remove any child elements (including the key).
		usermapping_policy	string	References the identifier of a Usermapping Policy. You can configure Usermapping Policies at the /api/configuration/policies/usermapping_policies/ endpoint. To modify or add a Usermapping Policy, use the value of the returned key as the value of the usermapping_policies element, and remove any child elements (including the key).
	rate_limit		Top level element	Connection rate limit.
		enabled	boolean	Set to true to provide a connection rate limit.
		value	int	The number of connections (per minute) that are allowed in the connection policy.
	server_address		Top level item	Defines the address where the clients connect to.
	source_address		Top level element	Allows you to configure Source Network Address Translation (SNAT) on the server side of SPS. SNAT determines the IP address SPS uses in the server-side connection. The target server will see the connection coming from this address.
		selection	string	Configures Source Network Address Translation. Possible values are: box_address Default. Uses the network address of the logical interface of SPS. original Uses the IP address of the client, as seen by SPS. fix Uses a fixed address when connecting to the remote server. Must be used with the address element.
		address	string	Must be used if the value of the selection element is set to fix. The IP address to use as the source address in server-side connections.
	transport_security		Top level element	Configures the encryption used in the sessions.
		certificate	JSON object	Selects the certificate to show to the peers. You have the following options: Use the same certificate for each client: Select this option if you want to use the same certificate for every peer. Note that you must reference a certificate that includes its private key that you have already uploaded to SPS. For details, see Certificates stored on SPS. "certificate": { "selection": "fix", "x509_identity": "893b7eb7-8c6f-403a-ba3a-1d09dc4b4c7a" } Generate a certificate for each client: Select this option if you want to generate a certificate for each client. Note that you must reference a Signing CA that you have already configured on SPS. For details, see Signing CA policies. "certificate": { "selection": "generate", "signing_ca": "1904188625a843f11d30a5" },
		selection	disabled \| tls	Configures the encryption used in the sessions. disabled: Disables TLS encryption for MSSQL connections completely. "transport_security": { "selection": "disabled" }, tls: Enables TLS-encryption. Note that you must also set the certificate and server_certificate_check options. "transport_security": { "certificate": { "selection": "generate", "signing_ca": "19605948865d07511f09eca" }, "selection": "tls", "server_certificate_check": { "enabled": true, "trusted_ca": "1241814345d074efd1ded7" } }
		server_certificate_check	JSON object	By default, SPS accepts any certificate shown by the server. "server_certificate_check": { "enabled": false }, To verify the certificate of the destination server, configure and reference a Trusted CA list. "server_certificate_check": { "enabled": true, "trusted_ca": "9106862955a844051d7bf6" },
	web_gateway_authentication		Top level item	When gateway authentication is required for a connection, the user must authenticate on SPS as well. This additional authentication can be performed out-of-band on the SPS web interface for every protocol.
		enabled	boolean	Set to true to enable additional gateway authentication on the SPS web interface.
		groups	list, string	By default, any user can perform gateway authentication for the connections. You can restrict authentication to members of specific usergroups. Define the usergroups at the /api/configuration/aaa/local_database/groups/ endpoint, and list the name of each group here.
		require_same_ip	boolean	Set to true to only accept web gateway authentication from the same host that initiated the connection.

Elements of access_control		Type	Description
authorizer		string	The usergroup (local or LDAP) who can authorize or audit the connection. Local usergroups can be added or modified at the /api/configuration/aaa/local_database/groups/ endpoint.
permission		string	Defines the permissions of the authorizer usergroup. Possible values are: audit The usergroup with the audit permission can monitor ongoing connections, and download the audit trails of a closed and indexed connection. authorize The usergroup with the authorize permission can authorize connection requests. audit_and_authorize The usergroup with the audit_and_authorize permission can authorize connection requests, monitor connections, and download the audit trail of closed and indexed connections.
require_different_ip		boolean	Set to true to require the authorizing user and its subject to have different IP addresses.
require_different_username		boolean	Set to true to require the authorizing user and its subject to have different usernames.
subject		Top level item	Defines the subjects of the access control policy.
	group	string	The usergroup (local or LDAP) that is subject to the access control policy. Local usergroups can be added or modified at the /api/configuration/aaa/local_database/groups/ endpoint.
	selection	string	Possible values: everybody Every user is subject to the access control policy. only Requires the group element. Members of the usergroup specified in the group element are subject to the access control policy.

Elements of server_address

Elements of server_address			Type	Description
custom_dns			string	Configures a DNS server that is used to reverse-resolve the hostname if the Channel Policy contains the address of the target as a hostname instead of an IP address. By default, this is disabled and SPS uses the DNS server set in the /api/configuration/network/dns endpoint. To use the default DNS, disable this option: "server_address": { "custom_dns": { "enabled": false }, ... }, To use a custom DNS, enable this option and set the IP address of the domain name server to use: "server_address": { "custom_dns": { "enabled": true, "server": "192.168.1.1" }, ... },
selection			string	Configures the address where the clients connect to. Possible values are: original Connect to the same address specified by the client. nat Perform a network address translation on the target address. Must be used with the network element. fix Must be used with the address and port elements. inband Extract the address of the server from the username. Must be used with the domains element. Optional elements: exception_domains, dns_server, and dns_suffixes.
network			string	Must be used if selection is set to nat. The target address in IP/prefix format. Example: "10.20.30.40/24".
address			string	Must be used if selection is set to fix. The IP address of the target server.
port			int	Must be used if selection is set to fix. The port of the target server.
domains			Top level list	Must be used if selection is set to inband.
	domain		Top level item	Lists the address ranges that are included in the connection policy.
		selection	string	Specifies if the target address range is provided as a domain or as an IP range. Possible values are: address The value of the target address is an IP range. domain The value of the target address is a domain.
		value	string	The address range of the target server(s). Use the selection element to specify if the address is an IP range, or a domain.
	port		int	The port of the targer server(s).
exception_domains			Top level list	Can only be used if selection is set to inband. Lists the address ranges that are excluded from the connection policy.
	domain		Top level item	Contains the excluded address range.
		selection	string	Specifies if the excluded address(es) are provided as a domain or as an IP range. Possible values are: address The value of the excluded address is an IP range. domain The value of the excluded address is a domain.
		value	string	The excluded address(es). Use the selection element to specify if the address is an IP range, or a domain.
	port		int	The excluded port.
dns_server			string	Can only be used if selection is set to inband. IP address or the hostname of the domain name server used to resolve the address of the target server.
dns_suffixes			list, string	Can only be used if selection is set to inband. If the clients do not include the domain name when addressing the server (for example they use username@server instead of username@server.example.com), SPS can automatically add domain information (for example example.com). You can add multiple domain names. SPS attempts to resolve the target address by appending the domain names in the provided order, and uses the first successfully resolved address to establish the connection.

Status and error codes

The following table lists the typical status and error codes for this request. For a complete list of error codes, see Application level error codes.

Code	Description	Notes
201	Created	The new resource was successfully created.
400	InvalidQuery	The requested filter or its value is invalid.
401	Unauthenticated	The requested resource cannot be retrieved because the client is not authenticated and the resource requires authorization to access it. The details section contains the path that was attempted to be accessed, but could not be retrieved.
403	Unauthorized	The requested resource cannot be retrieved because the client is not authorized to access it. The details section contains the path that was attempted to be accessed, but could not be retrieved.
404	NotFound	The requested object does not exist.

Add a MSSQL connection policy

To add a MSSQL connection policy, you have to:

Open a transaction.

For details, see Open a transaction.
Create the JSON object for the new MSSQL connection policy.

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

If the POST request is successful, the response includes the key of the new MSSQL connection policy. For example:
```
{
  "key": "a99be49b-b0a2-4cf9-b70d-fea1f9ea188f",
  "meta": {
    "href": "/api/configuration/mssql/connections/a99be49b-b0a2-4cf9-b70d-fea1f9ea188f",
    "parent": "/api/configuration/mssql/connections",
    "transaction": "/api/transaction"
  }
}
```
Commit your changes.

For details, see Commit a transaction.

Modify a MSSQL connection policy

To modify a MSSQL connection policy, you have to:

Open a transaction.

For details, see Open a transaction.
Modify the JSON object of the connection policy.

PUT the modified JSON object to the https://<IP-address-of-SPS>/api/configuration/mssql/connections/<key-of-the-object> endpoint. You can find a detailed description of the available parameters listed in Element .
Commit your changes.

For details, see Commit a transaction.

MSSQL channels

MSSQL connections > MSSQL channels

The available MSSQL channel types and their functionalities are described below. For details on configuring channel policies, see Channel policy.

Channel	Special options	Description
mssql	Yes	mssql: Enables access to the MSSQL server. This channel must be enabled for MSSQL to work. Channel-specific actions: content_policy reference: The ID of the Content policy to apply to the connection. For example: "actions": { "audit": true, "four_eyes": true, "content_policy": { "key": "433849548566ab327522e6" "meta": { "href": "/api/configuration/policies/content_policies/44287216854f482e7f2b24" } }, }

Channel

Special options

Description

mssql

Yes

mssql: Enables access to the MSSQL server. This channel must be enabled for MSSQL to work.

Channel-specific actions:

content_policy reference: The ID of the Content policy to apply to the connection.

For example:

"actions": {
  "audit": true,
  "four_eyes": true,
  "content_policy": {
    "key": "433849548566ab327522e6"
    "meta": {
      "href": "/api/configuration/policies/content_policies/44287216854f482e7f2b24"
    }
  },
}

MSSQL authentication policies

MSSQL connections > MSSQL authentication policies

Lists the configured authentication methods that can be used in a connection. Each connection policy uses an authentication policy to determine how the client can authenticate on the SPS gateway.

URL

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

Cookies

Cookie name	Description	Required	Values
session_id	Contains the authentication token of the user	Required	The value of the session ID cookie received from the REST server in the authentication response, for example, a1f71d030e657634730b9e887cb59a5e56162860. For details on authentication, see Authenticate to the SPS REST API. Note that this session ID refers to the connection between the REST client and the SPS REST API. It is not related to the sessions that SPS records (and which also have a session ID, but in a different format).

Cookie name

Description

Required

Values

session_id

Contains the authentication token of the user

Required

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 details of 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"
  }
}

Element			Type	Description
key			string	Top level element, contains the ID of the policy.
body			Top level element	Contains the elements of the policy.
	name		string	The name of the object. This name is also displayed on the SPS web interface. It cannot contain whitespace.
	backend		Top level item	Client-side gateway authentication settings. The value of selection defines which authentication method is used.
		selection	string	Defines the authentication method for client-side gateway authentication. Possible values are: none Disables client-side gateway authentication. ldap Uses the LDAP server selected for the connection policy. LDAP servers can be configured in the /api/configuration/policies/ldap_servers endpoint). To use this option, you must also configure the certificate, password, and public_key elements. local Uses the local user database configured in the /api/configuration/policies/user_databases/ endpoint. To use this option, you must also configure the user_database element. radius Uses one or more Radius servers for authentication. To use this option, you must also configure the authentication_protocol and servers elements.
		servers	Top level list	Only if selection is set to radius Defines the properties of the RADIUS servers used for client-side authentication. A valid list item consists of the address, port and shared_secret elements.
		authentication_protocol	Top level item	Only if selection is set to radius RADIUS setting. Set to pap to use the Password Authentication Protocol. To use the Challenge-Handshake Authentication Protocol, set it to chap.
		user_database	string	Only if selection is set to local References the key of the local user database. You can configure local user databases at the /api/configuration/policies/user_databases/ endpoint. To modify or add a local user database, use the value of the returned key as the value of the user_database element, and remove any child elements (including the key).
		timeout	integer (seconds)	Specify the time remaining until a successful gateway authentication times out.
		keepalive	boolean	Set to true to avoid interruptions for active HTTP sessions. Active HTTP sessions can extend the gateway authentication beyond the configured timeout.

Elements of servers		Type	Description
address		Top level element	Defines the address of a RADIUS server.
	selection	string	Required child of the address element. Possible values are: ip The value element contains the IP of the RADIUS server. fqdn The value element contains the FQDN of the RADIUS server.
	value	string	The IP or the FQDN address of the RADIUS server.
port		int	The port number of the RADIUS server.
shared_secret		string	References the key of the shared secret for the RADIUS server. You can configure shared secrets at the /api/configuration/passwords/ endpoint. To modify or add a shared secret, use the value of the returned key as the value of the shared_secret element, and remove any child elements (including the key). Alternatively, you can include the new password as plain text. "shared_secret": { "plain": "<new-password>" }

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
    }
  }
}

Status and error codes

The following table lists the typical status and error codes for this request. For a complete list of error codes, see Application level error codes.

Code	Description	Notes
201	Created	The new resource was successfully created.
400	InvalidQuery	The requested filter or its value is invalid.
401	Unauthenticated	The requested resource cannot be retrieved because the client is not authenticated and the resource requires authorization to access it. The details section contains the path that was attempted to be accessed, but could not be retrieved.
403	Unauthorized	The requested resource cannot be retrieved because the client is not authorized to access it. The details section contains the path that was attempted to be accessed, but could not be retrieved.
404	NotFound	The requested object does not exist.

Add a MSSQL authentication policy

To add a MSSQL authentication policy, you have to:

Open a transaction.

For details, see Open a transaction.
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"
  }
}
```
Commit your changes.

For details, see Commit a transaction.

Modify a MSSQL authentication policy

To modify a MSSQL authentication policy, you have to:

Open a transaction.

For details, see Open a transaction.
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.
Commit your changes.

For details, see Commit a transaction.

Seleziona il prodotto:

Per una maggiore efficacia, compilare l'Obiettivo della chat:

Soluzioni consigliate per il problema

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

MSSQL connections

URL

Cookies

Sample request

Response

Status and error codes

MSSQL connection policies

URL

Cookies

Sample request

Response

Use the same certificate for each client:

Generate a certificate for each client:

Elements of server_address

Status and error codes

Add a MSSQL connection policy

Open a transaction.

Create the JSON object for the new MSSQL connection policy.

Commit your changes.

Modify a MSSQL connection policy

Open a transaction.

Modify the JSON object of the connection policy.

Commit your changes.

MSSQL channels

MSSQL authentication policies

URL

Cookies

Sample request

Response

Examples:

Status and error codes

Add a MSSQL authentication policy

Open a transaction.

Create the JSON object for the new policy.

Commit your changes.

Modify a MSSQL authentication policy

Open a transaction.

Modify the JSON object of the policy.

Commit your changes.