Skip to main content
Server path: /okta-admin | Type: Application | PCID required: Yes

Tools

ToolDescription
okta-admin_activate_authenticatorActivate an authenticator
okta-admin_activate_authenticator_methodActivate an authenticator method
okta-admin_activate_event_hookActivate an event hook
okta-admin_activate_network_zoneActivate a network zone
okta-admin_activate_trusted_originActivate a trusted origin
okta-admin_create_authenticatorCreate an authenticator
okta-admin_create_custom_aaguidCreate a custom AAGUID
okta-admin_create_event_hookCreate an event hook
okta-admin_create_network_zoneCreate a network zone
okta-admin_create_trusted_originCreate a trusted origin
okta-admin_deactivate_authenticatorDeactivate an authenticator
okta-admin_deactivate_authenticator_methodDeactivate an authenticator method
okta-admin_deactivate_event_hookDeactivate an event hook
okta-admin_deactivate_network_zoneDeactivate a network zone
okta-admin_deactivate_trusted_originDeactivate a trusted origin
okta-admin_delete_custom_aaguidDelete a custom AAGUID
okta-admin_delete_event_hookDelete an event hook
okta-admin_delete_network_zoneDelete a network zone
okta-admin_delete_trusted_originDelete a trusted origin
okta-admin_get_authenticatorRetrieve an authenticator
okta-admin_get_authenticator_methodRetrieve an authenticator method
okta-admin_get_custom_aaguidRetrieve a custom AAGUID
okta-admin_get_event_hookRetrieve an event hook
okta-admin_get_network_zoneRetrieve a network zone
okta-admin_get_trusted_originRetrieve a trusted origin
okta-admin_list_all_custom_aaguidsList all custom AAGUIDs
okta-admin_list_authenticator_methodsList all methods of an authenticator
okta-admin_list_authenticatorsList all authenticators
okta-admin_list_event_hooksList all event hooks
okta-admin_list_log_eventsList all System Log events
okta-admin_list_network_zonesList all network zones
okta-admin_list_trusted_originsList all trusted origins
okta-admin_replace_authenticatorReplace an authenticator
okta-admin_replace_authenticator_methodReplace an authenticator method
okta-admin_replace_custom_aaguidReplace a custom AAGUID
okta-admin_replace_event_hookReplace an event hook
okta-admin_replace_network_zoneReplace a network zone
okta-admin_replace_trusted_originReplace a trusted origin
okta-admin_update_custom_aaguidUpdate a custom AAGUID
okta-admin_verify_event_hookVerify an event hook
okta-admin_verify_rp_id_domainVerify a Relying Party ID domain

okta-admin_activate_authenticator

Activate an authenticator Parameters:
ParameterTypeRequiredDefaultDescription
authenticatorIdstringYesid of the authenticator

okta-admin_activate_authenticator_method

Activate an authenticator method Parameters:
ParameterTypeRequiredDefaultDescription
authenticatorIdstringYesid of the authenticator
methodTypestringYesType of authenticator method

okta-admin_activate_event_hook

Activate an event hook Parameters:
ParameterTypeRequiredDefaultDescription
eventHookIdstringYesid of the Event Hook

okta-admin_activate_network_zone

Activate a network zone Parameters:
ParameterTypeRequiredDefaultDescription
zoneIdstringYesid of the Network Zone

okta-admin_activate_trusted_origin

Activate a trusted origin Parameters:
ParameterTypeRequiredDefaultDescription
trustedOriginIdstringYesid of the trusted origin

okta-admin_create_authenticator

Create an authenticator Parameters:
ParameterTypeRequiredDefaultDescription
activatebooleanNoWhether to execute the activation lifecycle operation when Okta creates the authenticator
_linksobjectNoThe links value
createdstringNoTimestamp when the authenticator was created
descriptionstringNoThe description of the authenticator. This setting is only available for the webauthn authenticator type (Passkeys).
idstringNoA unique identifier for the authenticator
keystringNoA human-readable string that identifies the authenticator
lastUpdatedstringNoTimestamp when the authenticator was last modified
namestringNoDisplay name of the authenticator
statusobjectNoThe status value
typestringNoThe type of authenticator

okta-admin_create_custom_aaguid

Create a custom AAGUID Parameters:
ParameterTypeRequiredDefaultDescription
authenticatorIdstringYesid of the authenticator
aaguidstringNoAn Authenticator Attestation Global Unique Identifier (AAGUID) is a 128-bit identifier indicating the model.
attestationRootCertificatesobject[]NoContains the certificate and information about it
authenticatorCharacteristicsobjectNoContains additional properties about custom AAGUID.

okta-admin_create_event_hook

Create an event hook Parameters:
ParameterTypeRequiredDefaultDescription
_linksobjectNoThe links value
channelobjectYesThe channel value
createdstringNoTimestamp of the event hook creation
createdBystringNoThe ID of the user who created the event hook
descriptionstringnullNoDescription of the event hook
eventsobjectYesThe events value
idstringNoUnique key for the event hook
lastUpdatedstringNoDate of the last event hook update
namestringYesDisplay name for the event hook
statusstringNoStatus of the event hook
verificationStatusstringNoVerification status of the event hook. UNVERIFIED event hooks won’t receive any events.

okta-admin_create_network_zone

Create a network zone Parameters:
ParameterTypeRequiredDefaultDescription
_linksobjectNoThe links value
createdstringNoTimestamp when the object was created
idstringNoUnique identifier for the Network Zone
lastUpdatedstringNoTimestamp when the object was last modified
namestringYesUnique name for this Network Zone
statusstringNoNetwork Zone status
systembooleanNoIndicates a system Network Zone: * true for system Network Zones * false for custom Network Zones The Okta org provides the following default system Network Zones: * LegacyIpZone * BlockedIpZone * DefaultEnhancedDynamicZone * DefaultExemptIpZone Admins can modify the name of the default system Network Zone and add up to 5000 gateway or proxy IP entries.
typestringYesThe type of Network Zone
usagestringNoThe usage of the Network Zone

okta-admin_create_trusted_origin

Create a trusted origin Parameters:
ParameterTypeRequiredDefaultDescription
namestringNoUnique name for the trusted origin
originstringNoUnique origin URL for the trusted origin. The supported schemes for this attribute are HTTP, HTTPS, FTP, Ionic 2, and Capacitor.
scopesobject[]NoArray of scope types that this trusted origin is used for

okta-admin_deactivate_authenticator

Deactivate an authenticator Parameters:
ParameterTypeRequiredDefaultDescription
authenticatorIdstringYesid of the authenticator

okta-admin_deactivate_authenticator_method

Deactivate an authenticator method Parameters:
ParameterTypeRequiredDefaultDescription
authenticatorIdstringYesid of the authenticator
methodTypestringYesType of authenticator method

okta-admin_deactivate_event_hook

Deactivate an event hook Parameters:
ParameterTypeRequiredDefaultDescription
eventHookIdstringYesid of the Event Hook

okta-admin_deactivate_network_zone

Deactivate a network zone Parameters:
ParameterTypeRequiredDefaultDescription
zoneIdstringYesid of the Network Zone

okta-admin_deactivate_trusted_origin

Deactivate a trusted origin Parameters:
ParameterTypeRequiredDefaultDescription
trustedOriginIdstringYesid of the trusted origin

okta-admin_delete_custom_aaguid

Delete a custom AAGUID Parameters:
ParameterTypeRequiredDefaultDescription
authenticatorIdstringYesid of the authenticator
aaguidstringYesUnique ID of a custom AAGUID

okta-admin_delete_event_hook

Delete an event hook Parameters:
ParameterTypeRequiredDefaultDescription
eventHookIdstringYesid of the Event Hook

okta-admin_delete_network_zone

Delete a network zone Parameters:
ParameterTypeRequiredDefaultDescription
zoneIdstringYesid of the Network Zone

okta-admin_delete_trusted_origin

Delete a trusted origin Parameters:
ParameterTypeRequiredDefaultDescription
trustedOriginIdstringYesid of the trusted origin

okta-admin_get_authenticator

Retrieve an authenticator Parameters:
ParameterTypeRequiredDefaultDescription
authenticatorIdstringYesid of the authenticator

okta-admin_get_authenticator_method

Retrieve an authenticator method Parameters:
ParameterTypeRequiredDefaultDescription
authenticatorIdstringYesid of the authenticator
methodTypestringYesType of authenticator method

okta-admin_get_custom_aaguid

Retrieve a custom AAGUID Parameters:
ParameterTypeRequiredDefaultDescription
authenticatorIdstringYesid of the authenticator
aaguidstringYesUnique ID of a custom AAGUID

okta-admin_get_event_hook

Retrieve an event hook Parameters:
ParameterTypeRequiredDefaultDescription
eventHookIdstringYesid of the Event Hook

okta-admin_get_network_zone

Retrieve a network zone Parameters:
ParameterTypeRequiredDefaultDescription
zoneIdstringYesid of the Network Zone

okta-admin_get_trusted_origin

Retrieve a trusted origin Parameters:
ParameterTypeRequiredDefaultDescription
trustedOriginIdstringYesid of the trusted origin

okta-admin_list_all_custom_aaguids

List all custom AAGUIDs Parameters:
ParameterTypeRequiredDefaultDescription
authenticatorIdstringYesid of the authenticator

okta-admin_list_authenticator_methods

List all methods of an authenticator Parameters:
ParameterTypeRequiredDefaultDescription
authenticatorIdstringYesid of the authenticator

okta-admin_list_authenticators

List all authenticators

okta-admin_list_event_hooks

List all event hooks

okta-admin_list_log_events

List all System Log events Parameters:
ParameterTypeRequiredDefaultDescription
sincestringNoFilters the lower time bound of the log events published property for bounded queries or persistence time for polling queries
untilstringNoFilters the upper time bound of the log events published property for bounded queries or persistence time for polling queries.
afterstringNoRetrieves the next page of results. Okta returns a link in the HTTP Header (rel=next) that includes the after query parameter
filterstringNoFilter expression that filters the results. All operators except [ ] are supported. See Filter and Operators.
qstringNoFilters log events results by one or more case insensitive keywords.
limitintegerNoSets the number of results that are returned in the response
sortOrderstringNoThe order of the returned events that are sorted by the published property

okta-admin_list_network_zones

List all network zones Parameters:
ParameterTypeRequiredDefaultDescription
afterstringNoSpecifies the pagination cursor for the next page of Network Zones
limitintegerNoSpecifies the number of results for a page
filterstringNoFilters zones by usage, ID, or system expression

okta-admin_list_trusted_origins

List all trusted origins Parameters:
ParameterTypeRequiredDefaultDescription
qstringNoA search string that prefix matches against the name and origin
filterstringNoFilter trusted origins with a supported expression for a subset of properties. You can filter on the following properties: name, origin, status, and type (type of scopes).
afterstringNoAfter cursor provided by a prior request
limitintegerNoSpecifies the number of results

okta-admin_replace_authenticator

Replace an authenticator Parameters:
ParameterTypeRequiredDefaultDescription
authenticatorIdstringYesid of the authenticator
_linksobjectNoThe links value
createdstringNoTimestamp when the authenticator was created
descriptionstringNoThe description of the authenticator. This setting is only available for the webauthn authenticator type (Passkeys).
idstringNoA unique identifier for the authenticator
keystringNoA human-readable string that identifies the authenticator
lastUpdatedstringNoTimestamp when the authenticator was last modified
namestringNoDisplay name of the authenticator
statusobjectNoThe status value
typestringNoThe type of authenticator

okta-admin_replace_authenticator_method

Replace an authenticator method Parameters:
ParameterTypeRequiredDefaultDescription
authenticatorIdstringYesid of the authenticator
methodTypestringYesType of authenticator method
_linksobjectNoThe links value
statusobjectNoThe status value
typestringNoThe type of authenticator method

okta-admin_replace_custom_aaguid

Replace a custom AAGUID Parameters:
ParameterTypeRequiredDefaultDescription
authenticatorIdstringYesid of the authenticator
aaguidstringYesUnique ID of a custom AAGUID
attestationRootCertificatesobject[]NoContains the certificate and information about it
authenticatorCharacteristicsobjectNoContains additional properties about custom AAGUID.
namestringNoThe product name associated with this AAGUID.

okta-admin_replace_event_hook

Replace an event hook Parameters:
ParameterTypeRequiredDefaultDescription
eventHookIdstringYesid of the Event Hook
_linksobjectNoThe links value
channelobjectYesThe channel value
createdstringNoTimestamp of the event hook creation
createdBystringNoThe ID of the user who created the event hook
descriptionstringnullNoDescription of the event hook
eventsobjectYesThe events value
idstringNoUnique key for the event hook
lastUpdatedstringNoDate of the last event hook update
namestringYesDisplay name for the event hook
statusstringNoStatus of the event hook
verificationStatusstringNoVerification status of the event hook. UNVERIFIED event hooks won’t receive any events.

okta-admin_replace_network_zone

Replace a network zone Parameters:
ParameterTypeRequiredDefaultDescription
zoneIdstringYesid of the Network Zone
_linksobjectNoThe links value
createdstringNoTimestamp when the object was created
idstringNoUnique identifier for the Network Zone
lastUpdatedstringNoTimestamp when the object was last modified
namestringYesUnique name for this Network Zone
statusstringNoNetwork Zone status
systembooleanNoIndicates a system Network Zone: * true for system Network Zones * false for custom Network Zones The Okta org provides the following default system Network Zones: * LegacyIpZone * BlockedIpZone * DefaultEnhancedDynamicZone * DefaultExemptIpZone Admins can modify the name of the default system Network Zone and add up to 5000 gateway or proxy IP entries.
typestringYesThe type of Network Zone
usagestringNoThe usage of the Network Zone

okta-admin_replace_trusted_origin

Replace a trusted origin Parameters:
ParameterTypeRequiredDefaultDescription
trustedOriginIdstringYesid of the trusted origin
_linksobjectNoThe links value
createdstringNoTimestamp when the trusted origin was created
createdBystringNoThe ID of the user who created the trusted origin
idstringNoUnique identifier for the trusted origin
lastUpdatedstringNoTimestamp when the trusted origin was last updated
lastUpdatedBystringNoThe ID of the user who last updated the trusted origin
namestringNoUnique name for the trusted origin
originstringNoUnique origin URL for the trusted origin. The supported schemes for this attribute are HTTP, HTTPS, FTP, Ionic 2, and Capacitor.
scopesobject[]NoArray of scope types that this trusted origin is used for
statusstringNoThe status value

okta-admin_update_custom_aaguid

Update a custom AAGUID Parameters:
ParameterTypeRequiredDefaultDescription
authenticatorIdstringYesid of the authenticator
aaguidstringYesUnique ID of a custom AAGUID
attestationRootCertificatesobject[]NoContains the certificate and information about it
authenticatorCharacteristicsobjectNoContains additional properties about custom AAGUID.
namestringNoThe product name associated with this AAGUID.

okta-admin_verify_event_hook

Verify an event hook Parameters:
ParameterTypeRequiredDefaultDescription
eventHookIdstringYesid of the Event Hook

okta-admin_verify_rp_id_domain

Verify a Relying Party ID domain Parameters:
ParameterTypeRequiredDefaultDescription
authenticatorIdstringYesid of the authenticator
webAuthnMethodTypestringYesType of authenticator method