Use the /status endpoint to retrieve information about the availability of the services needed for Starling Join, or Starling Unjoin.
URL
GET https://<IP-address-of-SPS>/api/starling/join/status
Cookies
| 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). |
Sample request
The following command returns information about the availability of the services needed for Starling Join, or Starling Unjoin .
curl --cookie cookies.txt https://<IP-address-of-SPS>/api/starling/join/status
Response
The following is a sample response.
For more information on the meta object, see Message format.
{
"internet_connection": {
"error": "N/A",
"status": true
},
"meta": {
"href": "/api/starling/status",
"parent": "/api/starling",
"remaining_seconds": 593
},
"proxy": true,
"starling_status": {
"Account Email Notifications": "operational",
"Account Services Portal": "operational",
"Active Roles On Demand": "operational",
"CertAccess": "operational",
"Connect": "operational",
"Database Service": "operational",
"Hybrid Subscription": "operational",
"Identity Manager On Demand": "operational",
"Job Service": "operational",
"One Identity Starling": "operational",
"Password Manager On Demand": "operational",
"Safeguard On Demand": "operational",
"Safeguard Remote Access": "operational",
"Safeguard for Privileged Passwords On Demand": "operational",
"Safeguard for Privileged Sessions On Demand": "operational",
"Subscription and Billing": "operational",
"Two-Factor Authentication": "operational",
"Web UI": "operational"
},
"verdict": true
}
Elements of the response message body include:
| internet_connection |
object |
Indicates whether or not the SPS appliance can connect to the status endpoint (oneidentitycloud.statuspage.io). |
|
| internet_connection.error |
string |
The description of the error. If no error occurred, the value is N/A. |
|
| internet_connection.status |
boolean |
The value is true, if the SPS appliance could connect to the status page.
The value is false, if there is no Internet connection. |
|
| proxy |
boolean |
Indicates whether or not a proxy server is configured. |
|
|
starling_status |
enum |
Enumeration of the different One Identity Starling-related services and their current status. |
NOTE: starling_status lists all available One Identity Starling-related services, however, to Starling Join/Unjoin to work, only the status of the One Identity Starling service is relevant. |
|
verdict |
boolean |
The value is true if SPS can connect to the status page, a proxy is enabled, and the relevant service(s) are operational. |
|
HTTP response codes
Standard HTTP response codes for this request:
For more information and a list of standard HTTP response codes, see Application level error codes.
User management and access control
The AAA endpoint contains the configuration endpoints for the authentication, authorization, and account (AAA) settings of the users who access SPS.
URL
GET https://<IP-address-of-SPS>/api/configuration/aaa/
Cookies
| 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). |
Sample request
The following command lists the AAA configuration endpoints.
curl --cookie cookies.txt https://<IP-address-of-SPS>/api/configuration/aaa/
Response
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" |
} |
} |
| acls |
Access control settings for usergroups. |
|
ldap_servers |
LDAP server configuration for authentication, authorization, and accounting. |
| local_database |
Local users and usergroups. |
|
login_methods |
Multiple login method configuration for SPS. |
|
saml2 |
SAML2 Service Provider settings. |
| settings |
Authentication and user database settings. |
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.
| 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:
Cookies
| 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
Operations with the /aaa/settings endpoint include:
| Creating login settings |
GET |
/api/configuration/aaa/settings |
|
|
Retrieving login settings |
POST |
|
Sample request
The following command lists the login settings.
curl -X GET -b "${COOKIE_PATH}" https://<IP-address-of-SPS>/api/configuration/aaa/settings
Response
The 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:
| 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 |
