Chat now with support
Chat mit Support

One Identity Safeguard for Privileged Passwords 7.4.2 - User Guide

Requesting an API key release

If you are designated as an authorized user of an entitlement, you can request API keys for any account in the scope of the entitlement's policies.

You can configure One Identity Safeguard for Privileged Passwords to notify you of pending API key release workflow events, such as when an API key release request is pending, denied, or revoked, and so forth. For more information, see Configuring alerts..

To request an API key release

  1. Click Home then New Request or open My Requests then click New Request.

    NOTE: You can also submit an access request from your Favorites pane, if you previously saved it as a favorite.

  1. On the New Access Request page, select the accounts to be included in the access request and the type of access being requested for each selected account. You can search for accounts based on asset information. The assets available for selection are based on the scope defined in the entitlement's access request policies.

  2. NOTE: Use the button to select the columns to display.

    • Asset: The display name of the managed system.

    • Account: The available account appears in the Account column. When an asset has multiple accounts available, either Select Account(s) or the account name appears as a hyperlink in the Account column. Click the hyperlink in the Account column to display a list of accounts available and select the accounts to be included in the access request.

    • Access Type: The type of access request appears in the Access Type column. If the type is a drop-down, you can click the drop-down then multiple access request types are available. Click the drop-down and select the access type, in this case, API Key.

    • Account Description: (When applicable) The description of the account.

    • Asset Description: (When applicable) The description of the asset.

    You can remove an asset or account from the list by clearing the check box associated with an entry in the grid.

  3. Click Next.

  4. On Request Details, configure the following settings, which will apply to all of the selected assets and accounts:

    1. Emergency Access: If the policy has emergency access enabled, select this option to gain immediate emergency access to this API key. When you use Emergency Access, the request requires no approval. For more information, see Creating an access request policy.

    2. When: Select one of the following options:

      1. Now: If selected, the request is immediately created.

      2. Later: If selected, fields will appear allowing you to enter a specific date and time for the request in the user's local time.

    3. How Long: Based on the policy, do one of the following:
      • View the Checkout Duration.
      • If the Allow Requester to Change Duration option is enabled in the policy, you can set the days, hours, and minutes that you want to use the password. This overrides the Checkout Duration set in the access request policy. For more information, see Creating an access request policy.

    4. Ticket Number: If the policy requires a ticket number, enter a ticket number. If multiple accounts are in the request and one or more require a ticket number, the ticket number is applied to all of the requests associated with this access request. For more information, see Ticket systems.

    5. Reason: If the policy requires a reason, enter a reason. If multiple accounts are in the request and one or more require a reason. The reason is applied to all of the requests associated with this access request. For more information, see Reasons.

      Select the Description down arrow to view the description defined for the selected reason.

    6. Comment: If required, enter information about this request. When multiple accounts are specified in the request, if any of the selected accounts require a comment, you must enter a comment. The comment will be applied to all of the requests associated with this access request. The limit is 1000 characters.

  5. To save the access request as a favorite, select the Save this request as a favorite check box and enter a name for the request.

    This access request is then added to your Favorites. In the web client, favorites are displayed on the Home page and the My Requests page.

  6. After entering the required information, click Submit Request.

    Additional information displays if the access requests submitted were unsuccessful with information on how to address the issues. Once they have been addressed, you can resubmit the request.

When the request has been approved, you can use the API key. For more information, see Taking action on an API key release request.

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..
Verwandte Dokumente

The document was helpful.

Bewertung auswählen

I easily found the information I needed.

Bewertung auswählen