Chat now with support
Chat with Support

One Identity Safeguard for Privileged Passwords 7.5.1 - Administration Guide

Introduction System requirements and versions Using API and PowerShell tools Using the virtual appliance and web management console Cloud deployment considerations Setting up Safeguard for Privileged Passwords for the first time Using the web client Home page Privileged access requests Appliance Management
Appliance Backup and Retention Certificates Cluster Global Services External Integration Real-Time Reports Safeguard Access Appliance Management Settings
Asset Management
Account Automation Accounts Assets Partitions Discovery Profiles Tags Registered Connectors Custom platforms Importing objects
Security Policy Management
Access Request Activity Account Groups Application to Application Cloud Assistant Asset Groups Entitlements Linked Accounts User Groups Security Policy Settings
User Management Reports Disaster recovery and clusters Administrator permissions Preparing systems for management Troubleshooting Frequently asked questions Appendix A: Safeguard ports Appendix B: SPP and SPS join guidance Appendix C: Regular Expressions

Taking action on an API key release request

The actions that can be taken on an API key release request depends on the state of the request.

To take action on an API key release request

  1. From the web client, click My Requests. Use any of the following methods to control the request displayed:

    • Click then select Check-In All Available to check-in all the available requests, Clear All to remove all requests, or Cancel All Pending Time Requested to cancel and remove all pending requests.

    • Click Sort By then select to sort by Account Name, Asset Name, Due Next, Expiring Next, Most Recent, or Status.
    • Click sort up or sort down to sort in ascending or descending order.
    • Click Filters to filter by the status.
      • Available: Approved requests that are ready to view or copy.
      • Pending Approval: Requests that are waiting for approval.
      • Approved: Requests that have been approved, but the check out time has not arrived. Or, for pending accounts restored when using the SPS suspend feature.
      • Revoked: Approved requests retracted by the approver. The approver can revoke a request after the request has become available.
      • Expired: Requests for which the Checkout Duration has elapsed.
      • Denied: Requests denied by the approver.
    • Click Search to see a list of searchable elements. Or enter search characters. For more information, see Search box.
    • If a denied or revoked request has been commented on by an approver, you can click the button associated with the request to view the comment.

  2. You can take any of the following actions on the API key release request:

    • Available request: If the API key changes while you have it checked out, and your current request is still valid, select Copy or Show again to obtain the new API key, if enabled by your Administrator.

      • The name, account, and remaining time is displayed.
      • Click  Copy to check out the API Key. This puts the value onto your clipboard, ready for you to use. Since you are not limited to a single API key per account, you may see additional keys listed.
      • In addition, depending on the platform, you can copy the Client Identifier, Client Secret, or Client Secret Identifier by clicking the  Copy button associated with each field. Click Show to view the information without copying, and Hide to conceal the information from view.
      • Once you are done working, click  Check-In Request to complete the password check out process.

    • Approved request: Select  Cancel Request to remove the request.

      An API key release request changes from Approved to Available when the requested time is reached. It stays available until you either cancel the request or it reaches the end of the duration period.

    • Pending request: Select  Cancel Request to remove the request.

    • Revoked request: Select Resubmit to request the API key again.

      Select  Remove to delete the request from the list.

    • Expired request: Select  Remove Request to delete the request from the list.

    • Denied request: Select Resubmit to request the API key again.

      Select  Remove Request to delete the request from the list.

Approving an API key release request

Depending on how the Security Policy Administrator configured the policy, an API key release request will either require approval by one or more Safeguard for Privileged Passwords users, or be auto-approved. Depending on policy configuration, approval can be automatic or require the consent of one or more users which provides closer control over system accounts.

You can revoke a request between the time the requester views it and checks it in.

Any eligible approver can deny an API key release request after it has already been approved or auto-approved. Once disallowed, the requester will no longer have access to the API key, but they are given another opportunity to request that API key again. The requester receives an email notifying them that the request was denied.

Safeguard for Privileged Passwords can be configured to notify you of an API key release request that requires your approval. For more information, see Configuring alerts..

To approve or deny an API key release request

Click Approvals on the left of the page to manage approvals. On the Approvals page, you can:

  • View details by selecting a request then looking at the details display on the right of the page.
  • Approve one or more request: Select the requests. Then, click Approve all selected requests to approve all the requests you selected. Optionally, enter a comment.
  • Deny one or more request: Select the requests. Then, click Deny all selected requests to deny all the requests you selected. Optionally, enter a comment.
  • Change the columns that display: Click and select the columns you want to see. You can select columns including:
    • Action: Displays Approve only this request and Deny only this request.
    • Requester / Status: Displays the user name and the status of the approval (for example, Pending 1 approval).
    • Asset / Access Type: Displays the name of the asset and the type of access (for example, Password, SSH Key, RDP, SSH, API Key, or Telnet).
    • Account: Displays the managed account name.
    • Ticket Number: Displays the ticket number, if required.
    • Requested For: Displays the date and time as well as the window of availability (for example, March 20, 2021 9:56 AM 2 hours).
  • Search: For more information, see Search box..

Reviewing a completed API key release request

The Security Policy Administrator can configure an access request policy to require a review of completed API key release requests for accounts in the scope of the policy.

You can configure Safeguard for Privileged Passwords to notify you of an API key release request that requires your review.

To review a completed API key release request

Select Reviews on the left of the page to manage reviews. On the Reviews page, you can:

  • View details by selecting a request then looking at the details display on the right of the page, including the workflow.
  • Mark one or more request as reviewed: Select the requests. Do the following:
    • If no comment is needed, click Mark all the selected requests as reviewed.
    • If a comment is needed, this icon will display as One or more of the selected requests requires review comments. Add the comment. Then, click Mark as Reviewed.
  • Change the columns that display: Click Select columns to display then select the columns you want to see.
    • Action: Displays This request requires review comments or Mark only this request as reviewed.
    • Requester: Displays the user name of the requester.
    • Access Type: Displays the type of access (for example, Password, SSH Key, RDP, RDP Application, SSH, API Key, or Telnet).
    • Account: Displays the managed account name.
    • Ticket Number: Displays the ticket number, if required.
    • Request For/Duration: Displays the date and time as well as the window of availability (for example, March 20, 2021 9:56 AM 2 hours).
  • Search: Click Search to see a list of searchable elements. Or, enter search characters. For more information, see For more information, see Search box..

Session request workflow

Authorized users can authorize connections, view active connections, limit access to specific resources, be alerted if connections exceed pre-set time limits, and even close connections.

Typically a session request follows the workflow below:

  1. Request: Users that are designated as an authorized user of an entitlement can request a session for any asset in the scope of that entitlement's policies.
  2. Approve: Depending on how the Security Policy Administrator configured the policy, a session request will either require approval by one or more Safeguard for Privileged Passwords users, or be auto-approved.
  3. Review: The Security Policy Administrator can optionally configure an access request policy to require a review of completed requests for assets in the scope of the policy. In addition, if session recording is enabled in the policy, reviewers can audit the workflow transactions and launch the Desktop Player to replay the session as part of the review process.
Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating