/okta-admin | Type: Application | PCID required: Yes
Tools
okta-admin_activate_authenticator
Activate an authenticator Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
authenticatorId | string | Yes | — | id of the authenticator |
okta-admin_activate_authenticator_method
Activate an authenticator method Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
authenticatorId | string | Yes | — | id of the authenticator |
methodType | string | Yes | — | Type of authenticator method |
okta-admin_activate_event_hook
Activate an event hook Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
eventHookId | string | Yes | — | id of the Event Hook |
okta-admin_activate_network_zone
Activate a network zone Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
zoneId | string | Yes | — | id of the Network Zone |
okta-admin_activate_trusted_origin
Activate a trusted origin Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
trustedOriginId | string | Yes | — | id of the trusted origin |
okta-admin_create_authenticator
Create an authenticator Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
activate | boolean | No | — | Whether to execute the activation lifecycle operation when Okta creates the authenticator |
_links | object | No | — | The links value |
created | string | No | — | Timestamp when the authenticator was created |
description | string | No | — | The description of the authenticator. This setting is only available for the webauthn authenticator type (Passkeys). |
id | string | No | — | A unique identifier for the authenticator |
key | string | No | — | A human-readable string that identifies the authenticator |
lastUpdated | string | No | — | Timestamp when the authenticator was last modified |
name | string | No | — | Display name of the authenticator |
status | object | No | — | The status value |
type | string | No | — | The type of authenticator |
okta-admin_create_custom_aaguid
Create a custom AAGUID Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
authenticatorId | string | Yes | — | id of the authenticator |
aaguid | string | No | — | An Authenticator Attestation Global Unique Identifier (AAGUID) is a 128-bit identifier indicating the model. |
attestationRootCertificates | object[] | No | — | Contains the certificate and information about it |
authenticatorCharacteristics | object | No | — | Contains additional properties about custom AAGUID. |
okta-admin_create_event_hook
Create an event hook Parameters:| Parameter | Type | Required | Default | Description | |
|---|---|---|---|---|---|
_links | object | No | — | The links value | |
channel | object | Yes | — | The channel value | |
created | string | No | — | Timestamp of the event hook creation | |
createdBy | string | No | — | The ID of the user who created the event hook | |
description | string | null | No | — | Description of the event hook |
events | object | Yes | — | The events value | |
id | string | No | — | Unique key for the event hook | |
lastUpdated | string | No | — | Date of the last event hook update | |
name | string | Yes | — | Display name for the event hook | |
status | string | No | — | Status of the event hook | |
verificationStatus | string | No | — | Verification status of the event hook. UNVERIFIED event hooks won’t receive any events. |
okta-admin_create_network_zone
Create a network zone Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
_links | object | No | — | The links value |
created | string | No | — | Timestamp when the object was created |
id | string | No | — | Unique identifier for the Network Zone |
lastUpdated | string | No | — | Timestamp when the object was last modified |
name | string | Yes | — | Unique name for this Network Zone |
status | string | No | — | Network Zone status |
system | boolean | No | — | Indicates 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. |
type | string | Yes | — | The type of Network Zone |
usage | string | No | — | The usage of the Network Zone |
okta-admin_create_trusted_origin
Create a trusted origin Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
name | string | No | — | Unique name for the trusted origin |
origin | string | No | — | Unique origin URL for the trusted origin. The supported schemes for this attribute are HTTP, HTTPS, FTP, Ionic 2, and Capacitor. |
scopes | object[] | No | — | Array of scope types that this trusted origin is used for |
okta-admin_deactivate_authenticator
Deactivate an authenticator Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
authenticatorId | string | Yes | — | id of the authenticator |
okta-admin_deactivate_authenticator_method
Deactivate an authenticator method Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
authenticatorId | string | Yes | — | id of the authenticator |
methodType | string | Yes | — | Type of authenticator method |
okta-admin_deactivate_event_hook
Deactivate an event hook Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
eventHookId | string | Yes | — | id of the Event Hook |
okta-admin_deactivate_network_zone
Deactivate a network zone Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
zoneId | string | Yes | — | id of the Network Zone |
okta-admin_deactivate_trusted_origin
Deactivate a trusted origin Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
trustedOriginId | string | Yes | — | id of the trusted origin |
okta-admin_delete_custom_aaguid
Delete a custom AAGUID Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
authenticatorId | string | Yes | — | id of the authenticator |
aaguid | string | Yes | — | Unique ID of a custom AAGUID |
okta-admin_delete_event_hook
Delete an event hook Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
eventHookId | string | Yes | — | id of the Event Hook |
okta-admin_delete_network_zone
Delete a network zone Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
zoneId | string | Yes | — | id of the Network Zone |
okta-admin_delete_trusted_origin
Delete a trusted origin Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
trustedOriginId | string | Yes | — | id of the trusted origin |
okta-admin_get_authenticator
Retrieve an authenticator Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
authenticatorId | string | Yes | — | id of the authenticator |
okta-admin_get_authenticator_method
Retrieve an authenticator method Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
authenticatorId | string | Yes | — | id of the authenticator |
methodType | string | Yes | — | Type of authenticator method |
okta-admin_get_custom_aaguid
Retrieve a custom AAGUID Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
authenticatorId | string | Yes | — | id of the authenticator |
aaguid | string | Yes | — | Unique ID of a custom AAGUID |
okta-admin_get_event_hook
Retrieve an event hook Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
eventHookId | string | Yes | — | id of the Event Hook |
okta-admin_get_network_zone
Retrieve a network zone Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
zoneId | string | Yes | — | id of the Network Zone |
okta-admin_get_trusted_origin
Retrieve a trusted origin Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
trustedOriginId | string | Yes | — | id of the trusted origin |
okta-admin_list_all_custom_aaguids
List all custom AAGUIDs Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
authenticatorId | string | Yes | — | id of the authenticator |
okta-admin_list_authenticator_methods
List all methods of an authenticator Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
authenticatorId | string | Yes | — | id of the authenticator |
okta-admin_list_authenticators
List all authenticatorsokta-admin_list_event_hooks
List all event hooksokta-admin_list_log_events
List all System Log events Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
since | string | No | — | Filters the lower time bound of the log events published property for bounded queries or persistence time for polling queries |
until | string | No | — | Filters the upper time bound of the log events published property for bounded queries or persistence time for polling queries. |
after | string | No | — | Retrieves the next page of results. Okta returns a link in the HTTP Header (rel=next) that includes the after query parameter |
filter | string | No | — | Filter expression that filters the results. All operators except [ ] are supported. See Filter and Operators. |
q | string | No | — | Filters log events results by one or more case insensitive keywords. |
limit | integer | No | — | Sets the number of results that are returned in the response |
sortOrder | string | No | — | The order of the returned events that are sorted by the published property |
okta-admin_list_network_zones
List all network zones Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
after | string | No | — | Specifies the pagination cursor for the next page of Network Zones |
limit | integer | No | — | Specifies the number of results for a page |
filter | string | No | — | Filters zones by usage, ID, or system expression |
okta-admin_list_trusted_origins
List all trusted origins Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
q | string | No | — | A search string that prefix matches against the name and origin |
filter | string | No | — | Filter 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). |
after | string | No | — | After cursor provided by a prior request |
limit | integer | No | — | Specifies the number of results |
okta-admin_replace_authenticator
Replace an authenticator Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
authenticatorId | string | Yes | — | id of the authenticator |
_links | object | No | — | The links value |
created | string | No | — | Timestamp when the authenticator was created |
description | string | No | — | The description of the authenticator. This setting is only available for the webauthn authenticator type (Passkeys). |
id | string | No | — | A unique identifier for the authenticator |
key | string | No | — | A human-readable string that identifies the authenticator |
lastUpdated | string | No | — | Timestamp when the authenticator was last modified |
name | string | No | — | Display name of the authenticator |
status | object | No | — | The status value |
type | string | No | — | The type of authenticator |
okta-admin_replace_authenticator_method
Replace an authenticator method Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
authenticatorId | string | Yes | — | id of the authenticator |
methodType | string | Yes | — | Type of authenticator method |
_links | object | No | — | The links value |
status | object | No | — | The status value |
type | string | No | — | The type of authenticator method |
okta-admin_replace_custom_aaguid
Replace a custom AAGUID Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
authenticatorId | string | Yes | — | id of the authenticator |
aaguid | string | Yes | — | Unique ID of a custom AAGUID |
attestationRootCertificates | object[] | No | — | Contains the certificate and information about it |
authenticatorCharacteristics | object | No | — | Contains additional properties about custom AAGUID. |
name | string | No | — | The product name associated with this AAGUID. |
okta-admin_replace_event_hook
Replace an event hook Parameters:| Parameter | Type | Required | Default | Description | |
|---|---|---|---|---|---|
eventHookId | string | Yes | — | id of the Event Hook | |
_links | object | No | — | The links value | |
channel | object | Yes | — | The channel value | |
created | string | No | — | Timestamp of the event hook creation | |
createdBy | string | No | — | The ID of the user who created the event hook | |
description | string | null | No | — | Description of the event hook |
events | object | Yes | — | The events value | |
id | string | No | — | Unique key for the event hook | |
lastUpdated | string | No | — | Date of the last event hook update | |
name | string | Yes | — | Display name for the event hook | |
status | string | No | — | Status of the event hook | |
verificationStatus | string | No | — | Verification status of the event hook. UNVERIFIED event hooks won’t receive any events. |
okta-admin_replace_network_zone
Replace a network zone Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
zoneId | string | Yes | — | id of the Network Zone |
_links | object | No | — | The links value |
created | string | No | — | Timestamp when the object was created |
id | string | No | — | Unique identifier for the Network Zone |
lastUpdated | string | No | — | Timestamp when the object was last modified |
name | string | Yes | — | Unique name for this Network Zone |
status | string | No | — | Network Zone status |
system | boolean | No | — | Indicates 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. |
type | string | Yes | — | The type of Network Zone |
usage | string | No | — | The usage of the Network Zone |
okta-admin_replace_trusted_origin
Replace a trusted origin Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
trustedOriginId | string | Yes | — | id of the trusted origin |
_links | object | No | — | The links value |
created | string | No | — | Timestamp when the trusted origin was created |
createdBy | string | No | — | The ID of the user who created the trusted origin |
id | string | No | — | Unique identifier for the trusted origin |
lastUpdated | string | No | — | Timestamp when the trusted origin was last updated |
lastUpdatedBy | string | No | — | The ID of the user who last updated the trusted origin |
name | string | No | — | Unique name for the trusted origin |
origin | string | No | — | Unique origin URL for the trusted origin. The supported schemes for this attribute are HTTP, HTTPS, FTP, Ionic 2, and Capacitor. |
scopes | object[] | No | — | Array of scope types that this trusted origin is used for |
status | string | No | — | The status value |
okta-admin_update_custom_aaguid
Update a custom AAGUID Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
authenticatorId | string | Yes | — | id of the authenticator |
aaguid | string | Yes | — | Unique ID of a custom AAGUID |
attestationRootCertificates | object[] | No | — | Contains the certificate and information about it |
authenticatorCharacteristics | object | No | — | Contains additional properties about custom AAGUID. |
name | string | No | — | The product name associated with this AAGUID. |
okta-admin_verify_event_hook
Verify an event hook Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
eventHookId | string | Yes | — | id of the Event Hook |
okta-admin_verify_rp_id_domain
Verify a Relying Party ID domain Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
authenticatorId | string | Yes | — | id of the authenticator |
webAuthnMethodType | string | Yes | — | Type of authenticator method |

