Contains the local users of SPS. You can use local users and groups to control the privileges of SPS local and LDAP users — who can view and configure what.
NOTE: The admin user is available by default and has all possible privileges. It is not possible to delete this user.
Local users cannot be managed when LDAP authentication is used. When LDAP authentication is enabled, the accounts of local users is disabled, but they are not deleted,
When using RADIUS authentication together with local users, the users are authenticated to the RADIUS server, only their group memberships must be managed locally on SPS.
For details, see Authentication and user database settings.
GET https://<IP-address-of-SPS>/api/configuration/aaa/local_database/users
| 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). |
The following command lists the local users.
curl --cookie cookies https://<IP-address-of-SPS>/api/configuration/aaa/local_database/users
The following command displays the parameters of a specific user.
curl --cookie cookies https://<IP-address-of-SPS>/api/configuration/aaa/local_database/users/<ID-of-the-user>
The following is a sample response received when querying the list of users.
For details of the meta object, see Message format.
{
"items": [
{
"key": "103640099357f3b14f0529a",
"meta": {
"href": "/api/configuration/aaa/local_database/users/103640099357f3b14f0529a"
}
},
{
"key": "46785097158061f46c63d0",
"meta": {
"href": "/api/configuration/aaa/local_database/users/46785097158061f46c63d0"
}
}
],
"meta": {
"first": "/api/configuration/aaa/local_database/groups",
"href": "/api/configuration/aaa/local_database/users",
"last": "/api/configuration/aaa/local_database/users",
"next": null,
"parent": "/api/configuration/aaa/local_database",
"previous": "/api/configuration/aaa/local_database/groups",
"transaction": "/api/transaction"
}
}
The following is a sample response received when querying a specific user.
{
"body": {
"name": "testuser",
"password": {
"key": "8f84d7d1-9de1-429a-a7a7-c33a61cc7419",
"meta": {
"href": "/api/configuration/passwords/8f84d7d1-9de1-429a-a7a7-c33a61cc7419"
}
},
"password_created": 1476796261
},
"key": "46785097158061f46c63d0",
"meta": {
"first": "/api/configuration/aaa/local_database/users/103640099357f3b14f0529a",
"href": "/api/configuration/aaa/local_database/users/46785097158061f46c63d0",
"last": "/api/configuration/aaa/local_database/users/46785097158061f46c63d0",
"next": null,
"parent": "/api/configuration/aaa/local_database/users",
"previous": "/api/configuration/aaa/local_database/users/103640099357f3b14f0529a",
"transaction": "/api/transaction"
}
| Element | Type | Description | |
|---|---|---|---|
| body | Top level element (JSON object) | Contains the properties of the user. | |
| name | string | The username of the user account. | |
| password | reference | A reference to a password object. To create or update passwords, see Passwords stored on SPS. | |
| password_created | integer | The date when the password of the account was changed in UNIX timestamp format (for example, 1476796261). | |
| key | string | Top level element, contains the ID of the user. | |
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 |
|---|---|---|
| 400 | SemanticError | You tried to reuse a password object. You can use a password object for only one purpose, that is, you cannot reference a password object twice. |
| 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. |
| 409 | NoTransaction | No open Transaction is available. You must open a transaction first (for details, see Open a transaction). |
Configures debug logging and the retention time of core dump files.
Debug logging increases the log level of the non-network-related events, adding the commands executed by the SPS web interface to the log.
SPS automatically generates core dump files if an important software component of the system crashes. These core dump files can be of great help to the One Identity Support Team to identify problems. To download the generated core dump files, navigate to Basic Settings > Troubleshooting > Core files on the web interface of SPS.
GET https://<IP-address-of-SPS>/api/configuration/troubleshooting
| 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). |
The following command queries the troubleshooting settings.
curl --cookie cookies https://<IP-address-of-SPS>/api/configuration/troubleshooting
The following is a sample response received.
For details of the meta object, see Message format.
{
"body": {
"core_files": {
"retention_days": 14
},
"debug_logging": {
"enabled": true
}
},
"key": "troubleshooting",
"meta": {
"first": "/api/configuration/aaa",
"href": "/api/configuration/troubleshooting",
"last": "/api/configuration/x509",
"next": "/api/configuration/vnc",
"parent": "/api/configuration",
"previous": "/api/configuration/telnet",
"transaction": "/api/transaction"
}
}
To modify troubleshooting settings, you have to:
For details, see Open a transaction.
PUT the modified JSON object to the https://<IP-address-of-SPS>/api/configuration/troubleshooting endpoint. You can find a detailed description of the available parameters listed in Element .
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 Application level error codes.
| 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. |
| 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. |
This endpoint references the certificates of SPS's internal Certificate Authority, Timestamping Authority, and the SSL certificate of the web and REST interface.
GET https://<IP-address-of-SPS>/api/configuration/management/certificates
| 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). |
The following command lists the internal certificates of SPS.
curl --cookie cookies https://<IP-address-of-SPS>/api/configuration/management/certificates
The following is a sample response received when listing the internal certificates of SPS.
For details of the meta object, see Message format.
{
"body": {
"ca": {
"selection": "identity",
"x509_identity": {
"key": "fbd684e1-e1ac-4f34-ad25-86c560c51e24",
"meta": {
"href": "/api/configuration/x509/fbd684e1-e1ac-4f34-ad25-86c560c51e24"
}
}
},
"server": {
"key": "fd1c73e8-bcb8-4d13-991f-722f492dc074",
"meta": {
"href": "/api/configuration/x509/fd1c73e8-bcb8-4d13-991f-722f492dc074"
}
},
"tsa": {
"key": "20e72ede-78ef-460a-b843-68a35d994142",
"meta": {
"href": "/api/configuration/x509/20e72ede-78ef-460a-b843-68a35d994142"
}
}
},
"key": "certificates",
"meta": {
"first": "/api/configuration/management/certificates",
"href": "/api/configuration/management/certificates",
"last": "/api/configuration/management/webinterface",
"next": "/api/configuration/management/disk_fillup_prevention",
"parent": "/api/configuration/management",
"previous": null,
"transaction": "/api/transaction"
}
}
| Element | Type | Description | ||
|---|---|---|---|---|
| key | string | The ID of the endpoint. | ||
| body | Top level element (string) | Contains the internal certificates of SPS. | ||
| ca | Top level item | Contains the certificate of SPS's internal Certificate Authority. | ||
| selection | string | Must be set to identity. | ||
| x509_identity | string |
References the certificate of SPS's internal Certificate Authority. You can configure certificates at the /api/configuration/x509/ endpoint. To modify or add an X.509 certificate, use the value of the returned key as the value of the x509_identity element, and remove any child elements (including the key). For details, see Certificates stored on SPS. | ||
| server | string |
References the SSL certificate of SPS's web interface. You can configure certificates at the /api/configuration/x509/ endpoint. To modify or add an X.509 certificate, use the value of the returned key as the value of the x509_identity element, and remove any child elements (including the key). For details, see Certificates stored on SPS. | ||
| tsa | string |
References the certificate of SPS's internal Timestamping Authority. You can configure certificates at the /api/configuration/x509/ endpoint. To modify or add an X.509 certificate, use the value of the returned key as the value of the x509_identity element, and remove any child elements (including the key). For details, see Certificates stored on SPS. | ||
To modify a certificate, you have to:
For details, see Open a transaction.
Have the value of the key element of a valid X.509 CA certificate stored on SPS.
Use the X.509 certificate's key as the value of the ca element. You can find a detailed description of the available parameters listed in Element . PUT the modified JSON object to the https://<IP-address-of-SPS>/api/configuration/management/certificates endpoint.
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 Application level error codes.
| 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. |
| 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. |
© 2024 One Identity LLC. ALL RIGHTS RESERVED. Feedback Terms of Use Privacy Cookie Preference Center