Skip to main content

Admin By Request

This Integration is part of the Admin By Request Pack.#

Supported versions

Supported Cortex XSOAR versions: 6.10.0 and later.

AdminByRequest is a Privileged Access Management (PAM) solution that enables secure, temporary elevation to local admin rights.

This is the default integration for this content pack when configured by the Data Onboarder in Cortex XSIAM.

Configure Admin By Request in Cortex#

ParameterDescriptionRequired
Server URLTrue
API KeyThe API Key allows you to programmatically integrate with the Armis ecosystem.True
Trust any certificate (not secure)False
Use system proxy settingsFalse
Fetch eventsFalse
Event types to fetchWhich records the integration should fetch from the AdminByRequest API. Available for Auditlogs, Events, and Requests.True
Maximum number of Auditlog per fetchMaximum number of audit log entries to retrieve per fetch cycle. Applies only if the "Auditlog" event type is enabled for fetching.False
Maximum number of Events per fetchMaximum number of events entries to retrieve per fetch cycle. Applies only if the "Events" event type is enabled for fetching.False
Maximum number of Requests per fetchMaximum number of requests entries to retrieve per fetch cycle. Applies only if the "Requests" event type is enabled for fetching.False

Commands#

You can execute these commands from the CLI, as part of an automation, or in a playbook. After you successfully execute a command, a DBot message appears in the War Room with the command details.

adminbyrequest-get-events#


Retrieves a list of entries logs events from the AdminByRequest instance.

Base Command#

adminbyrequest-get-events

Input#

Argument NameDescriptionRequired
should_push_eventsSet this argument to 'true' in order to create events, otherwise it will only display them. Possible values are: true, false. Default is false.Required
event_typeThe type of event to fetch. Default is Auditlog.Optional
limitReturns no more than the specified number of events (for entries of type 'Requests' the default value is 5000).Optional
first_fetchThe UTC date or relative timestamp from when to start fetching incidents. Notice that for event type 'Requests' there is the option to set a start date. Supported formats: N days, N weeks, N months, N years, yyyy-mm-dd.Optional

Context Output#

There is no context output for this command.

API Limitations#

  • Please DO NOT consistently use a high "limit" number or flood the API. The account will be automatically throttled.
  • Daily quota: 100,000 API calls (approximately 60 calls per minute maximum).