The AAA endpoint contains the configuration endpoints for the authentication, authorization, and account (AAA) settings of the users who access SPS.
GET https://<IP-address-of-SPS>/api/configuration/aaa/
| 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 more information on authentication, see Authenticate to the SPS REST API. NOTE: 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 AAA configuration endpoints.
curl --cookie cookies.txt https://<IP-address-of-SPS>/api/configuration/aaa/
The following is a sample response received when listing AAA configuration endpoints.
For more information on the meta object, see Message format.
{ |
"items": [ |
{ |
"key": "acls", |
"meta": { |
"href": "/api/configuration/aaa/acls" |
} |
}, |
{ |
"key": "ldap_servers", |
"meta": { |
"href": "/api/configuration/aaa/ldap_servers" |
} |
}, |
{ |
"key": "local_database", |
"meta": { |
"href": "/api/configuration/aaa/local_database" |
} |
}, |
{ |
"key": "login_methods", |
"meta": { |
"href": "/api/configuration/aaa/login_methods" |
} |
}, |
{ |
"key": "saml2", |
"meta": { |
"href": "/api/configuration/aaa/saml2" |
} |
}, |
{ |
"key": "settings", |
"meta": { |
"href": "/api/configuration/aaa/settings" |
} |
} |
], |
"meta": { |
"first": "/api/configuration/aaa", |
"href": "/api/configuration/aaa", |
"last": "/api/configuration/x509", |
"next": "/api/configuration/alerting", |
"parent": "/api/configuration", |
"previous": null, |
"transaction": "/api/transaction" |
} |
} |
| Element | Description |
|---|---|
| acls | Access control settings for usergroups. |
|
LDAP server configuration for authentication, authorization, and accounting. | |
| local_database | Local users and usergroups. |
|
Multiple login method configuration for SPS. | |
|
SAML2 Service Provider settings. | |
| settings | Authentication and user database settings. |
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. |
Use login settings to control the web login access of administrators and users to SPS. With the /aaa/settings endpoint you can configure the following three security enhancing measures:
Protecting against brute-force attacks
Authentication banner
Web interface timeout
For more information, see the corresponding sections in One Identity Safeguard for Privileged Sessions Administration Guide.
POST https://<IP-address-of-SPS>/api/configuration/aaa/settings
| 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 more information on authentication, see Authenticate to the SPS REST API. NOTE: 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). |
Operations with the /aaa/settings endpoint include:
| Operation | HTTP method | URL |
Notes |
|---|---|---|---|
| Creating login settings | GET | /api/configuration/aaa/settings |
|
|
Retrieving login settings |
POST |
|
The following command lists the login settings.
curl -X GET -b "${COOKIE_PATH}" https://<IP-address-of-SPS>/api/configuration/aaa/settingsThe following is a sample response received when listing login settings.
For more information on the meta object, see Message format.
{
"key": "settings",
"body": {
"authentication_banner": "",
"bruteforce_protection": {
"attempt_limit": 20,
"lockout_minutes": 10
},
"webinterface_timeout": 10
}
}
Elements of the request message body include:
| Element |
Type |
Description |
Notes |
|---|---|---|---|
| authentication_banner |
string |
Displays a banner with a configurable text on the web and console login screen of SPS. Users will see the banner every time they try to log in to SPS. The login screen displays the banner text as plain text, with whitespaces preserved. |
If you specify an empty string, then no authentication banner will show. |
| bruteforce_protection |
JSON object |
Protects the web login addresses of administrators and users against brute-force attacks. After the users reach the configured number of unsuccessful login attempts, SPS denies all following attempts for the configured time. |
|
| bruteforce_protection.attempt_limit |
number |
The number of unnsuccessful login attempts before the user name or the IP address is locked out. If the number of subsequent unsuccessful login attempts exceeds this limit, the IP address or the user name will be blocked for a period, which is specified in bruteforce_protection.lockout_minutes. |
Value range: 1-50 attempts Default value: 20 attempts |
| bruteforce_protection.lockout_minutes |
number |
The period of time for which the user or the IP address is locked out from using the SPS appliance. It is measured in minutes. |
Value range: 1-720 minutes Default value: 10 minutes |
|
webinterface_timeout |
number |
The period of inactivity after which SPS terminates the web session of a user. It is measured in minutes. |
Value range: 5-720 minutes Default value: 10 minutes |
For more information and a complete list of standard HTTP response codes, see Application level error codes.
This endpoint lists the usergroups configured on SPS, and the privileges (ACLs) of each group.
Note that currently you cannot edit the privileges (ACLs) of the groups using the REST API. If you change the privileges of a usergroup on the SPS web interface, the changes will apply to the users when they authenticate again on SPS, the privileges of active sessions are not affected.
GET https://<IP-address-of-SPS>/api/configuration/aaa/acls
| 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 more information on authentication, see Authenticate to the SPS REST API. NOTE: 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.txt https://<IP-address-of-SPS>/api/configuration/aaa/acls
The following is a sample response received when querying the endpoint.
For more information on the meta object, see Message format.
{
"body": [
{
"group": "basic-view",
"objects": [
"/special/basic"
],
"permission": "read"
},
{
"group": "basic-write",
"objects": [
"/special/basic"
],
"permission": "write"
},
{
"group": "auth-view",
"objects": [
"/special/auth"
],
"permission": "read"
},
{
"group": "auth-write",
"objects": [
"/special/auth"
],
"permission": "write"
},
{
"group": "search",
"objects": [
"/special/searchmenu"
],
"permission": "read"
},
{
"group": "changelog",
"objects": [
"/special/changelog"
],
"permission": "read"
},
{
"group": "policies-view",
"objects": [
"/special/pol"
],
"permission": "read"
},
{
"group": "policies-write",
"objects": [
"/special/pol"
],
"permission": "write"
},
{
"group": "ssh-view",
"objects": [
"/special/ssh"
],
"permission": "read"
},
{
"group": "ssh-write",
"objects": [
"/special/ssh"
],
"permission": "write"
},
{
"group": "rdp-view",
"objects": [
"/special/rdp"
],
"permission": "read"
},
{
"group": "rdp-write",
"objects": [
"/special/rdp"
],
"permission": "write"
},
{
"group": "telnet-view",
"objects": [
"/special/telnet"
],
"permission": "read"
},
{
"group": "telnet-write",
"objects": [
"/special/telnet"
],
"permission": "write"
},
{
"group": "vnc-view",
"objects": [
"/special/vnc"
],
"permission": "read"
},
{
"group": "vnc-write",
"objects": [
"/special/vnc"
],
"permission": "write"
},
{
"group": "indexing",
"objects": [
"/special/search/search",
"/special/bap"
],
"permission": "write"
},
{
"group": "ica-view",
"objects": [
"/special/ica"
],
"permission": "read"
},
{
"group": "ica-write",
"objects": [
"/special/ica"
],
"permission": "write"
},
{
"group": "http-view",
"objects": [
"/special/http"
],
"permission": "read"
},
{
"group": "http-write",
"objects": [
"/special/http"
],
"permission": "write"
},
{
"group": "indexer-view",
"objects": [
"/special/indexer"
],
"permission": "read"
},
{
"group": "indexer-write",
"objects": [
"/special/indexer"
],
"permission": "write"
},
],
"key": "acls",
"meta": {
"first": "/api/configuration/aaa/acls",
"href": "/api/configuration/aaa/acls",
"last": "/api/configuration/aaa/settings",
"next": "/api/configuration/aaa/local_database",
"parent": "/api/configuration/aaa",
"previous": null,
"transaction": "/api/transaction"
}
}
| Element | Type | Description | |
|---|---|---|---|
| body | Top level element (JSON object) | Contains the properties of the user. | |
| group | string | The name of the usergroup. | |
| objects | list | The list of privileges that the group has access to. | |
| permission | read | write | The type of the permission. The group needs write access to configure an object, or to perform certain actions. |
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. |
© 2024 One Identity LLC. ALL RIGHTS RESERVED. Términos de uso Privacidad Cookie Preference Center