Contains the endpoints for configuring plugins.
GET https://<IP-address-of-SPS>/api/configuration/plugins
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 endpoints for configuring plugins.
curl --cookie cookies https://<IP-address-of-SPS>/api/configuration/plugins
The following is a sample response received when listing endpoints for configuring plugins.
For details of the meta object, see Message format.
{ "items": [ { "key": "aa", "meta": { "href": "/api/configuration/plugins/aa" } }, { "key": "configuration_sync", "meta": { "href": "/api/configuration/plugins/configuration_sync" } }, { "key": "credentialstore", "meta": { "href": "/api/configuration/plugins/credentialstore" } }, { "key": "signingca", "meta": { "href": "/api/configuration/plugins/signingca" } } ], "meta": { "first": "/api/configuration/aaa", "href": "/api/configuration/plugins", "last": "/api/configuration/x509", "next": "/api/configuration/policies", "parent": "/api/configuration", "previous": "/api/configuration/passwords", "remaining_seconds": 600, "transaction": "/api/transaction" } }
Element | Description |
---|---|
aa | Endpoint for configuring authentication and authorization plugins. |
configuration_sync | Endpoint for configuring plugins that synchronize the configuration of SPS clusters that receive their configuration from the Central Management node. |
credentialstore | Endpoint for configuring credential store plugins. |
signingca | Endpoint for configuring plugins to sign certificates. |
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. |
401 | AuthenticationFailure | Authenticating the user with the given credentials has failed. |
404 | NotFound | The requested object does not exist. |
To upload or update a plugin, complete the following steps. To update a plugin, upload a new version. Starting with version 6.4, you can also delete plugins using the REST API. For details, see Delete a plugin.
For details, see Open a transaction.
POST the plugin as a zip file (application/zip) to the https://<IP-address-of-SPS>/api/upload/plugins endpoint, for example:
curl -X POST -H "Content-Type: application/zip" --cookie cookies https://<IP-address-of-SPS>/api/upload/plugins --data-binary @<path-to-plugin.zip>
If the POST request is successful, the response includes the key of the new plugin, as well as information about the uploaded plugin. For example:
{ "meta": { "href": "/api/configuration/plugins/aa/aa423b72-0d0f-4275-be30-494e9a99ffad", "parent": "/api/configuration/plugins/aa" }, "key": "aa423b72-0d0f-4275-be30-494e9a99ffad", "body": { "name": "Sample-Authentication-Plugin", "description": "My custom authentication plugin", "version": "1.12", "path": "/opt/scb/var/plugins/aa/Sample-Authentication-Plugin", "api": "1.0" } }
For details, see Commit a transaction.
Note the following points.
Re-uploading an already existing plugin overwrites the existing plugin.
Uploading a newer version of an already existing plugin overwrites the existing plugin.
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 | Unauthenticated | The plugin has been successfully uploaded. The response should include the key of the created object. |
400 | The plugin does not support this version of SPS. | |
400 | InvalidPlugin | The type or some other value in the Manifest file of the plugin is invalid, or this version of SPS does not support this type of plugin. Check the error key in the response for details. |
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. |
422 | TransactionProcessingError | The plugin was uploaded but deploying the plugin failed for some reason. |
Starting with version 6.4, you can also delete plugins using the REST API.
For details, see Open a transaction.
DELETE the https://<IP-address-of-SPS>/api/configuration/plugins/aa/<ID-of-the-plugin-to-delete> endpoint. For details, see Delete an object. If the DELETE request is successful, the response includes only the meta object, for example:
{ "meta": { "href": "/api/configuration/plugins/aa/b080b1ba546232548bb1a9", "parent": "/api/configuration/plugins/aa" } }
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 | Unauthenticated | The plugin has been successfully uploaded. The response should include the key of the created object. |
400 | The plugin does not support this version of SPS. | |
400 | InvalidPlugin | The type or some other value in the Manifest file of the plugin is invalid, or this version of SPS does not support this type of plugin. Check the error key in the response for details. |
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. |
422 | TransactionProcessingError | The plugin was uploaded but deploying the plugin failed for some reason. |
The authentication and authorization (AA) plugins used on SPS. To upload or update a plugin, see Upload a plugin.
GET https://<IP-address-of-SPS>/api/configuration/plugins/aa
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 list of AA plugins used on SPS.
curl --cookie cookies https://<IP-address-of-SPS>/api/configuration/plugins/aa
The following command retrieves the properties of a specific plugin.
curl --cookie cookies https://<IP-address-of-SPS>/api/configuration/plugins/aa/<plugin-id>
The following is a sample response received when querying the list of AAA plugins used on SPS.
For details of the meta object, see Message format.
{ "items": [ { "key": "2080160955734bb2a1ddf9", "meta": { "href": "/api/configuration/plugins/aa/2080160955734bb2a1ddf9" } } ], "meta": { "first": "/api/configuration/plugins/aa", "href": "/api/configuration/plugins/aa", "last": "/api/configuration/plugins/ticketing", "next": "/api/configuration/plugins/credentialstore", "parent": "/api/configuration/plugins", "previous": null, "transaction": "/api/transaction" } }
When retrieving the endpoint of a specific plugin, the response is the following.
{ "body": { "api": "1.0", "description": "test1", "name": "AAPluginExample", "version": "1.1", "path": "/opt/scb/var/plugins/customgwauthplugin", "scb_max_version": "", "scb_min_version": "", "default_configuration": "", "entry_point": null, "sha256sum": "c4bb901de6b2274dcb94f1eec429fd0f3565ac792a856b07b8895e56ca2d8f42" }, "key": "2080160955734bb2a1ddf9", "meta": { "first": "/api/configuration/plugins/aa/2080160955734bb2a1ddf9", "href": "/api/configuration/plugins/aa/2080160955734bb2a1ddf9", "last": "/api/configuration/plugins/aa/2080160955734bb2a1ddf9", "next": null, "parent": "/api/configuration/plugins/aa", "previous": null, "transaction": "/api/transaction" } }
Element | Type | Description | |
---|---|---|---|
key | string | Top level element, contains the ID of the plugin. | |
body | Top level element (string) | Contains the properties of the plugin. | |
api | string | The API version of the plugin. | |
description | string | The description of the plugin. This description is also displayed on the SPS web interface. | |
default_configuration | string | The default configuration of the plugin (an INI file as a string). For details, see the documentation of the particular plugin. | |
entry_point | string | The entry point of the plugin, for example, main.py | |
name | string | The name of the plugin. This name is also displayed on the SPS web interface. It cannot contain whitespace. | |
path | string | The path where the plugin is stored on SPS. | |
scb_max_version | string | The version number of the latest SPS release that is compatible with the plugin. | |
scb_min_version | string | The version number of the earliest SPS release that is compatible with the plugin. | |
sha256sum | string | The SHA-256 checksum of the plugin. | |
version | string | The version number of the plugin. |
To configure a particular instance of a plugin, use the /api/coniguration/policies/aa_plugin_instances/<key-of-the-plugin-instance> endpoint.
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. |
401 | AuthenticationFailure | Authenticating the user with the given credentials has failed. |
404 | NotFound | The requested object does not exist. |
© 2023 One Identity LLC. ALL RIGHTS RESERVED. Feedback Terms of Use Privacy