category: Authentication & Identity Management provider: Okta sectionorder: - Connect - Collect commonfields: id: Okta v2 version: -1 configuration: - display: Okta URL (https://.okta.com) name: url required: true type: 0 section: Connect - name: credentials type: 9 displaypassword: API Token hiddenusername: true section: Connect required: false display: '' - display: API Token name: apitoken type: 4 hidden: true section: Connect required: false - display: Use OAuth 2.0 Authentication name: use_oauth type: 8 section: Connect required: false additionalinfo: See detailed instructions on the 'Help' tab. - display: Client ID name: client_id type: 0 section: Connect required: false additionalinfo: Required and used if OAuth 2.0 is used for authentication. See detailed instructions on the 'Help' tab. - display: Private Key additionalinfo: In PEM format. Required and used if OAuth 2.0 is used for authentication. See detailed instructions on the 'Help' tab. name: private_key type: 14 section: Connect required: false - display: JWT Signing Algorithm additionalinfo: Algorithm to sign generated JWT tokens with. Doesn't affect integration's functionality. Required and used if OAuth 2.0 is used for authentication. See detailed instructions on the 'Help' tab. name: jwt_algorithm type: 15 section: Connect required: false options: - RS256 - RS384 - RS512 - ES256 - ES384 - ES512 defaultvalue: RS256 - display: Key ID name: key_id type: 0 section: Connect required: false additionalinfo: Required and used if more than one key is used for signing JWT tokens. - display: Trust any certificate (not secure) name: insecure type: 8 section: Connect advanced: true required: false - display: Use system proxy settings name: proxy type: 8 section: Connect advanced: true required: false description: Integration with Okta's cloud-based identity management service. display: Okta v2 name: Okta v2 script: commands: - arguments: - default: true description: Username to unlock. name: username required: true description: Unlocks a single user. execution: true name: okta-unlock-user outputs: - contextPath: Okta.Metadata.x-rate-limit-limit description: The rate limit ceiling that’s applicable for the current request. type: Number - contextPath: Okta.Metadata.x-rate-limit-remaining description: The amount of requests left for the current rate-limit window. type: Number - contextPath: Okta.Metadata.x-rate-limit-reset description: The time at which the rate limit resets, specified in UTC epoch time (in seconds). type: Number - arguments: - description: Username to deactivate. name: username required: true description: Deactivates a single user. name: okta-deactivate-user compliantpolicies: - User Hard Remediation outputs: - contextPath: Okta.Metadata.x-rate-limit-limit description: The rate limit ceiling that’s applicable for the current request. type: Number - contextPath: Okta.Metadata.x-rate-limit-remaining description: The amount of requests left for the current rate-limit window. type: Number - contextPath: Okta.Metadata.x-rate-limit-reset description: The time at which the rate limit resets, specified in UTC epoch time (in seconds). type: Number - arguments: - default: true description: Username to activate. name: username required: true description: Activates a single user. name: okta-activate-user compliantpolicies: - User Soft Remediation outputs: - contextPath: Okta.Metadata.x-rate-limit-limit description: The rate limit ceiling that’s applicable for the current request. type: Number - contextPath: Okta.Metadata.x-rate-limit-remaining description: The amount of requests left for the current rate-limit window. type: Number - contextPath: Okta.Metadata.x-rate-limit-reset description: The time at which the rate limit resets, specified in UTC epoch time (in seconds). type: Number - arguments: - default: true description: Username to suspend. name: username required: true description: Suspends a single user. This operation can only be performed on users with an ACTIVE status. After the porcess is completed, the user's status is SUSPENDED. name: okta-suspend-user compliantpolicies: - User Hard Remediation outputs: - contextPath: Okta.Metadata.x-rate-limit-limit description: The rate limit ceiling that’s applicable for the current request. type: Number - contextPath: Okta.Metadata.x-rate-limit-remaining description: The amount of requests left for the current rate-limit window. type: Number - contextPath: Okta.Metadata.x-rate-limit-reset description: The time at which the rate limit resets, specified in UTC epoch time (in seconds). type: Number - arguments: - default: true description: Username to change the status to ACTIVE. name: username required: true description: Returns a single user to ACTIVE status. This operation can only be performed on users that have a SUSPENDED status. name: okta-unsuspend-user outputs: - contextPath: Okta.Metadata.x-rate-limit-limit description: The rate limit ceiling that’s applicable for the current request. type: Number - contextPath: Okta.Metadata.x-rate-limit-remaining description: The amount of requests left for the current rate-limit window. type: Number - contextPath: Okta.Metadata.x-rate-limit-reset description: The time at which the rate limit resets, specified in UTC epoch time (in seconds). type: Number - arguments: - description: Username for which to return all enrolled factors. name: username - description: User ID of the user for which to get all enrolled factors. name: userId description: Returns all the enrolled factors for the specified user. name: okta-get-user-factors outputs: - contextPath: Account.ID description: Okta account ID. type: String - contextPath: Account.Factor.ID description: Okta account factor ID. type: String - contextPath: Account.Factor.Provider description: Okta account factor provider. type: String - contextPath: Account.Factor.Profile description: Okta account factor profile. type: String - contextPath: Account.Factor.FactorType description: Okta account factor type. type: String - contextPath: Account.Factor.Status description: Okta account factor status. type: Unknown - contextPath: Okta.Metadata.x-rate-limit-limit description: The rate limit ceiling that’s applicable for the current request. type: Number - contextPath: Okta.Metadata.x-rate-limit-remaining description: The amount of requests left for the current rate-limit window. type: Number - contextPath: Okta.Metadata.x-rate-limit-reset description: The time at which the rate limit resets, specified in UTC epoch time (in seconds). type: Number - arguments: - description: The user ID. name: userId - description: Username for which to un-enroll an existing factor. name: username - description: The ID of the factor to reset. name: factorId required: true description: Un-enrolls an existing factor for the specified user. This enables the user to enroll a new factor. name: okta-reset-factor outputs: - contextPath: Okta.Metadata.x-rate-limit-limit description: The rate limit ceiling that’s applicable for the current request. type: Number - contextPath: Okta.Metadata.x-rate-limit-remaining description: The amount of requests left for the current rate-limit window. type: Number - contextPath: Okta.Metadata.x-rate-limit-reset description: The time at which the rate limit resets, specified in UTC epoch time (in seconds). type: Number - arguments: - default: true description: Okta username for which to set the password. name: username required: true - description: The new password to set for the user. name: password required: true - auto: PREDEFINED defaultValue: 'false' description: When true, you'll need to change the password in the next login. name: temporary_password predefined: - 'true' - 'false' description: Sets passwords without validating existing user credentials. execution: true name: okta-set-password outputs: - contextPath: Okta.Metadata.x-rate-limit-limit description: The rate limit ceiling that’s applicable for the current request. type: Number - contextPath: Okta.Metadata.x-rate-limit-remaining description: The amount of requests left for the current rate-limit window. type: Number - contextPath: Okta.Metadata.x-rate-limit-reset description: The time at which the rate limit resets, specified in UTC epoch time (in seconds). type: Number - arguments: - description: ID of the user to add to the group. name: userId - description: Name of the user to add to the group. name: username - description: ID of the group to add the user to. name: groupId - description: Name of the group to add the user to. name: groupName description: Adds a user to a group with OKTA_GROUP type. name: okta-add-to-group outputs: - contextPath: Okta.Metadata.x-rate-limit-limit description: The rate limit ceiling that’s applicable for the current request. type: Number - contextPath: Okta.Metadata.x-rate-limit-remaining description: The amount of requests left for the current rate-limit window. type: Number - contextPath: Okta.Metadata.x-rate-limit-reset description: The time at which the rate limit resets, specified in UTC epoch time (in seconds). type: Number - arguments: - description: ID of the user to remove from the group. name: userId - description: Name of the user to remove from the group. name: username - description: ID of the group to remove the user from. name: groupId - description: Name of the group to remove the user from. name: groupName description: Removes a user from a group with OKTA_GROUP type. name: okta-remove-from-group outputs: - contextPath: Okta.Metadata.x-rate-limit-limit description: The rate limit ceiling that’s applicable for the current request. type: Number - contextPath: Okta.Metadata.x-rate-limit-remaining description: The amount of requests left for the current rate-limit window. type: Number - contextPath: Okta.Metadata.x-rate-limit-reset description: The time at which the rate limit resets, specified in UTC epoch time (in seconds). type: Number - arguments: - default: true description: Username in Okta for which to get the associated groups. name: username required: true description: Returns all user groups associated with a specified user. name: okta-get-groups outputs: - contextPath: Account.Group description: Okta groups with which the account is associated. type: Unknown - contextPath: Account.ID description: Okta account ID. type: String - contextPath: Account.Type description: Okta account type. type: String - contextPath: Account.Group.ID description: Unique key for the group. type: String - contextPath: Account.Group.Created description: Timestamp when the group was created. type: Date - contextPath: Account.Group.ObjectClass description: The object class, which determines the group's profile. type: String - contextPath: Account.Group.LastUpdated description: Timestamp when the group's profile was last updated. type: Date - contextPath: Account.Group.LastMembershipUpdated description: Timestamp when the group's memberships were last updated. type: Date - contextPath: Account.Group.Type description: Group type, which determines how a group's profile and memberships are managed. type: String - contextPath: Account.Group.Description description: Description of the group. type: String - contextPath: Account.Group.Name description: Name of the group. type: String - contextPath: Okta.Metadata.x-rate-limit-limit description: The rate limit ceiling that’s applicable for the current request. type: Number - contextPath: Okta.Metadata.x-rate-limit-remaining description: The amount of requests left for the current rate-limit window. type: Number - contextPath: Okta.Metadata.x-rate-limit-reset description: The time at which the rate limit resets, specified in UTC epoch time (in seconds). type: Number - arguments: - description: The ID of the user to enroll and verify. name: userId required: true - description: The push factor ID. name: factorId required: true - description: Time to wait between subsequent polling calls. Value is in seconds. name: polling_time defaultValue: 5 - description: Maximum number of polling calls. name: max_polling_calls defaultValue: 10 - auto: PREDEFINED description: Specifies whether the command should poll the status of the push factor. name: polling defaultValue: 'true' predefined: - 'true' - 'false' description: Enrolls and verifies a push factor for the specified user. name: okta-verify-push-factor outputs: - contextPath: Account.ID description: Okta user ID. type: String - contextPath: Account.VerifyPushResult description: Okta user push factor result. type: String - contextPath: Okta.Metadata.x-rate-limit-limit description: The rate limit ceiling that’s applicable for the current request. type: Number - contextPath: Okta.Metadata.x-rate-limit-remaining description: The amount of requests left for the current rate-limit window. type: Number - contextPath: Okta.Metadata.x-rate-limit-reset description: The time at which the rate limit resets, specified in UTC epoch time (in seconds). type: Number - contextPath: Okta.PollingStatusURL description: The polling URL for the push factor challenge. type: String compliantpolicies: - User Soft Remediation - arguments: - description: The url to poll. name: polling_url required: true description: Checks the status of the push factor mfa. name: okta-verify-mfa-status outputs: - contextPath: Okta.FactorResult.ID description: The push factor challenge ID. type: String - contextPath: Okta.FactorResult.factorResult description: The status of the push factor. type: String - contextPath: Okta.Metadata.x-rate-limit-limit description: The rate limit ceiling that’s applicable for the current request. type: Number - contextPath: Okta.Metadata.x-rate-limit-remaining description: The amount of requests left for the current rate-limit window. type: Number - contextPath: Okta.Metadata.x-rate-limit-reset description: The time at which the rate limit resets, specified in UTC epoch time (in seconds). type: Number - arguments: - default: true description: Term by which to search. Can be a first name, last name, or email address. The argument `term` or `advanced_search` is required. name: term - description: Searches for users with a supported filtering expression for most properties, including custom-defined properties. The argument `term` or `advanced_search` is required. name: advanced_search - description: The maximum number of results to return. The default and maximum is 200. name: limit - auto: PREDEFINED defaultValue: 'false' description: Whether to return details of users that match the found term. Can be "true" or "false". The default is "false". name: verbose predefined: - 'true' - 'false' description: Searches for Okta users. name: okta-search outputs: - contextPath: Account.ID description: Okta account IDs returned by the search. type: String - contextPath: Account.Username description: Okta account usernames returned by the search. type: String - contextPath: Account.Email description: Okta account emails returned by the search. type: String - contextPath: Account.DisplayName description: Okta account display names returned by the search. type: String - contextPath: Account.Type description: Okta account type returned by the search. type: String - contextPath: Account.Status description: Okta account current status. type: String - contextPath: Account.Created description: Timestamp for when the user was created. type: Date - contextPath: Account.Activated description: Timestamp for when the user was activated. type: Date - contextPath: Account.StatusChanged description: Timestamp for when the user's status was last changed. type: Date - contextPath: Account.PasswordChanged description: Timestamp for when the user's password was last changed. type: Date - contextPath: Okta.Metadata.x-rate-limit-limit description: The rate limit ceiling that’s applicable for the current request. type: Number - contextPath: Okta.Metadata.x-rate-limit-remaining description: The amount of requests left for the current rate-limit window. type: Number - contextPath: Okta.Metadata.x-rate-limit-reset description: The time at which the rate limit resets, specified in UTC epoch time (in seconds). type: Number - arguments: - description: Okta username for which to get information. name: username - description: User ID of the user for which to get information. name: userId - description: Email of the user for which to get information. name: userEmail - auto: PREDEFINED defaultValue: 'false' description: Whether to return extended user information. Can be "true" or "false". The default is "false". name: verbose predefined: - 'true' - 'false' description: Fetches information for a single user. You must enter one or more parameters for the command to run. name: okta-get-user outputs: - contextPath: Account.ID description: Okta account ID. type: String - contextPath: Account.Email description: Okta account email. type: String - contextPath: Account.Username description: Okta account username. type: String - contextPath: Account.DisplayName description: Okta account display name. type: String - contextPath: Account.Status description: Okta account status. type: String - contextPath: Account.Created description: Timestamp for when the user was created. type: Date - contextPath: Account.Activated description: Timestamp for when the user was activated. type: Date - contextPath: Account.StatusChanged description: Timestamp for when the user's status was last changed. type: Date - contextPath: Account.PasswordChanged description: Timestamp for when the user's password was last changed. type: Date - contextPath: Account.Manager description: The manager. type: String - contextPath: Account.ManagerEmail description: The manager email. type: String - contextPath: Okta.Metadata.x-rate-limit-limit description: The rate limit ceiling that’s applicable for the current request. type: Number - contextPath: Okta.Metadata.x-rate-limit-remaining description: The amount of requests left for the current rate-limit window. type: Number - contextPath: Okta.Metadata.x-rate-limit-reset description: The time at which the rate limit resets, specified in UTC epoch time (in seconds). type: Number - arguments: - description: "The cursor in which to retrive the results from and on. if the query didn't reach the end of results, the tag can be obtained from the bottom of the grid in the readable output, or in the context path Okta.User.tag." name: after - description: The maximum number of results to return. name: limit default: true defaultValue: '200' - auto: PREDEFINED defaultValue: 'false' description: Whether to return extended user information. name: verbose predefined: - 'true' - 'false' - description: Searches the name property of groups for matching values. name: query - description: "Useful for performing structured queries where constraints on group attribute values can be explicitly targeted. \nThe following expressions are supported(among others) for groups with the filter query parameter: \n type eq \"OKTA_GROUP\" - Groups that have a type of OKTA_GROUP; lastUpdated lt \"yyyy-MM-dd''T''HH:mm:ss.SSSZ\" - Groups with profile last updated before a specific timestamp; lastMembershipUpdated eq \"yyyy-MM-dd''T''HH:mm:ss.SSSZ\" - Groups with memberships last updated at a specific timestamp; id eq \"00g1emaKYZTWRYYRRTSK\" - Group with a specified ID. For more information about filtering, visit https://developer.okta.com/docs/api/getting_started/design_principles#filtering" name: filter description: Lists users in your organization. name: okta-list-users outputs: - contextPath: Account.ID description: Okta account ID. type: String - contextPath: Account.Email description: Okta account email. type: String - contextPath: Account.Username description: Okta account username. type: String - contextPath: Account.DisplayName description: Okta account display name. type: String - contextPath: Account.Status description: Okta account status. type: String - contextPath: Account.Created description: Timestamp for when the user was created. type: Date - contextPath: Account.Activated description: Timestamp for when the user was activated. type: Date - contextPath: Account.StatusChanged description: Timestamp for when the user's status was last changed. type: Date - contextPath: Account.PasswordChanged description: Timestamp for when the user's password was last changed. type: Date - contextPath: Okta.User.tag description: The location of the next item, used with after param. type: String - contextPath: Okta.Metadata.x-rate-limit-limit description: The rate limit ceiling that’s applicable for the current request. type: Number - contextPath: Okta.Metadata.x-rate-limit-remaining description: The amount of requests left for the current rate-limit window. type: Number - contextPath: Okta.Metadata.x-rate-limit-reset description: The time at which the rate limit resets, specified in UTC epoch time (in seconds). type: Number - arguments: - description: First name of the user (givenName). name: firstName required: true - description: Family name of the user (familyName). name: lastName required: true - description: Primary email address of the user. name: email required: true - description: Unique identifier for the user (username). name: login required: true - description: Secondary email address of user. Usually used for account recovery. name: secondEmail - description: Middle name(s) of the user. name: middleName - description: A comma-separated list of honorific prefix(es) of the user, or title in most Western languages. name: honorificPrefix - description: A comma-separated list of honorific suffix(es) of the user. name: honorificSuffix - description: User's title. for example, Vice President. name: title - description: Display name of the user. name: displayName - description: Casual way to address the user (nick name). name: nickName - description: URL of the user online profile. For example, a web page. name: profileUrl - description: Primary phone number of the user. name: primaryPhone - description: Mobile phone number of the user. name: mobilePhone - description: Full street address component of the user's address. name: streetAddress - description: City or locality component of the user's address (locality). name: city - description: State or region component of the user's address (region). name: state - description: Zip code or postal code component of the user's address (postalCode). name: zipCode - description: Country name component of the user's address (country). name: countryCode - description: Mailing address component of the user's address. name: postalAddress - description: User's preferred written or spoken languages. name: preferredLanguage - description: User's default location, for purposes of localizing items such as currency, date-time format, numerical representations, etc. name: locale - description: User's time zone. name: timezone - description: The user type, which is used to identify the organization-to-user relationship such as "Employee" or "Contractor". name: userType - description: Organization or company assigned unique identifier for the user. name: employeeNumber - description: Name of a cost center the user is assigned to. name: costCenter - description: Name of the user's organization. name: organization - description: Name of the user's division. name: division - description: Name of the user's department. name: department - description: ID of the user's manager. name: managerId - description: Display name of the user's manager. name: manager - description: Password for the new user. name: password - description: Password question for the new user. name: passwordQuestion - description: Password answer for question. name: passwordAnswer - auto: PREDEFINED description: The provider type. Can be "OKTA", "ACTIVE_DIRECTORY", "LDAP", "FEDERATION", or "SOCIAL". name: providerType predefined: - OKTA - ACTIVE_DIRECTORY - LDAP - FEDERATION - SOCIAL - description: Name of the provider. name: providerName - description: IDs of groups that the user will be immediately added to at time of creation (does Not include default group). name: groupIds - auto: PREDEFINED description: Whether to activate the lifecycle operation when creating the user. Can be "true" or "false". name: activate predefined: - 'true' - 'false' description: Creates a new user with an option of setting a password, recovery question, and answer. The new user will immediately be able to log in after activation with the assigned password. This flow is common when developing a custom user registration experience. execution: true name: okta-create-user outputs: - contextPath: Account.ID description: Created Okta account ID. type: String - contextPath: Account.Email description: Created Okta account email address. type: String - contextPath: Account.Username description: Created okta account username. type: String - contextPath: Account.DisplayName description: Created Okta account display name. type: String - contextPath: Account.Type description: Type of created account - Okta. type: String - contextPath: Account.Status description: Okta account current status. type: String - contextPath: Account.Created description: Timestamp for when the user was created. type: Date - contextPath: Account.Activated description: Timestamp for when the user was activated. type: Date - contextPath: Account.StatusChanged description: Timestamp for when the user's status was last changed. type: Date - contextPath: Account.PasswordChanged description: Timestamp for when the user's password was last changed. type: Date - contextPath: Okta.Metadata.x-rate-limit-limit description: The rate limit ceiling that’s applicable for the current request. type: Number - contextPath: Okta.Metadata.x-rate-limit-remaining description: The amount of requests left for the current rate-limit window. type: Number - contextPath: Okta.Metadata.x-rate-limit-reset description: The time at which the rate limit resets, specified in UTC epoch time (in seconds). type: Number - arguments: - description: First name of the user (given name). name: firstName - description: Family name of the user. name: lastName - description: Primary email address of the user. name: email - description: Unique identifier for the user (login). name: username required: true - description: Secondary email address of the user (typically used for account recovery. name: secondEmail - description: Middle name(s) of the user. name: middleName - description: Honorific prefix(es) of the user, or title in most Western languages. name: honorificPrefix - description: Honorific suffix(es) of the user. name: honorificSuffix - description: User's title. For example, Vice President. name: title - description: Display name of the user. name: displayName - description: Casual way to address the user in real life (nick name). name: nickName - description: URL of the user's online profile. For example, a web page. name: profileUrl - description: Primary phone number of the user. name: primaryPhone - description: Mobile phone number of the user. name: mobilePhone - description: Full street address component of the user's address. name: streetAddress - description: City or locality component of the user's address (locality). name: city - description: State or region component of the user's address (region). name: state - description: Zip code or postal code component of the user's address (postalCode). name: zipCode - description: Country name component of the user's address (country). name: countryCode - description: Mailing address component of the user's address. name: postalAddress - description: User's preferred written or spoken languages. name: preferredLanguage - description: User's default location for purposes of localizing items such as currency, date-time format, numerical representations, etc. name: locale - description: User time zone. name: timezone - description: The user type, which is used to identify the organization-to-user relationship such as "Employee" or "Contractor". name: userType - description: Organization or company assigned unique identifier for the user. name: employeeNumber - description: Name of a cost center the user is assigned to. name: costCenter - description: Name of the user's organization. name: organization - description: Name of the user's division. name: division - description: Name of the user's department. name: department - description: ID of the user's manager. name: managerId - description: Display name of the user's manager. name: manager - description: New password for the specified user. name: password - description: Password question for the specified user. name: passwordQuestion - description: Password answer for the question. name: passwordAnswer - auto: PREDEFINED description: The provider type. Can be "OKTA", "ACTIVE_DIRECTORY", "LDAP", "FEDERATION", or "SOCIAL". name: providerType predefined: - OKTA - ACTIVE_DIRECTORY - FEDERATION - SOCIAL - description: Name of the provider. name: providerName description: Updates a user with a given login. All fields are optional. Fields which are not set, will not be overwritten. execution: true name: okta-update-user outputs: - contextPath: Okta.Metadata.x-rate-limit-limit description: The rate limit ceiling that’s applicable for the current request. type: Number - contextPath: Okta.Metadata.x-rate-limit-remaining description: The amount of requests left for the current rate-limit window. type: Number - contextPath: Okta.Metadata.x-rate-limit-reset description: The time at which the rate limit resets, specified in UTC epoch time (in seconds). type: Number - arguments: - description: ID of the group. name: groupId - description: The maximum number of results to return. name: limit - auto: PREDEFINED defaultValue: 'false' description: Whether to print extended user details. Can be "true" or "false". The default is "false". name: verbose predefined: - 'true' - 'false' - description: Name of the group. name: groupName description: Enumerates all users that are members of a group. name: okta-get-group-members outputs: - contextPath: Account.ID description: Okta account ID. type: String - contextPath: Account.Email description: Okta account email address. type: String - contextPath: Account.Username description: Okta account username. type: String - contextPath: Account.DisplayName description: Okta account display name. type: String - contextPath: Account.Type description: Account type - Okta. type: String - contextPath: Account.Status description: Okta account current status. type: String - contextPath: Account.Created description: Timestamp for when the user was created. type: Date - contextPath: Account.Activated description: Timestamp for when the user was activated. type: Date - contextPath: Account.StatusChanged description: Timestamp for when the user's status was last changed. type: Date - contextPath: Account.PasswordChanged description: Timestamp for when the user's password was last changed. type: Date - contextPath: Okta.Metadata.x-rate-limit-limit description: The rate limit ceiling that’s applicable for the current request. type: Number - contextPath: Okta.Metadata.x-rate-limit-remaining description: The amount of requests left for the current rate-limit window. type: Number - contextPath: Okta.Metadata.x-rate-limit-reset description: The time at which the rate limit resets, specified in UTC epoch time (in seconds). type: Number - arguments: - description: Searches the name property of groups for matching values. name: query - description: "Useful for performing structured queries where constraints on group attribute values can be explicitly targeted. \nThe following expressions are supported(among others) for groups with the filter query parameter: \n type eq \"OKTA_GROUP\" - Groups that have a type of OKTA_GROUP; lastUpdated lt \"yyyy-MM-dd''T''HH:mm:ss.SSSZ\" - Groups with profile last updated before a specific timestamp; lastMembershipUpdated eq \"yyyy-MM-dd''T''HH:mm:ss.SSSZ\" - Groups with memberships last updated at a specific timestamp; id eq \"00g1emaKYZTWRYYRRTSK\" - Group with a specified ID. For more information about filtering, visit https://developer.okta.com/docs/api/getting_started/design_principles#filtering" name: filter - defaultValue: '200' description: The maximum number of results to return. The default is 200. name: limit description: Lists groups in your organization. A subset of groups can be returned that match a supported filter expression or query. name: okta-list-groups outputs: - contextPath: Okta.Group.ID description: Unique key for the group. type: String - contextPath: Okta.Group.Created description: Timestamp for when the group was created. type: Date - contextPath: Okta.Group.ObjectClass description: The group's profile. type: Unknown - contextPath: Okta.Group.LastUpdated description: Timestamp for when the group's profile was last updated. type: Date - contextPath: Okta.Group.LastMembershipUpdated description: Timestamp for when the group's membership was last updated. type: Date - contextPath: Okta.Group.Type description: The group type, which determines how a group's profile and membership are managed. Can be "OKTA_GROUP", "APP_GROUP", or "BUILT_IN". type: String - contextPath: Okta.Group.Name description: Name of the group. type: String - contextPath: Okta.Group.Description description: Description of the group. type: String - contextPath: Okta.Metadata.x-rate-limit-limit description: The rate limit ceiling that’s applicable for the current request. type: Number - contextPath: Okta.Metadata.x-rate-limit-remaining description: The amount of requests left for the current rate-limit window. type: Number - contextPath: Okta.Metadata.x-rate-limit-reset description: The time at which the rate limit resets, specified in UTC epoch time (in seconds). type: Number - arguments: - description: 'Filters the lower time bound of the log events in the Internet Date/Time Format profile of ISO 8601. An example: 2017-05-03T16:22:18Z.' name: since - description: 'Filters the upper time bound of the log events in the Internet Date/Time Format profile of ISO 8601. An example: 2017-05-03T16:22:18Z.' name: until - auto: PREDEFINED defaultValue: ASCENDING description: The order of the returned events. Can be "ASCENDING" or "DESCENDING". The default is "ASCENDING". name: sortOrder predefined: - ASCENDING - DESCENDING - description: The maximum number of results to return. The default is 100. name: limit description: Returns failed login events. name: okta-get-failed-logins outputs: - contextPath: Okta.Logs.Events.actor.alternateId description: Alternative ID of the actor. type: String - contextPath: Okta.Logs.Events.actor.displayName description: Display name of the actor. type: String - contextPath: Okta.Logs.Events.actor.id description: ID of the actor. type: String - contextPath: Okta.Logs.Events.client.userAgent.rawUserAgent description: A raw string representation of the user agent, formatted according to section 5.5.3 of HTTP/1.1 Semantics and Content. Both the browser and the OS fields can be derived from this field. type: String - contextPath: Okta.Logs.Events.client.userAgent.os description: The operating system on which the client runs. For example, Microsoft Windows 10. type: String - contextPath: Okta.Logs.Events.client.userAgent.browser description: Identifies the browser type, if relevant. For example, Chrome. type: String - contextPath: Okta.Logs.Events.client.device description: Type of device that client operated from. For example, Computer. type: String - contextPath: Okta.Logs.Events.client.id description: For OAuth requests, the ID of the OAuth client making the request. For SSWS token requests, the ID of the agent making the request. type: String - contextPath: Okta.Logs.Events.client.ipAddress description: IP address from which the client made its request. type: String - contextPath: Okta.Logs.Events.client.geographicalContext.city description: The city encompassing the area containing the geo-location coordinates, if available. For example, Seattle, San Francisco. type: String - contextPath: Okta.Logs.Events.client.geographicalContext.state description: Full name of the state or province encompassing the area containing the geo-location coordinates. For example Montana, Incheon. type: String - contextPath: Okta.Logs.Events.client.geographicalContext.country description: Full name of the country encompassing the area containing the geo-location coordinates. For example, France, Uganda. type: String - contextPath: Okta.Logs.Events.displayMessage description: The display message for an event. type: String - contextPath: Okta.Logs.Events.eventType description: Type of event that was published. type: String - contextPath: Okta.Logs.Events.outcome.result description: Result of the action. Can be "SUCCESS", "FAILURE", "SKIPPED", "UNKNOWN". type: String - contextPath: Okta.Logs.Events.outcome.reason description: Reason for the result. For example, INVALID_CREDENTIALS. type: String - contextPath: Okta.Logs.Events.published description: Timestamp when the event was published. type: String - contextPath: Okta.Logs.Events.severity description: The event severity. Can be "DEBUG", "INFO", "WARN", or "ERROR". type: String - contextPath: Okta.Logs.Events.securityContext.asNumber description: Autonomous system number associated with the autonomous system that the event request was sourced to. type: Number - contextPath: Okta.Logs.Events.securityContext.asOrg description: Organization associated with the autonomous system that the event request was sourced to. type: String - contextPath: Okta.Logs.Events.securityContext.isp description: Internet service provider used to send the event's request. type: String - contextPath: Okta.Logs.Events.securityContext.domain description: The domain name associated with the IP address of the inbound event request. type: String - contextPath: Okta.Logs.Events.securityContext.isProxy description: Specifies whether an event's request is from a known proxy. type: String - contextPath: Okta.Logs.Events.request.ipChain.IP description: IP address. type: String - contextPath: Okta.Logs.Events.request.ipChain.geographicalContext.city description: The city encompassing the area containing the geo-location coordinates, if available. For example, Seattle, San Francisco. type: String - contextPath: Okta.Logs.Events.request.ipChain.geographicalContext.state description: Full name of the state or province encompassing the area containing the geo-location coordinates. For example, Montana, Incheon. type: String - contextPath: Okta.Logs.Events.request.ipChain.geographicalContext.country description: Full name of the country encompassing the area containing the geo-location coordinates. For example, France, Uganda. type: String - contextPath: Okta.Logs.Events.request.ipChain.source description: Details regarding the source. type: String - contextPath: Okta.Logs.Events.target.id description: ID of a target. type: String - contextPath: Okta.Logs.Events.target.type description: Type of a target. type: String - contextPath: Okta.Logs.Events.target.alternateId description: Alternative ID of a target. type: String - contextPath: Okta.Logs.Events.target.displayName description: Display name of a target. type: String - contextPath: Okta.Metadata.x-rate-limit-limit description: The rate limit ceiling that’s applicable for the current request. type: Number - contextPath: Okta.Metadata.x-rate-limit-remaining description: The amount of requests left for the current rate-limit window. type: Number - contextPath: Okta.Metadata.x-rate-limit-reset description: The time at which the rate limit resets, specified in UTC epoch time (in seconds). type: Number - arguments: - description: "Useful for performing structured queries where constraints on LogEvent attribute values can be explicitly targeted. \nThe following expressions are supported for events with the filter query parameter: eventType eq \" :eventType\" \n-Events that have a specific action; eventType target.id eq \":id\" \n- Events published with a specific target id; actor.id eq \":id\"\n- Events published with a specific actor ID. For more information about filtering, visit https://developer.okta.com/docs/api/getting_started/design_principles#filtering" name: filter - description: "The query parameter can be used to perform keyword matching against a LogEvents object’s attribute values. To satisfy the constraint, all supplied keywords must be matched exactly. Note that matching is case-insensitive. The following are some examples of common keyword filtering: \nEvents that mention a specific city: query=San Francisco; \nEvents that mention a specific url: query=interestingURI.com; \nEvents that mention a specific person: query=firstName lastName." name: query - description: 'Filters the lower time bound of the log events in the Internet Date/Time Format profile of ISO 8601. For example: 2017-05-03T16:22:18Z.' name: since - description: 'Filters the upper time bound of the log events in the Internet Date/Time Format profile of ISO 8601. For example: 2017-05-03T16:22:18Z.' name: until - auto: PREDEFINED defaultValue: ASCENDING description: The order of the returned events. Can be "ASCENDING" or "DESCENDING". The default is "ASCENDING". name: sortOrder predefined: - ASCENDING - DESCENDING - defaultValue: '100' description: The maximum number of results to return. The default is 100. name: limit description: Gets logs by providing optional filters. name: okta-get-logs outputs: - contextPath: Okta.Logs.Events.actor.alternateId description: Alternative ID of the actor. type: String - contextPath: Okta.Logs.Events.actor.displayName description: Display name of the actor. type: String - contextPath: Okta.Logs.Events.actor.id description: ID of the actor. type: String - contextPath: Okta.Logs.Events.client.userAgent.rawUserAgent description: A raw string representation of user agent, formatted according to section 5.5.3 of HTTP/1.1 Semantics and Content. Both the browser and the OS fields can be derived from this field. type: String - contextPath: Okta.Logs.Events.client.userAgent.os description: The operating system on which the client runs. For example, Microsoft Windows 10. type: String - contextPath: Okta.Logs.Events.client.userAgent.browser description: Identifies the type of web browser, if relevant. For example, Chrome. type: String - contextPath: Okta.Logs.Events.client.device description: Type of device from which the client operated. For example, Computer. type: String - contextPath: Okta.Logs.Events.client.id description: For OAuth requests, the ID of the OAuth client making the request. For SSWS token requests, the ID of the agent making the request. type: String - contextPath: Okta.Logs.Events.client.ipAddress description: IP address from which the client made its request. type: String - contextPath: Okta.Logs.Events.client.geographicalContext.city description: The city encompassing the area containing the geo-location coordinates, if available. For example, Seattle, San Francisco. type: String - contextPath: Okta.Logs.Events.client.geographicalContext.state description: Full name of the state or province encompassing the area containing the geo-location coordinates. For example, Montana, Incheon. type: String - contextPath: Okta.Logs.Events.client.geographicalContext.country description: Full name of the country encompassing the area containing the geo-location coordinates. For example, France, Uganda. type: String - contextPath: Okta.Logs.Events.displayMessage description: The display message for an event. type: String - contextPath: Okta.Logs.Events.eventType description: Type of event that was published. type: String - contextPath: Okta.Logs.Events.outcome.result description: Result of the action. Can be "SUCCESS", "FAILURE", "SKIPPED", or "UNKNOWN". type: String - contextPath: Okta.Logs.Events.outcome.reason description: Reason for the result. For example, INVALID_CREDENTIALS. type: String - contextPath: Okta.Logs.Events.published description: Timestamp when the event was published. type: String - contextPath: Okta.Logs.Events.severity description: The event severity. Can be "DEBUG", "INFO", "WARN", or "ERROR". type: String - contextPath: Okta.Logs.Events.securityContext.asNumber description: Autonomous system number associated with the autonomous system that the event request was sourced to. type: Number - contextPath: Okta.Logs.Events.securityContext.asOrg description: Organization associated with the autonomous system that the event request was sourced to. type: String - contextPath: Okta.Logs.Events.securityContext.isp description: Internet service provider used to send the event's request. type: String - contextPath: Okta.Logs.Events.securityContext.domain description: The domain name associated with the IP address of the inbound event request. type: String - contextPath: Okta.Logs.Events.securityContext.isProxy description: Specifies whether an event's request is from a known proxy. type: String - contextPath: Okta.Logs.Events.request.ipChain.IP description: IP address. type: String - contextPath: Okta.Logs.Events.request.ipChain.geographicalContext.city description: The city encompassing the area containing the geo-location coordinates, if available. For example, Seattle, San Francisco. type: String - contextPath: Okta.Logs.Events.request.ipChain.geographicalContext.state description: Full name of the state or province encompassing the area containing the geo-location coordinates. For example, Montana, Incheon. type: String - contextPath: Okta.Logs.Events.request.ipChain.geographicalContext.country description: Full name of the country encompassing the area containing the geo-location coordinates. For example, France, Uganda. type: String - contextPath: Okta.Logs.Events.request.ipChain.source description: Details regarding the source. type: String - contextPath: Okta.Logs.Events.target.id description: ID of a target. type: String - contextPath: Okta.Logs.Events.target.type description: Type of a target. type: String - contextPath: Okta.Logs.Events.target.alternateId description: Alternative ID of a target. type: String - contextPath: Okta.Logs.Events.target.displayName description: Display name of a target. type: String - contextPath: Okta.Metadata.x-rate-limit-limit description: The rate limit ceiling that’s applicable for the current request. type: Number - contextPath: Okta.Metadata.x-rate-limit-remaining description: The amount of requests left for the current rate-limit window. type: Number - contextPath: Okta.Metadata.x-rate-limit-reset description: The time at which the rate limit resets, specified in UTC epoch time (in seconds). type: Number - arguments: - description: Filters the lower time bound of the log event in the Internet Date\Time format profile of ISO 8601. For example, 2020-02-14T16:00:18Z. name: since - description: Filters the upper time bound of the log event in the Internet Date\Time format profile of ISO 8601. For example, 2020-02-14T16:00:18Z. name: until - auto: PREDEFINED defaultValue: ASCENDING description: The order of the returned events. Can be "ASCENDING" or "DESCENDING". The default is "ASCENDING". name: sortOrder predefined: - ASCENDING - DESCENDING - defaultValue: '100' description: The maximum number of results to return. The default is 100. name: limit description: Gets events for when a user was added to a group. name: okta-get-group-assignments outputs: - contextPath: Okta.Logs.Events.actor.alternateId description: Alternative ID of the actor. type: String - contextPath: Okta.Logs.Events.actor.displayName description: Display name of the actor. type: String - contextPath: Okta.Logs.Event.actor.id description: ID of the actor. type: String - contextPath: Okta.Logs.Events.client.userAgent.rawUserAgent description: A raw string representation of user agent, formatted according to section 5.5.3 of HTTP/1.1 Semantics and Content. Both the browser and the OS fields can be derived from this field. type: String - contextPath: Okta.Logs.Events.client.userAgent.os description: The operating system on which the client runs. For example, Microsoft Windows 10. type: String - contextPath: Okta.Logs.Events.client.userAgent.browser description: Identifies the type of web browser, if relevant. For example, Chrome. type: String - contextPath: Okta.Logs.Events.client.device description: Type of device from which the client operated. For example, Computer. type: String - contextPath: Okta.Logs.Events.client.id description: For OAuth requests, the ID of the OAuth client making the request. For SSWS token requests, the ID of the agent making the request. type: String - contextPath: Okta.Logs.Events.client.ipAddress description: IP address from which the client made its request. type: String - contextPath: Okta.Logs.Events.client.geographicalContext.city description: The city encompassing the area containing the geo-location coordinates, if available. For example, Seattle, San Francisco. type: String - contextPath: Okta.Logs.Events.client.geographicalContext.state description: Full name of the state or province encompassing in the area containing the geo-location coordinates. For example, Montana, Incheon. type: String - contextPath: Okta.Logs.Events.client.geographicalContext.country description: Full name of the country encompassing the area containing the geo-location coordinates. For example, France, Uganda. type: String - contextPath: Okta.Logs.Events.displayMessage description: The display message for an event. type: String - contextPath: Okta.Logs.Events.eventType description: Type of event that was published. type: String - contextPath: Okta.Logs.Events.outcome.result description: Result of the action. Can be "SUCCESS", "FAILURE", "SKIPPED", or "UNKNOWN". type: String - contextPath: Okta.Logs.Events.outcome.reason description: Reason for the result. For example INVALID_CREDENTIALS. type: Unknown - contextPath: Okta.Logs.Events.published description: Timestamp when the event was published. type: String - contextPath: Okta.Logs.Events.severity description: The event severity. Can be "DEBUG", "INFO", "WARN", or "ERROR". type: String - contextPath: Okta.Logs.Events.securityContext.asNumber description: Autonomous system number associated with the autonomous system that the event request was sourced to. type: Number - contextPath: Okta.Logs.Events.securityContext.asOrg description: Organization associated with the autonomous system that the event request was sourced to. type: String - contextPath: Okta.Logs.Events.securityContext.isp description: Internet service provider used to send the event's request. type: String - contextPath: Okta.Logs.Events.securityContext.domain description: The domain name associated with the IP address of the inbound event request. type: String - contextPath: Okta.Logs.Events.securityContext.isProxy description: Specifies whether an event's request is from a known proxy. type: String - contextPath: Okta.Logs.Events.request.ipChain.IP description: IP address. type: String - contextPath: Okta.Logs.Events.request.ipChain.geographicalContext.city description: The city encompassing the area containing the geo-location coordinates, if available. For example, Seattle, San Francisco. type: String - contextPath: Okta.Logs.Events.request.ipChain.geographicalContext.state description: Full name of the state or province encompassing the area containing the geo-location coordinates. For example, Montana, Incheon. type: String - contextPath: Okta.Logs.Events.request.ipChain.geographicalContext.country description: Full name of the country encompassing the area containing the geo-location coordinates. For example, France, Uganda. type: String - contextPath: Okta.Logs.Events.request.ipChain.source description: Details regarding the source. type: String - contextPath: Okta.Logs.Events.target.id description: ID of a target. type: String - contextPath: Okta.Logs.Events.target.type description: Target type. type: String - contextPath: Okta.Logs.Events.target.alternateId description: Alternative ID of a target. type: String - contextPath: Okta.Logs.Events.target.displayName description: Display name of a target. type: String - contextPath: Okta.Metadata.x-rate-limit-limit description: The rate limit ceiling that’s applicable for the current request. type: Number - contextPath: Okta.Metadata.x-rate-limit-remaining description: The amount of requests left for the current rate-limit window. type: Number - contextPath: Okta.Metadata.x-rate-limit-reset description: The time at which the rate limit resets, specified in UTC epoch time (in seconds). type: Number - arguments: - description: Filters the lower time bound of the log event in the Internet Date\Time format profile of ISO 8601. For example, 2020-02-14T16:00:18Z. name: since - description: Filters the upper time bound of the log event in the Internet Date\Time format profile of ISO 8601. For example, 2020-02-14T16:00:18Z. name: until - auto: PREDEFINED defaultValue: ASCENDING description: The order of the returned events. Can be "ASCENDING" or "DESCENDING". The default is "ASCENDING". name: sortOrder predefined: - ASCENDING - DESCENDING - defaultValue: '100' description: The maximum number of results to return. The default is 100. name: limit description: Returns events for when a user was assigned to an application. name: okta-get-application-assignments outputs: - contextPath: Okta.Logs.Events.actor.alternateId description: Alternative ID of the actor. type: String - contextPath: Okta.Logs.Events.actor.displayName description: Display name of the actor. type: String - contextPath: Okta.Logs.Event.actor.id description: ID of the actor. type: String - contextPath: Okta.Logs.Events.client.userAgent.rawUserAgent description: A raw string representation of the user agent, formatted according to section 5.5.3 of HTTP/1.1 Semantics and Content. Both the browser and the OS fields can be derived from this field. type: String - contextPath: Okta.Logs.Events.client.userAgent.os description: The OS on which the client runs. For example, Microsoft Windows 10. type: String - contextPath: Okta.Logs.Events.client.userAgent.browser description: Identifies the type of web browser, if relevant. For example, Chrome. type: String - contextPath: Okta.Logs.Events.client.device description: Type of device from which the client operated. For example, Computer. type: String - contextPath: Okta.Logs.Events.client.id description: For OAuth requests, the ID of the OAuth client making the request. For SSWS token requests, the ID of the agent making the request. type: String - contextPath: Okta.Logs.Events.client.ipAddress description: IP address from which the client made its request. type: String - contextPath: Okta.Logs.Events.client.geographicalContext.city description: The city encompassing the area containing the geo-location coordinates, if available. For example, Seattle, San Francisco. type: String - contextPath: Okta.Logs.Events.client.geographicalContext.state description: Full name of the state or province encompassing the area containing the geo-location coordinates. For example, Montana, Incheon. type: String - contextPath: Okta.Logs.Events.client.geographicalContext.country description: Full name of the country encompassing the area containing the geo-location coordinates. For example, France, Uganda. type: String - contextPath: Okta.Logs.Events.displayMessage description: The display message for an event. type: String - contextPath: Okta.Logs.Events.eventType description: Type of event that was published. type: String - contextPath: Okta.Logs.Events.outcome.result description: Result of the action. For example, "SUCCESS", "FAILURE", "SKIPPED", or "UNKNOWN". type: String - contextPath: Okta.Logs.Events.outcome.reason description: Reason for the result. For example INVALID_CREDENTIALS. type: String - contextPath: Okta.Logs.Events.published description: Timestamp when the event was published. type: String - contextPath: Okta.Logs.Events.severity description: The event severity. Can be "DEBUG", "INFO", "WARN", or "ERROR". type: String - contextPath: Okta.Logs.Events.securityContext.asNumber description: Autonomous system number associated with the autonomous system that the event request was sourced to. type: Number - contextPath: Okta.Logs.Events.securityContext.asOrg description: Organization associated with the autonomous system that the event request was sourced to. type: String - contextPath: Okta.Logs.Events.securityContext.isp description: Internet service provider used to send the event's request. type: String - contextPath: Okta.Logs.Events.securityContext.domain description: The domain name associated with the IP address of the inbound event request. type: String - contextPath: Okta.Logs.Events.securityContext.isProxy description: Specifies whether an event's request is from a known proxy. type: String - contextPath: Okta.Logs.Events.request.ipChain.IP description: IP address. type: String - contextPath: Okta.Logs.Events.request.ipChain.geographicalContext.city description: The city encompassing the area containing the geo-location coordinates, if available. For example, Seattle, San Francisco. type: String - contextPath: Okta.Logs.Events.request.ipChain.geographicalContext.state description: Full name of the state or province encompassing the area containing the geo-location coordinates. For example, Montana, Incheon. type: String - contextPath: Okta.Logs.Events.request.ipChain.geographicalContext.country description: Full name of the country encompassing the area containing the geo-location coordinates. For example, France, Uganda. type: String - contextPath: Okta.Logs.Events.request.ipChain.source description: Details regarding the source. type: String - contextPath: Okta.Logs.Events.target.id description: ID of a target. type: String - contextPath: Okta.Logs.Events.target.type description: Type of a target. type: String - contextPath: Okta.Logs.Events.target.alternateId description: Alternative ID of a target. type: String - contextPath: Okta.Logs.Events.target.displayName description: Display name of a target. type: String - contextPath: Okta.Metadata.x-rate-limit-limit description: The rate limit ceiling that’s applicable for the current request. type: Number - contextPath: Okta.Metadata.x-rate-limit-remaining description: The amount of requests left for the current rate-limit window. type: Number - contextPath: Okta.Metadata.x-rate-limit-reset description: The time at which the rate limit resets, specified in UTC epoch time (in seconds). type: Number - arguments: - description: Filters the lower time bound of the log event in the Internet Date\Time format profile of ISO 8601. For example, 2020-02-14T16:00:18Z. name: since - description: Filters the upper time bound of the log event in the Internet Date\Time format profile of ISO 8601. For example, 2020-02-14T16:00:18Z. name: until - auto: PREDEFINED defaultValue: ASCENDING description: The order of the returned events. Can be "ASCENDING" or "DESCENDING". The default is "ASCENDING". name: sortOrder predefined: - ASCENDING - DESCENDING - defaultValue: '100' description: The maximum number of results to return. The default is 100. name: limit description: Returns logs using specified filters. name: okta-get-application-authentication outputs: - contextPath: Okta.Logs.Events.actor.alternateId description: Alternative ID of the actor. type: String - contextPath: Okta.Logs.Events.actor.displayName description: Display name of the actor. type: String - contextPath: Okta.Logs.Events.actor.id description: ID of the actor. type: String - contextPath: Okta.Logs.Events.client.userAgent.rawUserAgent description: A raw string representation of user agent, formatted according to section 5.5.3 of HTTP/1.1 Semantics and Content. Both the browser and the OS fields can be derived from this field. type: String - contextPath: Okta.Logs.Events.client.userAgent.os description: The operating system on which the client runs. For example, Microsoft Windows 10. type: String - contextPath: Okta.Logs.Events.client.userAgent.browser description: Identifies the type of web browser, if relevant. For example, Chrome. type: String - contextPath: Okta.Logs.Events.client.device description: Type of device from which the client operated. For example, Computer. type: String - contextPath: Okta.Logs.Events.client.id description: For OAuth requests, the ID of the OAuth client making the request. For SSWS token requests, the ID of the agent making the request. type: String - contextPath: Okta.Logs.Events.client.ipAddress description: IP address from which the client made its request. type: String - contextPath: Okta.Logs.Events.client.geographicalContext.city description: The city encompassing the area containing the geo-location coordinates, if available. For example, Seattle, San Francisco. type: String - contextPath: Okta.Logs.Events.client.geographicalContext.state description: Full name of the state or province encompassing the area containing the geo-location coordinates. For example, Montana, Incheon. type: String - contextPath: Okta.Logs.Events.client.geographicalContext.country description: Full name of the country encompassing the area containing the geo-location coordinates. For example, France, Uganda. type: String - contextPath: Okta.Logs.Events.displayMessage description: The display message for an event. type: String - contextPath: Okta.Logs.Events.eventType description: Type of event that was published. type: String - contextPath: Okta.Logs.Events.outcome.result description: Result of the action. Can be "SUCCESS", "FAILURE", "SKIPPED", or "UNKNOWN". type: String - contextPath: Okta.Logs.Events.outcome.reason description: Reason for the result. For example INVALID_CREDENTIALS. type: String - contextPath: Okta.Logs.Events.published description: Timestamp when the event was published. type: String - contextPath: Okta.Logs.Events.severity description: The event severity. Can be "DEBUG", "INFO", "WARN", or "ERROR". type: String - contextPath: Okta.Logs.Events.securityContext.asNumber description: Autonomous system number associated with the autonomous system that the event request was sourced to. type: Number - contextPath: Okta.Logs.Events.securityContext.asOrg description: Organization associated with the autonomous system that the event request was sourced to. type: String - contextPath: Okta.Logs.Events.securityContext.isp description: Internet service provider used to send the event's request. type: String - contextPath: Okta.Logs.Events.securityContext.domain description: The domain name associated with the IP address of the inbound event request. type: String - contextPath: Okta.Logs.Events.securityContext.isProxy description: Specifies whether an event's request is from a known proxy. type: String - contextPath: Okta.Logs.Events.request.ipChain.IP description: IP address. type: String - contextPath: Okta.Logs.Events.request.ipChain.geographicalContext.city description: The city encompassing the area containing the geo-location coordinates, if available. For example, Seattle, San Francisco. type: String - contextPath: Okta.Logs.Events.request.ipChain.geographicalContext.state description: Full name of the state or province encompassing the area containing the geo-location coordinates. For example, Montana, Incheon. type: String - contextPath: Okta.Logs.Events.request.ipChain.geographicalContext.country description: Full name of the country encompassing the area containing the geo-location coordinates. For example, France, Uganda. type: String - contextPath: Okta.Logs.Events.request.ipChain.source description: Details regarding the source. type: String - contextPath: Okta.Logs.Events.target.id description: ID of a target. type: String - contextPath: Okta.Logs.Events.target.type description: Type of a target. type: String - contextPath: Okta.Logs.Events.target.alternateId description: Alternative ID of a target. type: String - contextPath: Okta.Logs.Events.target.displayName description: Display name of a target. type: String - contextPath: Okta.Metadata.x-rate-limit-limit description: The rate limit ceiling that’s applicable for the current request. type: Number - contextPath: Okta.Metadata.x-rate-limit-remaining description: The amount of requests left for the current rate-limit window. type: Number - contextPath: Okta.Metadata.x-rate-limit-reset description: The time at which the rate limit resets, specified in UTC epoch time (in seconds). type: Number - arguments: - description: Okta User ID. name: userId - description: Username of the user. name: username description: Deletes the specified user. execution: true name: okta-delete-user outputs: - contextPath: Okta.Metadata.x-rate-limit-limit description: The rate limit ceiling that’s applicable for the current request. type: Number - contextPath: Okta.Metadata.x-rate-limit-remaining description: The amount of requests left for the current rate-limit window. type: Number - contextPath: Okta.Metadata.x-rate-limit-reset description: The time at which the rate limit resets, specified in UTC epoch time (in seconds). type: Number compliantpolicies: - User Hard Remediation - arguments: - description: Okta User ID. name: userId required: true - description: When true, revokes OpenID Connect and OAuth refresh and access tokens issued to the user. name: revokeOauthTokens auto: PREDEFINED defaultValue: 'true' predefined: - 'true' - 'false' description: |- Removes all active identity provider sessions. This forces the user to authenticate upon the next operation. By default, OpenID Connect and OAuth refresh and access tokens issued to the user are revoked. Token revocation can be disabled if needed. For more information and examples: https://developer.okta.com/docs/reference/api/users/#user-sessions name: okta-clear-user-sessions outputs: - contextPath: Okta.Metadata.x-rate-limit-limit description: The rate limit ceiling that’s applicable for the current request. type: Number - contextPath: Okta.Metadata.x-rate-limit-remaining description: The amount of requests left for the current rate-limit window. type: Number - contextPath: Okta.Metadata.x-rate-limit-reset description: The time at which the rate limit resets, specified in UTC epoch time (in seconds). type: Number compliantpolicies: - User Soft Remediation - arguments: - description: The maximum number of results to return. name: limit description: Get an Okta Zone object. name: okta-list-zones outputs: - contextPath: Okta.Zone.created description: Zone creation timestamp, in the format 2020-04-06T22:23:12.000Z. type: Date - contextPath: Okta.Zone.gateways.type description: Gateways IP entry type, e.g., CIDR. type: String - contextPath: Okta.Zone.gateways.value description: Gateways IP entry value, e.g., 34.103.1.108/32. type: String - contextPath: Okta.Zone.id description: Zone ID, e.g., nzoqsmcx1qWYJ6wYF0h7. type: String - contextPath: Okta.Zone.lastUpdated description: Zone last update timestamp, e.g., 2020-04-06T22:23:12.000Z. type: Date - contextPath: Okta.Zone.name description: Zone name. type: String - contextPath: Okta.Zone.proxies.type description: Proxies IP entry type e.g. CIDR. type: String - contextPath: Okta.Zone.proxies.value description: Proxies IP entry value, e.g., 34.103.1.108/32. type: Unknown - contextPath: Okta.Zone.status description: Zone status, e.g., ACTIVE. type: String - contextPath: Okta.Zone.system description: True if this is a system zone, false if user-created. type: Number - contextPath: Okta.Zone.type description: Zone type, e.g., IP. type: String - contextPath: Okta.Metadata.x-rate-limit-limit description: The rate limit ceiling that’s applicable for the current request. type: Number - contextPath: Okta.Metadata.x-rate-limit-remaining description: The amount of requests left for the current rate-limit window. type: Number - contextPath: Okta.Metadata.x-rate-limit-reset description: The time at which the rate limit resets, specified in UTC epoch time (in seconds). type: Number - arguments: - description: Zone ID to update, e.g., nzoqsmcx1qWYJ6wYF0h7. name: zoneID required: true - description: Updates the zone name. name: zoneName - description: 'Updates Gateway IP addresses: CIDR range (1.1.0.0/16), single IP address (2.2.2.2) or an IP range (1.2.3.4-1.2.3.5).' isArray: true name: gatewayIPs - description: 'Update Proxy IP addresses: CIDR range (1.1.0.0/16), single IP address (2.2.2.2) or an IP range (1.2.3.4-1.2.3.5).' isArray: true name: proxyIPs - description: 'Indicate the update type: APPEND - add an IP to an existing list of zone IPs. OVERRIDE: overriding the existing IP list with the given IP.' isArray: false name: updateType auto: PREDEFINED predefined: - "APPEND" - "OVERRIDE" defaultValue: 'OVERRIDE' description: Update an Okta Zone. name: okta-update-zone outputs: - contextPath: Okta.Zone.created description: Zone creation timestamp, e.g., 2020-04-06T22:23:12.000Z. type: Date - contextPath: Okta.Zone.gateways.type description: Gateways IP entry type, e.g., CIDR. type: String - contextPath: Okta.Zone.gateways.value description: Gateways IP entry value, e.g., 34.103.1.108/32. type: String - contextPath: Okta.Zone.id description: Okta Zone ID, e.g., nzoqsmcx1qWYJ6wYF0h7. type: String - contextPath: Okta.Zone.lastUpdated description: Zone last update timestamp, in the format 2020-04-06T22:23:12.000Z. type: Date - contextPath: Okta.Zone.name description: Zone name. type: String - contextPath: Okta.Zone.proxies.type description: Proxies IP entry type, e.g., CIDR. type: String - contextPath: Okta.Zone.proxies.value description: Proxies IP entry value, e.g., 34.103.1.108/32. type: Unknown - contextPath: Okta.Zone.status description: Zone status, e.g., ACTIVE. type: String - contextPath: Okta.Zone.system description: True if this is a system zone, false if user-created. type: Number - contextPath: Okta.Zone.type description: Zone type, e.g., IP. type: String - contextPath: Okta.Metadata.x-rate-limit-limit description: The rate limit ceiling that’s applicable for the current request. type: Number - contextPath: Okta.Metadata.x-rate-limit-remaining description: The amount of requests left for the current rate-limit window. type: Number - contextPath: Okta.Metadata.x-rate-limit-reset description: The time at which the rate limit resets, specified in UTC epoch time (in seconds). type: Number - arguments: - description: Zone ID to get, e.g., nzoqsmcx1qWYJ6wYF0h.7. name: zoneID required: true description: Get a Zone by its ID. name: okta-get-zone outputs: - contextPath: Okta.Zone.created description: Zone creation timestamp, in the format 2020-04-06T22:23:12.000Z. type: Date - contextPath: Okta.Zone.gateways.type description: Gateways IP entry type, e.g., CIDR. type: String - contextPath: Okta.Zone.gateways.value description: Gateways IP entry value, e.g., 34.103.1.108/32. type: String - contextPath: Okta.Zone.id description: Okta Zone ID, e.g., nzoqsmcx1qWYJ6wYF0h7. type: String - contextPath: Okta.Zone.lastUpdated description: Zone last update timestamp, in the format 2020-04-06T22:23:12.000Z. type: Date - contextPath: Okta.Zone.name description: Zone name. type: String - contextPath: Okta.Zone.proxies.type description: Proxies IP entry type, e.g., CIDR. type: String - contextPath: Okta.Zone.proxies.value description: Proxies IP entry value, e.g., 34.103.1.108/32. type: Unknown - contextPath: Okta.Zone.status description: Zone status, e.g,. ACTIVE. type: String - contextPath: Okta.Zone.system description: True if this is a system zone, false if user-created. type: Number - contextPath: Okta.Zone.type description: Zone type, e.g., IP. type: String - contextPath: Okta.Metadata.x-rate-limit-limit description: The rate limit ceiling that’s applicable for the current request. type: Number - contextPath: Okta.Metadata.x-rate-limit-remaining description: The amount of requests left for the current rate-limit window. type: Number - contextPath: Okta.Metadata.x-rate-limit-reset description: The time at which the rate limit resets, specified in UTC epoch time (in seconds). type: Number - arguments: - description: Zone name. name: name required: true - description: 'Update Gateway IP addresses: CIDR range (1.1.0.0/16), single IP address (2.2.2.2) or an IP range (1.2.3.4-1.2.3.5).' name: gateway_ips - description: 'Update Proxy IP addresses: CIDR range (1.1.0.0/16), single IP address (2.2.2.2) or an IP range (1.2.3.4-1.2.3.5).' name: proxies description: Creates a Zone with the specified name. name: okta-create-zone outputs: - contextPath: Okta.Metadata.x-rate-limit-limit description: The rate limit ceiling that’s applicable for the current request. type: Number - contextPath: Okta.Metadata.x-rate-limit-remaining description: The amount of requests left for the current rate-limit window. type: Number - contextPath: Okta.Metadata.x-rate-limit-reset description: The time at which the rate limit resets, specified in UTC epoch time (in seconds). type: Number - arguments: - description: Name of the group to add. name: name required: true - description: Description of the group to add. name: description description: Create a new group in Okta tenant. execution: true name: okta-create-group outputs: - contextPath: OktaGroup.ID description: Group ID in Okta. type: Unknown - contextPath: OktaGroup.Name description: Group name in Okta. type: Unknown - contextPath: OktaGroup.Description description: Group description in Okta. type: Unknown - contextPath: OktaGroup.Type description: Group type in Okta. type: Unknown - contextPath: Okta.Metadata.x-rate-limit-limit description: The rate limit ceiling that’s applicable for the current request. type: Number - contextPath: Okta.Metadata.x-rate-limit-remaining description: The amount of requests left for the current rate-limit window. type: Number - contextPath: Okta.Metadata.x-rate-limit-reset description: The time at which the rate limit resets, specified in UTC epoch time (in seconds). type: Number - arguments: - description: Name of the group to assign to the app. name: groupName - description: ID of the group to assign to the app. name: groupId - description: Friendly name of the app that the group will be assigned to. name: appName description: Assign a group to an application. name: okta-assign-group-to-app outputs: - contextPath: Okta.Metadata.x-rate-limit-limit description: The rate limit ceiling that’s applicable for the current request. type: Number - contextPath: Okta.Metadata.x-rate-limit-remaining description: The amount of requests left for the current rate-limit window. type: Number - contextPath: Okta.Metadata.x-rate-limit-reset description: The time at which the rate limit resets, specified in UTC epoch time (in seconds). type: Number - arguments: - default: true description: Okta username for which to expire the password. name: username required: true - auto: PREDEFINED defaultValue: 'false' description: When true, you'll need to change the password in the next login. name: temporary_password predefined: - 'true' - 'false' - auto: PREDEFINED defaultValue: 'false' description: Revokes the user's existing sessions and returns a temporary password, regardless of the temporary_password value. When true, you'll need to change the password in the next login. name: revoke_session predefined: - 'true' - 'false' - auto: PREDEFINED defaultValue: 'false' description: Prevents the password from being saved in the War Room. name: hide_password predefined: - 'true' - 'false' description: Expires a password for an existing Okta user. execution: true name: okta-expire-password outputs: - contextPath: Account.Activated description: Timestamp for when the user was activated. type: Date - contextPath: Account.Created description: Timestamp for when the user was created. type: Date - contextPath: Account.DisplayName description: Okta account display name. type: String - contextPath: Account.Email description: Okta account email. type: String - contextPath: Account.ID description: Created Okta account ID. type: String - contextPath: Account.PasswordChanged description: Timestamp for when the user's password was last changed. type: Date - contextPath: Account.Status description: Okta account current status. type: String - contextPath: Account.StatusChanged description: Timestamp for when the user's status was last changed. type: Date - contextPath: Account.Type description: Okta account type. type: String - contextPath: Account.Username description: Okta account usernames returned by the search. type: String - contextPath: Okta.Metadata.x-rate-limit-limit description: The rate limit ceiling that’s applicable for the current request. type: Number - contextPath: Okta.Metadata.x-rate-limit-remaining description: The amount of requests left for the current rate-limit window. type: Number - contextPath: Okta.Metadata.x-rate-limit-reset description: The time at which the rate limit resets, specified in UTC epoch time (in seconds). type: Number compliantpolicies: - User Soft Remediation - description: Reset OAuth authentication data (authentication process will start from the beginning, and a new token will be generated). name: okta-auth-reset arguments: [] dockerimage: demisto/crypto:1.0.0.5490413 runonce: false script: "" subtype: python3 type: python fromversion: 5.0.0 tests: - OktaV2-Test