/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 |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"authenticatorId": {
"type": "string",
"description": "`id` of the authenticator"
}
},
"required": [
"PCID",
"authenticatorId"
]
}
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 |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"authenticatorId": {
"type": "string",
"description": "`id` of the authenticator"
},
"methodType": {
"type": "string",
"description": "Type of authenticator method",
"enum": [
"cert",
"duo",
"email",
"idp",
"otp",
"password",
"push",
"security_question",
"signed_nonce",
"sms",
"totp",
"voice",
"webauthn",
"tac"
]
}
},
"required": [
"PCID",
"authenticatorId",
"methodType"
]
}
okta-admin_activate_event_hook
Activate an event hook Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
eventHookId | string | Yes | — | id of the Event Hook |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"eventHookId": {
"type": "string",
"description": "`id` of the Event Hook"
}
},
"required": [
"PCID",
"eventHookId"
]
}
okta-admin_activate_network_zone
Activate a network zone Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
zoneId | string | Yes | — | id of the Network Zone |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"zoneId": {
"type": "string",
"description": "`id` of the Network Zone"
}
},
"required": [
"PCID",
"zoneId"
]
}
okta-admin_activate_trusted_origin
Activate a trusted origin Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
trustedOriginId | string | Yes | — | id of the trusted origin |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"trustedOriginId": {
"type": "string",
"description": "`id` of the trusted origin"
}
},
"required": [
"PCID",
"trustedOriginId"
]
}
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 |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"activate": {
"type": "boolean",
"description": "Whether to execute the activation lifecycle operation when Okta creates the authenticator"
},
"_links": {
"description": "The links value"
},
"created": {
"type": "string",
"description": "Timestamp when the authenticator was created"
},
"description": {
"type": "string",
"description": "The description of the authenticator. This setting is only available for the `webauthn` authenticator type (Passkeys)."
},
"id": {
"type": "string",
"description": "A unique identifier for the authenticator"
},
"key": {
"type": "string",
"description": "A human-readable string that identifies the authenticator",
"enum": [
"custom_app",
"duo",
"external_idp",
"google_otp",
"okta_email",
"okta_password",
"okta_verify",
"onprem_mfa",
"phone_number",
"security_key",
"security_question",
"smart_card_idp",
"symantec_vip",
"webauthn",
"yubikey_token",
"tac"
]
},
"lastUpdated": {
"type": "string",
"description": "Timestamp when the authenticator was last modified"
},
"name": {
"type": "string",
"description": "Display name of the authenticator"
},
"status": {
"description": "The status value"
},
"type": {
"type": "string",
"description": "The type of authenticator",
"enum": [
"app",
"email",
"federated",
"password",
"phone",
"security_key",
"security_question",
"tac"
]
}
},
"required": [
"PCID"
]
}
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. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"authenticatorId": {
"type": "string",
"description": "`id` of the authenticator"
},
"aaguid": {
"type": "string",
"description": "An Authenticator Attestation Global Unique Identifier (AAGUID) is a 128-bit identifier indicating the model."
},
"attestationRootCertificates": {
"type": "array",
"items": {
"type": "object",
"properties": {
"x5c": {
"type": "string",
"description": "X.509 certificate chain"
}
}
},
"description": "Contains the certificate and information about it"
},
"authenticatorCharacteristics": {
"type": "object",
"description": "Contains additional properties about custom AAGUID.",
"properties": {
"fipsCompliant": {
"type": "boolean",
"description": "Indicates whether the authenticator meets Federal Information Processing Standards (FIPS) compliance requirements"
},
"hardwareProtected": {
"type": "boolean",
"description": "Indicates whether the authenticator stores the private key on a hardware component"
},
"platformAttached": {
"type": "boolean",
"description": "Indicates whether the custom AAGUID is built into the authenticator (`true`) or if it's a separate, external authenticator"
}
}
}
},
"required": [
"PCID",
"authenticatorId"
]
}
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. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"_links": {
"description": "The links value"
},
"channel": {
"type": "object",
"description": "The channel value",
"properties": {
"config": {
"type": "object",
"description": "The config value"
},
"type": {
"type": "string",
"description": "The channel type. Currently supports `HTTP`.",
"enum": [
"HTTP"
]
},
"version": {
"type": "string",
"description": "Version of the channel. Currently the only supported version is `1.0.0`."
}
},
"required": [
"type",
"config",
"version"
]
},
"created": {
"type": "string",
"description": "Timestamp of the event hook creation"
},
"createdBy": {
"type": "string",
"description": "The ID of the user who created the event hook"
},
"description": {
"type": [
"string",
"null"
],
"description": "Description of the event hook"
},
"events": {
"type": "object",
"description": "The events value",
"properties": {
"filter": {
"type": "object",
"description": "The optional filter defined on a specific event type > **Note:** Event hook filters is a [self-service Early Access (EA)](/openapi/okta-management/guides/release-lifecycle/#early-access-ea) to enable. If you want to disable this feature, it's recommended to first remove all event filters."
},
"items": {
"type": "array",
"items": {
"type": "string"
},
"description": "The subscribed event types that trigger the event hook. When you register an event hook you need to specify which events you want to subscribe to. To see the list of event types currently eligible for use in event hooks, use the [Event Types catalog](https://developer.okta.com/docs/reference/api/event-types/#catalog) and search with the parameter `event-hook-eligible`."
},
"type": {
"type": "string",
"description": "The events object type. Currently supports `EVENT_TYPE`.",
"enum": [
"EVENT_TYPE"
]
}
},
"required": [
"type",
"items"
]
},
"id": {
"type": "string",
"description": "Unique key for the event hook"
},
"lastUpdated": {
"type": "string",
"description": "Date of the last event hook update"
},
"name": {
"type": "string",
"description": "Display name for the event hook"
},
"status": {
"type": "string",
"description": "Status of the event hook",
"enum": [
"ACTIVE",
"INACTIVE"
]
},
"verificationStatus": {
"type": "string",
"description": "Verification status of the event hook. `UNVERIFIED` event hooks won't receive any events.",
"enum": [
"UNVERIFIED",
"VERIFIED"
]
}
},
"required": [
"PCID",
"channel",
"events",
"name"
]
}
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 |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"_links": {
"description": "The links value"
},
"created": {
"type": "string",
"description": "Timestamp when the object was created"
},
"id": {
"type": "string",
"description": "Unique identifier for the Network Zone"
},
"lastUpdated": {
"type": "string",
"description": "Timestamp when the object was last modified"
},
"name": {
"type": "string",
"description": "Unique name for this Network Zone"
},
"status": {
"type": "string",
"description": "Network Zone status",
"enum": [
"ACTIVE",
"INACTIVE"
]
},
"system": {
"type": "boolean",
"description": "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": {
"type": "string",
"description": "The type of Network Zone",
"enum": [
"DYNAMIC",
"IP",
"DYNAMIC_V2"
]
},
"usage": {
"type": "string",
"description": "The usage of the Network Zone",
"enum": [
"BLOCKLIST",
"POLICY"
]
}
},
"required": [
"PCID",
"name",
"type"
]
}
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 |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"name": {
"type": "string",
"description": "Unique name for the trusted origin"
},
"origin": {
"type": "string",
"description": "Unique origin URL for the trusted origin. The supported schemes for this attribute are HTTP, HTTPS, FTP, Ionic 2, and Capacitor."
},
"scopes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"allowedOktaApps": {
"type": "array",
"items": {
"type": "string"
},
"description": "The allowed Okta apps for the trusted origin scope"
},
"type": {
"type": "string",
"enum": [
"CORS",
"IFRAME_EMBED",
"REDIRECT"
],
"description": "The scope type. Supported values: When you use `IFRAME_EMBED` as the scope type, leave the `allowedOktaApps` property empty to allow iFrame embedding of only Okta sign-in pages. Include `OKTA_ENDUSER` as a value for the `allowedOktaApps` property to allow iFrame embedding of both Okta sign-in pages and the Okta End-User Dashboard."
}
}
},
"description": "Array of scope types that this trusted origin is used for"
}
},
"required": [
"PCID"
]
}
okta-admin_deactivate_authenticator
Deactivate an authenticator Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
authenticatorId | string | Yes | — | id of the authenticator |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"authenticatorId": {
"type": "string",
"description": "`id` of the authenticator"
}
},
"required": [
"PCID",
"authenticatorId"
]
}
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 |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"authenticatorId": {
"type": "string",
"description": "`id` of the authenticator"
},
"methodType": {
"type": "string",
"description": "Type of authenticator method",
"enum": [
"cert",
"duo",
"email",
"idp",
"otp",
"password",
"push",
"security_question",
"signed_nonce",
"sms",
"totp",
"voice",
"webauthn",
"tac"
]
}
},
"required": [
"PCID",
"authenticatorId",
"methodType"
]
}
okta-admin_deactivate_event_hook
Deactivate an event hook Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
eventHookId | string | Yes | — | id of the Event Hook |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"eventHookId": {
"type": "string",
"description": "`id` of the Event Hook"
}
},
"required": [
"PCID",
"eventHookId"
]
}
okta-admin_deactivate_network_zone
Deactivate a network zone Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
zoneId | string | Yes | — | id of the Network Zone |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"zoneId": {
"type": "string",
"description": "`id` of the Network Zone"
}
},
"required": [
"PCID",
"zoneId"
]
}
okta-admin_deactivate_trusted_origin
Deactivate a trusted origin Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
trustedOriginId | string | Yes | — | id of the trusted origin |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"trustedOriginId": {
"type": "string",
"description": "`id` of the trusted origin"
}
},
"required": [
"PCID",
"trustedOriginId"
]
}
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 |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"authenticatorId": {
"type": "string",
"description": "`id` of the authenticator"
},
"aaguid": {
"type": "string",
"description": "Unique ID of a custom AAGUID"
}
},
"required": [
"PCID",
"authenticatorId",
"aaguid"
]
}
okta-admin_delete_event_hook
Delete an event hook Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
eventHookId | string | Yes | — | id of the Event Hook |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"eventHookId": {
"type": "string",
"description": "`id` of the Event Hook"
}
},
"required": [
"PCID",
"eventHookId"
]
}
okta-admin_delete_network_zone
Delete a network zone Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
zoneId | string | Yes | — | id of the Network Zone |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"zoneId": {
"type": "string",
"description": "`id` of the Network Zone"
}
},
"required": [
"PCID",
"zoneId"
]
}
okta-admin_delete_trusted_origin
Delete a trusted origin Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
trustedOriginId | string | Yes | — | id of the trusted origin |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"trustedOriginId": {
"type": "string",
"description": "`id` of the trusted origin"
}
},
"required": [
"PCID",
"trustedOriginId"
]
}
okta-admin_get_authenticator
Retrieve an authenticator Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
authenticatorId | string | Yes | — | id of the authenticator |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"authenticatorId": {
"type": "string",
"description": "`id` of the authenticator"
}
},
"required": [
"PCID",
"authenticatorId"
]
}
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 |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"authenticatorId": {
"type": "string",
"description": "`id` of the authenticator"
},
"methodType": {
"type": "string",
"description": "Type of authenticator method",
"enum": [
"cert",
"duo",
"email",
"idp",
"otp",
"password",
"push",
"security_question",
"signed_nonce",
"sms",
"totp",
"voice",
"webauthn",
"tac"
]
}
},
"required": [
"PCID",
"authenticatorId",
"methodType"
]
}
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 |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"authenticatorId": {
"type": "string",
"description": "`id` of the authenticator"
},
"aaguid": {
"type": "string",
"description": "Unique ID of a custom AAGUID"
}
},
"required": [
"PCID",
"authenticatorId",
"aaguid"
]
}
okta-admin_get_event_hook
Retrieve an event hook Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
eventHookId | string | Yes | — | id of the Event Hook |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"eventHookId": {
"type": "string",
"description": "`id` of the Event Hook"
}
},
"required": [
"PCID",
"eventHookId"
]
}
okta-admin_get_network_zone
Retrieve a network zone Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
zoneId | string | Yes | — | id of the Network Zone |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"zoneId": {
"type": "string",
"description": "`id` of the Network Zone"
}
},
"required": [
"PCID",
"zoneId"
]
}
okta-admin_get_trusted_origin
Retrieve a trusted origin Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
trustedOriginId | string | Yes | — | id of the trusted origin |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"trustedOriginId": {
"type": "string",
"description": "`id` of the trusted origin"
}
},
"required": [
"PCID",
"trustedOriginId"
]
}
okta-admin_list_all_custom_aaguids
List all custom AAGUIDs Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
authenticatorId | string | Yes | — | id of the authenticator |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"authenticatorId": {
"type": "string",
"description": "`id` of the authenticator"
}
},
"required": [
"PCID",
"authenticatorId"
]
}
okta-admin_list_authenticator_methods
List all methods of an authenticator Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
authenticatorId | string | Yes | — | id of the authenticator |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"authenticatorId": {
"type": "string",
"description": "`id` of the authenticator"
}
},
"required": [
"PCID",
"authenticatorId"
]
}
okta-admin_list_authenticators
List all authenticatorsShow inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
}
},
"required": [
"PCID"
]
}
okta-admin_list_event_hooks
List all event hooksShow inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
}
},
"required": [
"PCID"
]
}
okta-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 |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"since": {
"type": "string",
"description": "Filters the lower time bound of the log events `published` property for bounded queries or persistence time for polling queries"
},
"until": {
"type": "string",
"description": "Filters the upper time bound of the log events `published` property for bounded queries or persistence time for polling queries."
},
"after": {
"type": "string",
"description": "Retrieves the next page of results. Okta returns a link in the HTTP Header (`rel=next`) that includes the after query parameter"
},
"filter": {
"type": "string",
"description": "Filter expression that filters the results. All operators except [ ] are supported. See [Filter](https://developer.okta.com/docs/api/#filter) and [Operators](https://developer.okta.com/docs/api/#operators)."
},
"q": {
"type": "string",
"description": "Filters log events results by one or more case insensitive keywords."
},
"limit": {
"type": "integer",
"description": "Sets the number of results that are returned in the response"
},
"sortOrder": {
"type": "string",
"description": "The order of the returned events that are sorted by the `published` property",
"enum": [
"ASCENDING",
"DESCENDING"
]
}
},
"required": [
"PCID"
]
}
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 |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"after": {
"type": "string",
"description": "Specifies the pagination cursor for the next page of Network Zones"
},
"limit": {
"type": "integer",
"description": "Specifies the number of results for a page"
},
"filter": {
"type": "string",
"description": "Filters zones by usage, ID, or system expression"
}
},
"required": [
"PCID"
]
}
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 |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"q": {
"type": "string",
"description": "A search string that prefix matches against the `name` and `origin`"
},
"filter": {
"type": "string",
"description": "[Filter](https://developer.okta.com/docs/api/#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": {
"type": "string",
"description": "After cursor provided by a prior request"
},
"limit": {
"type": "integer",
"description": "Specifies the number of results"
}
},
"required": [
"PCID"
]
}
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 |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"authenticatorId": {
"type": "string",
"description": "`id` of the authenticator"
},
"_links": {
"description": "The links value"
},
"created": {
"type": "string",
"description": "Timestamp when the authenticator was created"
},
"description": {
"type": "string",
"description": "The description of the authenticator. This setting is only available for the `webauthn` authenticator type (Passkeys)."
},
"id": {
"type": "string",
"description": "A unique identifier for the authenticator"
},
"key": {
"type": "string",
"description": "A human-readable string that identifies the authenticator",
"enum": [
"custom_app",
"duo",
"external_idp",
"google_otp",
"okta_email",
"okta_password",
"okta_verify",
"onprem_mfa",
"phone_number",
"security_key",
"security_question",
"smart_card_idp",
"symantec_vip",
"webauthn",
"yubikey_token",
"tac"
]
},
"lastUpdated": {
"type": "string",
"description": "Timestamp when the authenticator was last modified"
},
"name": {
"type": "string",
"description": "Display name of the authenticator"
},
"status": {
"description": "The status value"
},
"type": {
"type": "string",
"description": "The type of authenticator",
"enum": [
"app",
"email",
"federated",
"password",
"phone",
"security_key",
"security_question",
"tac"
]
}
},
"required": [
"PCID",
"authenticatorId"
]
}
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 |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"authenticatorId": {
"type": "string",
"description": "`id` of the authenticator"
},
"methodType": {
"type": "string",
"description": "Type of authenticator method",
"enum": [
"cert",
"duo",
"email",
"idp",
"otp",
"password",
"push",
"security_question",
"signed_nonce",
"sms",
"totp",
"voice",
"webauthn",
"tac"
]
},
"_links": {
"description": "The links value"
},
"status": {
"description": "The status value"
},
"type": {
"type": "string",
"description": "The type of authenticator method",
"enum": [
"cert",
"duo",
"email",
"idp",
"otp",
"password",
"push",
"security_question",
"signed_nonce",
"sms",
"totp",
"voice",
"webauthn",
"tac"
]
}
},
"required": [
"PCID",
"authenticatorId",
"methodType"
]
}
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. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"authenticatorId": {
"type": "string",
"description": "`id` of the authenticator"
},
"aaguid": {
"type": "string",
"description": "Unique ID of a custom AAGUID"
},
"attestationRootCertificates": {
"type": "array",
"items": {
"type": "object",
"properties": {
"x5c": {
"type": "string",
"description": "X.509 certificate chain"
}
}
},
"description": "Contains the certificate and information about it"
},
"authenticatorCharacteristics": {
"type": "object",
"description": "Contains additional properties about custom AAGUID.",
"properties": {
"fipsCompliant": {
"type": "boolean",
"description": "Indicates whether the authenticator meets Federal Information Processing Standards (FIPS) compliance requirements"
},
"hardwareProtected": {
"type": "boolean",
"description": "Indicates whether the authenticator stores the private key on a hardware component"
},
"platformAttached": {
"type": "boolean",
"description": "Indicates whether the custom AAGUID is built into the authenticator (`true`) or if it's a separate, external authenticator"
}
}
},
"name": {
"type": "string",
"description": "The product name associated with this AAGUID."
}
},
"required": [
"PCID",
"authenticatorId",
"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. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"eventHookId": {
"type": "string",
"description": "`id` of the Event Hook"
},
"_links": {
"description": "The links value"
},
"channel": {
"type": "object",
"description": "The channel value",
"properties": {
"config": {
"type": "object",
"description": "The config value"
},
"type": {
"type": "string",
"description": "The channel type. Currently supports `HTTP`.",
"enum": [
"HTTP"
]
},
"version": {
"type": "string",
"description": "Version of the channel. Currently the only supported version is `1.0.0`."
}
},
"required": [
"type",
"config",
"version"
]
},
"created": {
"type": "string",
"description": "Timestamp of the event hook creation"
},
"createdBy": {
"type": "string",
"description": "The ID of the user who created the event hook"
},
"description": {
"type": [
"string",
"null"
],
"description": "Description of the event hook"
},
"events": {
"type": "object",
"description": "The events value",
"properties": {
"filter": {
"type": "object",
"description": "The optional filter defined on a specific event type > **Note:** Event hook filters is a [self-service Early Access (EA)](/openapi/okta-management/guides/release-lifecycle/#early-access-ea) to enable. If you want to disable this feature, it's recommended to first remove all event filters."
},
"items": {
"type": "array",
"items": {
"type": "string"
},
"description": "The subscribed event types that trigger the event hook. When you register an event hook you need to specify which events you want to subscribe to. To see the list of event types currently eligible for use in event hooks, use the [Event Types catalog](https://developer.okta.com/docs/reference/api/event-types/#catalog) and search with the parameter `event-hook-eligible`."
},
"type": {
"type": "string",
"description": "The events object type. Currently supports `EVENT_TYPE`.",
"enum": [
"EVENT_TYPE"
]
}
},
"required": [
"type",
"items"
]
},
"id": {
"type": "string",
"description": "Unique key for the event hook"
},
"lastUpdated": {
"type": "string",
"description": "Date of the last event hook update"
},
"name": {
"type": "string",
"description": "Display name for the event hook"
},
"status": {
"type": "string",
"description": "Status of the event hook",
"enum": [
"ACTIVE",
"INACTIVE"
]
},
"verificationStatus": {
"type": "string",
"description": "Verification status of the event hook. `UNVERIFIED` event hooks won't receive any events.",
"enum": [
"UNVERIFIED",
"VERIFIED"
]
}
},
"required": [
"PCID",
"eventHookId",
"channel",
"events",
"name"
]
}
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 |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"zoneId": {
"type": "string",
"description": "`id` of the Network Zone"
},
"_links": {
"description": "The links value"
},
"created": {
"type": "string",
"description": "Timestamp when the object was created"
},
"id": {
"type": "string",
"description": "Unique identifier for the Network Zone"
},
"lastUpdated": {
"type": "string",
"description": "Timestamp when the object was last modified"
},
"name": {
"type": "string",
"description": "Unique name for this Network Zone"
},
"status": {
"type": "string",
"description": "Network Zone status",
"enum": [
"ACTIVE",
"INACTIVE"
]
},
"system": {
"type": "boolean",
"description": "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": {
"type": "string",
"description": "The type of Network Zone",
"enum": [
"DYNAMIC",
"IP",
"DYNAMIC_V2"
]
},
"usage": {
"type": "string",
"description": "The usage of the Network Zone",
"enum": [
"BLOCKLIST",
"POLICY"
]
}
},
"required": [
"PCID",
"zoneId",
"name",
"type"
]
}
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 |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"trustedOriginId": {
"type": "string",
"description": "`id` of the trusted origin"
},
"_links": {
"description": "The links value"
},
"created": {
"type": "string",
"description": "Timestamp when the trusted origin was created"
},
"createdBy": {
"type": "string",
"description": "The ID of the user who created the trusted origin"
},
"id": {
"type": "string",
"description": "Unique identifier for the trusted origin"
},
"lastUpdated": {
"type": "string",
"description": "Timestamp when the trusted origin was last updated"
},
"lastUpdatedBy": {
"type": "string",
"description": "The ID of the user who last updated the trusted origin"
},
"name": {
"type": "string",
"description": "Unique name for the trusted origin"
},
"origin": {
"type": "string",
"description": "Unique origin URL for the trusted origin. The supported schemes for this attribute are HTTP, HTTPS, FTP, Ionic 2, and Capacitor."
},
"scopes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"allowedOktaApps": {
"type": "array",
"items": {
"type": "string"
},
"description": "The allowed Okta apps for the trusted origin scope"
},
"type": {
"type": "string",
"enum": [
"CORS",
"IFRAME_EMBED",
"REDIRECT"
],
"description": "The scope type. Supported values: When you use `IFRAME_EMBED` as the scope type, leave the `allowedOktaApps` property empty to allow iFrame embedding of only Okta sign-in pages. Include `OKTA_ENDUSER` as a value for the `allowedOktaApps` property to allow iFrame embedding of both Okta sign-in pages and the Okta End-User Dashboard."
}
}
},
"description": "Array of scope types that this trusted origin is used for"
},
"status": {
"type": "string",
"description": "The status value",
"enum": [
"ACTIVE",
"INACTIVE"
]
}
},
"required": [
"PCID",
"trustedOriginId"
]
}
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. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"authenticatorId": {
"type": "string",
"description": "`id` of the authenticator"
},
"aaguid": {
"type": "string",
"description": "Unique ID of a custom AAGUID"
},
"attestationRootCertificates": {
"type": "array",
"items": {
"type": "object",
"properties": {
"x5c": {
"type": "string",
"description": "X.509 certificate chain"
}
}
},
"description": "Contains the certificate and information about it"
},
"authenticatorCharacteristics": {
"type": "object",
"description": "Contains additional properties about custom AAGUID.",
"properties": {
"fipsCompliant": {
"type": "boolean",
"description": "Indicates whether the authenticator meets Federal Information Processing Standards (FIPS) compliance requirements"
},
"hardwareProtected": {
"type": "boolean",
"description": "Indicates whether the authenticator stores the private key on a hardware component"
},
"platformAttached": {
"type": "boolean",
"description": "Indicates whether the custom AAGUID is built into the authenticator (`true`) or if it's a separate, external authenticator"
}
}
},
"name": {
"type": "string",
"description": "The product name associated with this AAGUID."
}
},
"required": [
"PCID",
"authenticatorId",
"aaguid"
]
}
okta-admin_verify_event_hook
Verify an event hook Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
eventHookId | string | Yes | — | id of the Event Hook |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"eventHookId": {
"type": "string",
"description": "`id` of the Event Hook"
}
},
"required": [
"PCID",
"eventHookId"
]
}
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 |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"authenticatorId": {
"type": "string",
"description": "`id` of the authenticator"
},
"webAuthnMethodType": {
"type": "string",
"description": "Type of authenticator method",
"enum": [
"webauthn"
]
}
},
"required": [
"PCID",
"authenticatorId",
"webAuthnMethodType"
]
}