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

Use for RDP connections only. In a domainless environment, use default_namespace.

Must be used if the selection element is set to external_plugin.

References the Credential Store plugin. You can find the list of available plugins at the /api/configuration/plugins/credentialstore/ endpoint.

To modify or add a plugin, use the value of the returned key as the value of the plugin element, and remove any child elements (including the key).

Plugins can only be uploaded using the web interface of SPS.

Configures the type of the credential store. Possible values are:

• local

  Local credential store. Can only be configured using the web interface of SPS.

• external_plugin

  Credential Store Plug-in. To upload or update a plugin, see Upload a plugin.

Declares if the value element contains an IP or an FQDN. Possible values are:

• fqdn

  The value element contains a hostname.

• ip

  The value element contains an IP.

Must be used if the selection element is set to fixed_username.

References the password SPS uses to authenticate on the ERPM server. You can configure passwords at the /api/configuration/passwords/ endpoint.

To modify or add a password, use the value of the returned key as the value of the password element, and remove any child elements (including the key).

Possible values are:

• fixed_username

  SPS uses a fix username and password.

  Requires the username and password elements.

• gateway_auth_credentials

  SPS uses the username and password that the user provided during the gateway authentication process.

  Can only be used for SSH connections.

Your SPS license as a string. You can download your license from support portal. Replace the line-breaks in the license file with \n characters, for example:

"license": "Product: Shell Control Box\nEdition: Single\n[...]",

Note that you can complete the Welcome Wizard without uploading a license. In this case, SPS will start in demo mode. To skip uploading the license, use the null value:

"license": null,

To upload a license file, see Upload a new license.

Contains the passwords of the root and admin users, for example:

"administration": {
                  "root_password": "asdgf-sdffe-aasc-oijernf",
                  "admin_password": "bd9r3-adedfk2-fsdf-fs"
              },

Contains the SMTP server to use, and the e-mail address of the SPS administrator. For example:

"email": {
                  "smtp_server": "smtp.example.com",
                  "admin_email": "psm-administrator@example.com"
              },

Name of the machine running SPS. For example:

"hostname": "psm",

Name of the domain used on the network. For example:

"domainname": "example.com",

The IP address of interface 1 (or EXT, for older hardware) of SPS (for example, 192.168.1.1). The IP address can be chosen from the range of the corresponding physical subnet. Clients will connect to this interface, therefore it must be accessible to them. The IP prefix of the given range. For example, general class C networks have the /24 prefix.

"initial_address": "192.168.1.10/24",

Use an IPv4 address.

The VLAN ID of interface 1 (or EXT). Optional, use null if it is not set. For example:

"vlantag": null,

The IP address of the default gateway.

"gateway": "192.168.1.1",

Use an IPv4 address.

The internal certificates of SPS.

"certificates": {
                  "ca": {
                      "certificate": "-----BEGIN CERTIFICATE-----\nMIIEWTCCA0GgAwIBAgIBAjANBgkqhkiG9w0BAQ0FADCBzDELMAkGA1UEBhMCUk8x\n...\n-----END CERTIFICATE-----\n"
                  },
                  "webserver": {
                      "certificate": "-----BEGIN CERTIFICATE-----\nMIIEWTCCA0GgAwIBAgIBAjANBgkqhkiG9w0BAQ0FADCBzDELMAkGA1UEBhMCUk8x\n...\n-----END CERTIFICATE-----\n",
                      "private_key": "-----BEGIN RSA PRIVATE KEY-----\nMIIEogIBAAKCAQEA/JERC+o1UksvUfbzS5Yp77CNlS6RkkdZLPjl2i9+ACzv/lOy\n...\n-----END RSA PRIVATE KEY-----\n"
                  },
                  "tsa": {
                      "certificate": "-----BEGIN CERTIFICATE-----\nMIIEWTCCA0GgAwIBAgIBAjANBgkqhkiG9w0BAQ0FADCBzDELMAkGA1UEBhMCUk8x\n...\n-----END CERTIFICATE-----\n",
                      "private_key": "-----BEGIN RSA PRIVATE KEY-----\nMIIEogIBAAKCAQEA/JERC+o1UksvUfbzS5Yp77CNlS6RkkdZLPjl2i9+ACzv/lOy\n...\n-----END RSA PRIVATE KEY-----\n"
                  }
              },

The certificate of SPS's internal Certificate Authority.:

The SSL certificate of SPS's web and REST interface.

Web based or RPC API configuration is in progress — another client is connected to SPS. You can see the IP address of the client in the details key of the response, for example:

{
    "error": {
        "details": {
            "user": "admin@10.30.255.70"
        },
        "message": "Web based or RPC API configuration is in progress.",
        "type": "WebGuiOrRpcApiConfigInProgress"
    },
    "meta": {
        "href": "/api/setup",
        "next": "/api/transaction",
        "parent": "/api",
        "remaining_seconds": 0
    }
}