Skip to main content

API Reference Guide

Overview​

The RSA Governance & Lifecycle REST API empowers users to perform a diverse range of tasks, enhancing their control and management capabilities within the RSA Governance & Lifecycle system. Here's an overview of the tasks that can be accomplished using this API:

  1. Retrieve Information:

    • Acquire server, database, patch version, security data, and user interface element details for RSA Governance & Lifecycle.

  2. Data Collection Management:

    • Initiate data collections.
    • Check the status of ongoing collection runs.
    • Unify identity data for streamlined processing.
    • Abort pending collection processes.

  3. Review Management:

    • Execute review processes.
    • Upload updated coverage information.
    • Access and modify review statuses.
    • Refresh ongoing reviews.
    • Update unreviewed items efficiently.

  4. Change Request Handling:

    • Create change requests originating from reviews.
    • Cancel pending activities associated with change requests.
    • Facilitate approvals within RSA Governance & Lifecycle processes.

  5. Metadata Import:

    • Import business descriptions and RSA Governance & Lifecycle metadata uploaded to the RSA Governance & Lifecycle machine.

  6. Job Cancellation:

    • Cancel pending processing jobs, which can encompass rules, reviews, reports, and more.

  7. Admin Error Generation:

    • Generate administrative errors for tracking and resolution purposes.

  8. Object Retrieval:

    • Search and locate specific objects within the RSA Governance & Lifecycle system efficiently.

Furthermore, the web services configuration feature available in the user interface enables users to:

  • Enable or disable web services.
  • Define the list of authorized clients with access to web services.
  • Access comprehensive documentation pertaining to available commands, their options, and illustrative command examples.

This robust set of capabilities provided by the RSA Governance & Lifecycle REST API empowers users to effectively manage and interact with the system, facilitating streamlined operations and improved control over critical processes.

info

The Web Services API performs fewer validation checks for managing change requests. If approvals are not in place in the change request workflow process, users should manually check for terminated users or deleted accounts before issuing calls.

Enable and Disable REST APIs​

REST APIs are disabled by default. You must enable web services to allow authorized clients to issue web services commands. See Control Access to Web Services for information on how to specify the clients allowed to access web services.

  1. Click the Admin menu and select Web Services. The Web Services Interface field on the Web Services main page indicates whether web services is enabled (On) or disabled (Off).
  2. Click Edit.
  3. Enable or disable web services, and then click OK.
Last updated on