Managing Web Services › CA SDM REST API › Web Service Options

Web Service Options

These options control the web service session:

rest_webservice_access_duration

Specifies the number of hours that the REST Web Service Access Key remains active before expiration. The Access Key timeout is not based on inactivity time, but it is based on duration time since the Access Key creation. After the Access Key meets the specified duration, the Access Key ends regardless of whether it is being used.

Optionally, the REST client can also provide the Access Key duration time for the specific Access Key during the Access Key request. To provide the duration value, set it directly on the expiration_date attribute of the rest_access resource, as part of the POST request payload.

Valid Range: 1-8760 hours

Defaut: 168

rest_webservice_disable_basic_auth

Disables Basic Authentication in REST Web Services.

Default: No

rest_webservice_list_max_length

Specifies the maximum number of rows that a REST Web Service query returns.

Default: 500

rest_webservice_list_page_length

Specifies the default number of rows that a REST Web Service query returns per page.

Valid Range: 1-500

Default: 25

rest_webservice_resources_to_expose

Specifies the list of Majic factories (resources) that CA SDM exposes through REST Web Services. This option overrides the default behavior. By default, CA SDM exposes all factories through REST Web Services.

If you do not enter values in this option, the default behavior exposes any Majic factory that does not have the REST_OPERATIONS property set to NONE. By default, no Majic fatory has this property set to NONE.

Use the REST_OPERATIONS property to set the specific HTTP CRUD (CREATE, READ, UPDATE, DELETE) methods for CA SDM to expose on a given Majic factory.

Default: rest_access

Example: rest_access, cnt, grp, cr, crs, pri, alg, urg, imp, pcat, org

hmac_algorithm

Specifies the algorithm that you use to compute the signature for Custom/Secret Key Auhentication in REST Web Services.

Default: HmacSHA1

string_to_sign_fields

Specifies the fields that you use to compute the signature for Custom/Secret Key Authentication in REST Web Services, in addition to the default REQUEST_METHOD, REQUEST_URI, and QUERY_STRING fields.

Default: blank

webservice_domsrvr

Specifies the name of the object engine that SOAP web services use. If not installed, SOAP web services use "domsrvr".

The value of the option must be a string beginning with the characters "domsrvr:"

webservice_session_timeout

Sets the timeout value (in minutes) for SOAP Web Service sessions. When the time between successive web method calls is greater than the value specified, the session ID is marked expired. The session is then no longer valid.

To prevent sessions from expiring due to activity, set the value for this option to 0. Other methods, such as logoff routines, can still invalid sessions.

Note: These options require restarting the CA SDM server.