Enable the One Identity Safeguard Remote Access (SRA) feature of One Identity Starling without Starling Join information.

URL

GET https://<IP-address-of-SPS>/api/configuration/starling

Cookies

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

Operations with the /starling endpoint include:

Operation	HTTP method	URL	Notes
Query One Identity Starling Join without a join to One Identity Starling	GET	/api/configuration/starling	The value of the join_info field is null.
Query One Identity Starling Join after join	GET	/api/configuration/starling	The values of the join_info field are environment, product_instance, and product_tims.
Enable SRA	PUT	/api/configuration/starling	SRA can be enabled only if the node is joined to One Identity Starling. Use the starling/join endpoint to join to One Identity Starling.
Disable SRA	PUT	/api/configuration/starling	To disable SRA to One Identity Starling, the enabled field must be set to false.

Enable SRA

To enable SRA with the use of the /starling endpoint, you have to:

2. Open a transaction.

   For more information, see Open a transaction.

2. Set the enabled parameter of remote_access to true.

   Sample request

   The following command enables SRA to join to One Identity Starling.

   curl --cookie cookies https://<IP-address-of-SPS>/api/configuration/starling

   {
      "join_info": {
        "environment": "prod",
        "product_instance": "starling-joiner-11111111-1111-1111-1111-111111111111",
        "product_tims": "123-456-789"
      },
      "remote_access":
      {
        "enabled": true
      }
   }
   				

   Elements of the request message body include:

   Elements	Type	Description	Notes
   join_info	object
   join_info.environment	string	The environment of the product.	Possible values: prod.
   join_info.product_instance	string	The instance of the product.
   join_info.product_tims	string	The TIMS license of the product.
   remote_access			To disable SRA to One Identity Starling, the enabled field must be set to false.
   remote_access.enabled	boolean	Enables or disables SRA to One Identity Starling.	Possible values: true, false
   key			Possible values: starling

4. Commit your changes.

   For more information, see Commit a transaction.

Response

The response is a regular meta object.

For more information on the meta object, see Message format.

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.

Endpoint-specific HTTP response codes for this request:

HTTP response code	Status / Error	Description
403	RemoteAccessDependsOnStarlingJoinError	SRA to One Identity Starling can only be enabled, if the node is joined to One Identity Starling. Use the /starling/join endpoint to join to One Identity Starling.
403	StarlingJoinInfoIsReadOnlyError	You cannot join or unjoin from One Identity Starling at the resource configuration endpoint (/api/configuration/starling), as the One Identity Starling join_info field is read-only. Use the /starling/join endpoint to join or unjoin from One Identity Starling.

Standard HTTP response codes for this request:

• 400 SyntacticError

• 400 SemanticError

• 401 Unauthenticated