To create a new private key, you have to POST the private key as a JSON object to the https://<IP-address-of-Safeguard for Privileged Sessions>/api/private_keys endpoint. For details, see Using the Safeguard for Privileged Sessions REST API. The body of the POST request must contain a JSON object with the parameters listed in Private keys stored on Safeguard for Privileged Sessions. The response to a successful POST message is a JSON object that includes the reference ID of the created private key in its key attribute. You can reference this ID in other parts of the configuration. Note that you can use a private-key object for only one purpose, that is, you cannot reference one object twice.
POST https://<IP-address-of-Safeguard for Privileged Sessions>/api/configuration/private_keys
Note that the GET method is not permitted on this endpoint, you cannot list the existing private keys. However, if you know the reference ID of a private key, you can display its properties:
GET https://<IP-address-of-Safeguard for Privileged Sessions>/api/configuration/private_keys/<reference-ID-of-the-private-key;>
You cannot directly delete or modify a private key, the DELETE and PUT methods are not permitted on private key objects. To update a private key, create a new one, then update the object that uses the old private key to reference the new private key.
Header name | Description | Required | Values |
---|---|---|---|
Content-Type | Specifies the type of the data sent. Safeguard for Privileged Sessions uses the JSON format | Required | application/json |
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 Safeguard for Privileged Sessions REST API. |
The following command creates a new private key object. Note the following requirements:
The key must be in PKCS-1 PEM format.
Encrypted private keys are not supported.
The body of the POST message must be the private key as a single line, enclosed in double-quotes.
Replace line-breaks in the PEM file with \n
curl -X POST -H "Content-Type: application/json" --cookie cookies https://<IP-address-of-Safeguard for Privileged Sessions>/api/configuration/private_keys --data "-----BEGIN RSA PRIVATE KEY-----\nMIIEpAIBAAKCAQEAu3QMMhqeg9ZMLNfdvQoNN1deVRE2SR0VKY+ALnzPZF4fUoJy\n.....\nI2SchDibk/Xj/ZvuEQ23LvzayWOVVuVHtH3JZX3SU4Sa0vpaeC+3oddVTwQOWRq0\n ......... Qbn5W3xKz4vXDDQHEbEsvDQ9A7+uCEuHpO4s33IK9KEa0Zdp745AU0DSGXN4HFzc\n-----END RSA PRIVATE KEY-----\n"
Querying a specific key returns the following information about the key:
curl --cookie cookies https://<IP-address-of-Safeguard for Privileged Sessions>/api/configuration/private_keys/<reference-ID-of-the-private-key;>
Element | Type | Description | |
---|---|---|---|
public-key-fingerprint | string | The fingerprint of the public key that matches the private key. | |
digest | string | The fingerprint of the key, for example ef:d3:8e:d0:81:4f:a2:8f:3b:8b:0c:dd:c7:8f:8c:7e | |
hash_algorithm | string | The hash algorithm used to create the fingerprint, for example, sha256. | |
type | string | The type of the private key. Must be rsa |
The response to a successful POST message is a JSON object that includes the reference ID of the created public key in its key attribute. For details of the meta object, see Introduction.
{ "key": "faa96916-c85e-46ff-8697-f4cc5e596e7f", "meta": { "href": "/api/configuration/private_keys/faa96916-c85e-46ff-8697-f4cc5e596e7f", "parent": "/api/configuration/private_keys", "transaction": "/api/transaction" } }
The response to querying a specific key is a JSON object that includes the parameters of the key, for example:
{ "body": { "public-key-fingerprint": { "digest": "ef:d3:8e:d0:81:4f:a2:8f:3b:8b:0c:dd:c7:8f:8c:7e", "hash_algorithm": "md5" }, "type": "rsa" }, "key": "6c4d1116-d79d-475b-bb37-9f844f085c14", "meta": { "first": "/api/configuration/private_keys/e5d13d18-07c5-43fa-89f4-c3d2ece17c71", "href": "/api/configuration/private_keys/6c4d1116-d79d-475b-bb37-9f844f085c14", "last": "/api/configuration/private_keys/6c4d1116-d79d-475b-bb37-9f844f085c14", "next": null, "parent": "/api/configuration/private_keys", "previous": "/api/configuration/private_keys/e5d13d18-07c5-43fa-89f4-c3d2ece17c71", "transaction": "/api/transaction" }
The following table lists the typical status and error codes for this request. For a complete list of error codes, see Using the Safeguard for Privileged Sessions REST API.
Code | Description | Notes |
---|---|---|
201 | Created | The new resource was successfully created. |
400 | SyntacticError | Syntax error: Could not load PEM key: Unsupported private key format, only PKCS-1 is supported. Encrypted private keys are not supported. |
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. |
401 | AuthenticationFailure | Authenticating the user with the given credentials has failed. |
404 | NotFound | The requested object does not exist. |
405 | GetNotAllowed | The method GET is not allowed for this endpoint. You cannot list the existing private keys. |
405 | PutNotAllowed | The method PUT is not allowed for this endpoint. You cannot modify an existing private keys. For details, see Private keys stored on Safeguard for Privileged Sessions. |
You cannot directly delete or modify a private key, the DELETE and PUT methods are not permitted on private key objects. To update a private key, create a new one, then update the object that uses the old private key to reference the new private key. After you commit the transaction, Safeguard for Privileged Sessions will automatically delete the old private key.
To create a new certificate, you have to POST the certificate and its private key as a JSON object to the https://<IP-address-of-Safeguard for Privileged Sessions>/api/x509 endpoint. For details, see Using the Safeguard for Privileged Sessions REST API. The body of the POST request must contain a JSON object with the parameters listed in Certificates stored on Safeguard for Privileged Sessions. The response to a successful POST message is a JSON object that includes the reference ID of the created certificate in its key attribute. You can reference this ID in other parts of the configuration. Note that you can use a certificate object for only one purpose, that is, you cannot reference one object twice.
POST https://<IP-address-of-Safeguard for Privileged Sessions>/api/configuration/x509
Note that the GET method is not permitted on this endpoint, you cannot list the existing certificates. However, if you know the reference ID of a certificate, you can display its properties:
GET https://<IP-address-of-Safeguard for Privileged Sessions>/api/configuration/x509/<reference-ID-of-the-private-key;>
You cannot directly delete or modify a certificate, the DELETE and PUT methods are not permitted on certificate objects. To update a certificate, create a new one, then update the object that uses the old certificate to reference the new certificate.
Header name | Description | Required | Values |
---|---|---|---|
Content-Type | Specifies the type of the data sent. Safeguard for Privileged Sessions uses the JSON format | Required | application/json |
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 Safeguard for Privileged Sessions REST API. |
The following command creates a new certificate object. Note the following requirements:
The key must be in PKCS-1 PEM format.
You need the certificate and the private key as well.
Encrypted private keys are not supported.
The attributes of the POST message that contain the certificate and the private key must be a single line, enclosed in double-quotes.
Replace line-breaks in the PEM certificate with \n
The certificate and the certificate chain must be valid, Safeguard for Privileged Sessions will reject invalid certificates and invalid certificate chains.
curl -X POST -H "Content-Type: application/json" --cookie cookies https://<IP-address-of-Safeguard for Privileged Sessions>/api/configuration/x509 --data '{"private_key": "-----BEGIN RSA PRIVATE KEY-----\nMIIEpAIBAAKCAQEAu3QMMhqeg9ZMLNfdvQoNN1deVRE2SR0VKY+ALnzPZF4fUoJy\n.....\nI2SchDibk/Xj/ZvuEQ23LvzayWOVVuVHtH3JZX3SU4Sa0vpaeC+3oddVTwQOWRq0\n ......... Qbn5W3xKz4vXDDQHEbEsvDQ9A7+uCEuHpO4s33IK9KEa0Zdp745AU0DSGXN4HFzc\n-----END RSA PRIVATE KEY-----\n"}'
The body should be:
{ "certificate": "-----BEGIN CERTIFICATE-----\nMIIEpAIBAAKCAQEAu3QMMhqeg9ZMLNfdvQoNN1deVRE2SR0VKY+ALnzPZF4fUoJy\n.....\nI2SchDibk/Xj/ZvuEQ23LvzayWOVVuVHtH3JZX3SU4Sa0vpaeC+3oddVTwQOWRq0\n ......... Qbn5W3xKz4vXDDQHEbEsvDQ9A7+uCEuHpO4s33IK9KEa0Zdp745AU0DSGXN4HFzc\n-----END CERTIFICATE-----", "private_key": "-----BEGIN RSA PRIVATE KEY-----\nMIIEpAIBAAKCAQEAu3QMMhqeg9ZMLNfdvQoNN1deVRE2SR0VKY+ALnzPZF4fUoJy\n.....\nI2SchDibk/Xj/ZvuEQ23LvzayWOVVuVHtH3JZX3SU4Sa0vpaeC+3oddVTwQOWRq0\n ......... Qbn5W3xKz4vXDDQHEbEsvDQ9A7+uCEuHpO4s33IK9KEa0Zdp745AU0DSGXN4HFzc\n-----END RSA PRIVATE KEY-----", "issuer_chain": [] }
Element | Type | Description | |
---|---|---|---|
certificate |
string |
The certificate in PKCS-1 PEM format (replace line-breaks with \n). For example: -----BEGIN CERTIFICATE-----\nMIIEpAIBAAKCAQEAu3QMMhqeg9ZMLNfdvQoNN1deVRE2SR0VKY+ALnzPZF4fUoJy\n.....\nI2SchDibk/Xj/ZvuEQ23LvzayWOVVuVHtH3JZX3SU4Sa0vpaeC+3oddVTwQOWRq0\n ......... Qbn5W3xKz4vXDDQHEbEsvDQ9A7+uCEuHpO4s33IK9KEa0Zdp745AU0DSGXN4HFzc\n-----END CERTIFICATE----- | |
private_key |
string |
The private key of the certificate, without encryption or password protection (replace line-breaks with \n). For example: -----BEGIN RSA PRIVATE KEY-----\nMIIEpAIBAAKCAQEAu3QMMhqeg9ZMLNfdvQoNN1deVRE2SR0VKY+ALnzPZF4fUoJy\n.....\nI2SchDibk/Xj/ZvuEQ23LvzayWOVVuVHtH3JZX3SU4Sa0vpaeC+3oddVTwQOWRq0\n ......... Qbn5W3xKz4vXDDQHEbEsvDQ9A7+uCEuHpO4s33IK9KEa0Zdp745AU0DSGXN4HFzc\n-----END RSA PRIVATE KEY----- | |
issuer_chain |
list |
A comma-separated list of the Certificate Authority (CA) certificates that can be used to validate the uploaded certificate. |
Querying a specific key returns the following information about the key:
curl --cookie cookies https://<IP-address-of-Safeguard for Privileged Sessions>/api/configuration/x509/<reference-ID-of-the-private-key;>
Element | Type | Description | |
---|---|---|---|
fingerprint | string | The fingerprint of the certificate. | |
digest | string | The fingerprint of the certificate, for example ef:d3:8e:d0:81:4f:a2:8f:3b:8b:0c:dd:c7:8f:8c:7e | |
hash_algorithm | string | The hash algorithm used to create the fingerprint, for example, sha256. | |
subject | string | The subject string of the certificate. |
The response to a successful POST message is a JSON object that includes the reference ID of the created certificate in its key attribute. For details of the meta object, see Introduction.
{ "key": "faa96916-c85e-46ff-8697-f4cc5e596e7f", "meta": { "href": "/api/configuration/x509/faa96916-c85e-46ff-8697-f4cc5e596e7f", "parent": "/api/configuration/x509", "transaction": "/api/transaction" } }
The response to querying a specific certificate is a JSON object that includes the parameters of the certificate, for example:
{ "body": { "fingerprint": { "digest": "ef:d3:8e:d0:81:4f:a2:8f:3b:8b:0c:dd:c7:8f:8c:7e", "hash_algorithm": "md5" }, "subject": "C=RO/ST=State/L=Locality/O=Organization/OU=OrganizationalUnit/CN=example.com/emailAddress=root@example.com" }, "key": "6c4d1116-d79d-475b-bb37-9f844f085c14", "meta": { "first": "/api/configuration/x509/e5d13d18-07c5-43fa-89f4-c3d2ece17c71", "href": "/api/configuration/x509/6c4d1116-d79d-475b-bb37-9f844f085c14", "last": "/api/configuration/x509/6c4d1116-d79d-475b-bb37-9f844f085c14", "next": null, "parent": "/api/configuration/x509", "previous": "/api/configuration/x509/e5d13d18-07c5-43fa-89f4-c3d2ece17c71", "transaction": "/api/transaction" }
The following table lists the typical status and error codes for this request. For a complete list of error codes, see Using the Safeguard for Privileged Sessions REST API.
Code | Description | Notes |
---|---|---|
201 | Created | The new resource was successfully created. |
400 | SyntacticError | Syntax error: Could not load PEM key: Unsupported private key format, only PKCS-1 is supported. Encrypted private keys are not supported. |
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. |
401 | AuthenticationFailure | Authenticating the user with the given credentials has failed. |
404 | NotFound | The requested object does not exist. |
405 | GetNotAllowed | The method GET is not allowed for this endpoint. You cannot list the existing certificates. |
405 | PutNotAllowed | The method PUT is not allowed for this endpoint. You cannot modify an existing certificate. For details, see Certificates stored on Safeguard for Privileged Sessions. |
You cannot directly delete or modify a certificate, the DELETE and PUT methods are not permitted on certificate objects. To update a certificate, create a new one, then update the object that uses the old certificate to reference the new certificate. After you commit the transaction, Safeguard for Privileged Sessions will automatically delete the old certificate.
Exclusively for troubleshooting purposes, you can access the Safeguard for Privileged Sessions host using SSH. Completing the Welcome Wizard automatically disables SSH access to Safeguard for Privileged Sessions. Re-enabling it allows you to connect remotely to the Safeguard for Privileged Sessions host and login using the root user. The password of the root user is the one you provided in the Welcome Wizard.
|
Caution:
Accessing the Safeguard for Privileged Sessions host directly using SSH is not recommended or supported, except for troubleshooting purposes. In such case, the One Identity Support Team will give you exact instructions on what to do to solve the problem. For security reasons, disable SSH access to Safeguard for Privileged Sessions when it is not needed. For details, see "Enabling SSH access to the Safeguard for Privileged Sessions host" in the Administration Guide. |
The following encryption algorithms are configured on the local SSH service of Safeguard for Privileged Sessions:
Key exchange (KEX) algorithms:
diffie-hellman-group-exchange-sha256
Ciphers:
aes256-ctr,aes128-ctr
Message authentication codes:
hmac-sha2-512,hmac-sha2-256
GET https://<IP-address-of-Safeguard for Privileged Sessions>/api/configuration/local_services/ssh
Header 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 Safeguard for Privileged Sessions REST API. Note that this session ID refers to the connection between the REST client and the Safeguard for Privileged Sessions REST API. It is not related to the sessions that Safeguard for Privileged Sessions records (and which also have a session ID, but in a different format). |
The following command lists the configuration options.
curl --cookie cookies https://<IP-address-of-Safeguard for Privileged Sessions>/api/configuration/local_services/ssh
The following is a sample response received when listing the configuration options. For details of the meta object, see Introduction.
{ "body": { "access_restriction": { "allowed_from": [ "10.40.0.48/24" ], "enabled": true }, "allow_password_auth": true, "bruteforce_protection": true, "enabled": true, "listen": [ { "address": { "key": "nic1.interfaces.ff7574025754b3df1647001.addresses.1", "meta": { "href": "/api/configuration/network/nics/nic1#interfaces/ff7574025754b3df1647001/addresses/1" } }, "port": 23 } ], "public_keys": [ { "selection": "rsa", "value": "AAAAB3NzaC1yc2EAAAADAQABAAABAQDTnisLCjZ3vONMXqFBIdvpZ0BY73+GdHpgoaL8YsydxJBsYg9dYTDzVVtYFVvdCVzBdcwCjyOuPwtZoYU3pLEFQ7OVoDUDPmVnl6idS/6tB2m89I5zdc02xUeCWTBpTGoOhNtc+YDmxPGZ1FQIpXCw0MT91jviWm3JydDd5YKINwvdTh8zsRT/702ZD9uZslwkQA/b2B9/hidCAkQkvs5H1B3o4laTd0JE9k90N+qbaQjVvoInr+jdXaWvrScwFVxZhb7Q1LvUL6oxW889bOWFMSa+/mnENarw6rpwfk9Ayi5uQQ2imY/tSnfgbS2RvIa1sKwUsJasDqN2lo/DuhON" } ] }, "key": "ssh", "meta": { "first": "/api/configuration/local_services/admin_web", "href": "/api/configuration/local_services/ssh", "last": "/api/configuration/local_services/user_web", "next": "/api/configuration/local_services/user_web", "parent": "/api/configuration/local_services", "previous": "/api/configuration/local_services/snmp_agent", "transaction": "/api/transaction" }
Element | Type | Description | ||
---|---|---|---|---|
key | string | Top level element, contains the ID of the endpoint. | ||
body | Top level element (string) | Contains the configuration options of the SSH server. | ||
access_restriction |
JSON object |
Enables and configures limitations on the clients that can access the web interface, based on the IP address of the clients. | ||
allowed_from |
list |
The list of IP networks from where the administrators are permitted to access this management interface. To specify the IP addresses or networks, use the IPv4-Address/prefix format, for example, 10.40.0.0/16. | ||
enabled |
boolean |
Set it to true to restrict access to the specified client addresses. | ||
allow_password_auth | boolean | Enables password-based authentication, so administrators can remotely login to Safeguard for Privileged Sessions. If this option is set to False, Safeguard for Privileged Sessions ignores every other option of this endpoint. | ||
bruteforce_protection | boolean | Enables protection against brute-force attacks by denying access after failed login attempts for increasingly longer period. Enabled by default. | ||
enabled | boolean | Enables the SSH server, so administrators can remotely login to Safeguard for Privileged Sessions. If this option is set to False, Safeguard for Privileged Sessions ignores every other option of this endpoint. | ||
listen | list | Selects the network interface, IP address, and port where the clients can access the web interface. | ||
address | JSON object |
A reference to a configured network interface and IP address where this local service accepts connections. For example, if querying the interface /api/configuration/network/nics/nic1#interfaces/ff7574025754b3df1647001/addresses/ returns the following response: { "body": { "interfaces": { "@order": [ "ff7574025754b3df1647001" ], "ff7574025754b3df1647001": { "addresses": { "1": "10.40.255.171/24", "@order": [ "1" ] }, "name": "default", "vlantag": 0 } }, "name": "eth0", "speed": "auto" }, "key": "nic1", "meta": { "first": "/api/configuration/network/nics/nic1", "href": "/api/configuration/network/nics/nic1", "last": "/api/configuration/network/nics/nic3", "next": "/api/configuration/network/nics/nic2", "parent": "/api/configuration/network/nics", "previous": null, "transaction": "/api/transaction" } } Then the listening address of the local service is the following. nic1.interfaces.ff7574025754b3df1647001.addresses.1 This is the format you have to use when configuring the address of the local service using REST: "address": "nic1.interfaces.ff7574025754b3df1647001.addresses.1" When querying a local services endpoint, the response will contain a reference to the IP address of the interface in the following format: "address": { "key": "nic1.interfaces.ff7574025754b3df1647001.addresses.1", "meta": { "href": "/api/configuration/network/nics/nic1#interfaces/ff7574025754b3df1647001/addresses/1" } }, | ||
port | integer |
The port number where this local service accepts connections. | ||
public_keys | list |
Lists the public keys that can be used to authenticate on Safeguard for Privileged Sessions. For example: "public_keys": [ { "selection": "rsa", "value": "AAAAB3NzaC1yc2EAAAADAQABAAABAQDTnisLCjZ3vONMXqFBIdvpZ0BY73+GdHpgoaL8YsydxJBsYg9dYTDzVVtYFVvdCVzBdcwCjyOuPwtZoYU3pLEFQ7OVoDUDPmVnl6idS/6tB2m89I5zdc02xUeCWTBpTGoOhNtc+YDmxPGZ1FQIpXCw0MT91jviWm3JydDd5YKINwvdTh8zsRT/702ZD9uZslwkQA/b2B9/hidCAkQkvs5H1B3o4laTd0JE9k90N+qbaQjVvoInr+jdXaWvrScwFVxZhb7Q1LvUL6oxW889bOWFMSa+/mnENarw6rpwfk9Ayi5uQQ2imY/tSnfgbS2RvIa1sKwUsJasDqN2lo/DuhON" } ] One Identity recommends using 2048-bit RSA keys (or stronger). | ||
selection | rsa |
The type of the public key. Must be rsa. | ||
value | string |
The public key itself. |
The following table lists the typical status and error codes for this request. For a complete list of error codes, see Using the Safeguard for Privileged Sessions REST API.
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. |
401 | AuthenticationFailure | Authenticating the user with the given credentials has failed. |
404 | NotFound | The requested object does not exist. |
The Safeguard for Privileged Sessions RPC API allows you to access, query, and manage Safeguard for Privileged Sessions from remote applications. You can access the API using the Simple Object Access Protocol (SOAP) protocol over HTTPS, meaning that you can use any programming language that has access to a SOAP client to integrate Safeguard for Privileged Sessions to your environment.
GET https://<IP-address-of-Safeguard for Privileged Sessions>/api/configuration/management/soap
Header 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 Safeguard for Privileged Sessions REST API. Note that this session ID refers to the connection between the REST client and the Safeguard for Privileged Sessions REST API. It is not related to the sessions that Safeguard for Privileged Sessions records (and which also have a session ID, but in a different format). |
The following command lists the RPC API settings.
curl --cookie cookies https://<IP-address-of-Safeguard for Privileged Sessions>/api/configuration/management/soap
The following is a sample response received when listing the RPC API settings. For details of the meta object, see Introduction.
{ "body": { "enabled": true }, "key": "soap", "meta": { "first": "/api/configuration/management/certificates", "href": "/api/configuration/management/soap", "last": "/api/configuration/management/webinterface", "next": "/api/configuration/management/syslog", "parent": "/api/configuration/management", "previous": "/api/configuration/management/snmp", "transaction": "/api/transaction" } }
Element | Type | Description | |
---|---|---|---|
key | string | Top level element, contains the ID of the endpoint. | |
body | Top level element (string) | Contains the RPC API configuration options. | |
enabled | boolean | Set to true to enable the RPC API. |
To modify the RPC API settings, you have to:
For details, see Open a transaction.
PUT the modified JSON object to the https://<IP-address-of-Safeguard for Privileged Sessions>/api/configuration/management/soap endpoint. You can find a detailed description of the available parameters listed in RPC API.
For details, see Commit a transaction.
The following table lists the typical status and error codes for this request. For a complete list of error codes, see Using the Safeguard for Privileged Sessions REST API.
Code | Description | Notes |
---|---|---|
201 | Created | The new resource was successfully created. |
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. |
401 | AuthenticationFailure | Authenticating the user with the given credentials has failed. |
404 | NotFound | The requested object does not exist. |
© ALL RIGHTS RESERVED. Feedback Terms of Use Privacy