Okta

1. Overview

Okta is a leading identity and access management service that provides secure connections between people and technology. The Okta API allows for programmatic control over users, groups, and applications within your Okta organization.

Through GoInsight's Okta node, you can integrate robust user management capabilities directly into your automated workflows. This enables you to perform a full lifecycle of user operations, including:

• Creating, retrieving, updating, and deleting individual users.
• Listing and searching for multiple users based on various criteria.

2. Prerequisites

Before using this node, you need to have a valid Okta account with administrative privileges sufficient to create an API token.

3. Credentials

For a detailed guide on how to obtain and configure credentials, please refer to our official documentation: Credential Configuration Guide.

4. Supported Operations

Summary

This node provides operations centered around the User resource in Okta. The table below summarizes the available actions.

Operation Details

Create a New User

Creates a new user in Okta using the Okta Management API. Supports setting profile fields and credentials.

Input Parameters:

• UserName: User login name, must be a valid email or conform to policy.
• Email: User email address.
• FirstName: User's first name.
• LastName: User's last name.

Options:

• Password: User password, optional.
• Activate: True to activate immediately, False to send activation email.

Output:

• User (object): Okta returned user object with id, status, and profile fields.
• StatusCode (number): Operation status code: -1 for parameter error, 200-299 for success, 500 for exception errors.
• ErrorMessage (string): Error message, empty if no error.

Delete a User

Deletes a user in Okta using the Okta Management API. This operation permanently removes a user. A successful deletion returns HTTP 204 No Content.

Input Parameters:

• UserId: The ID of the user to delete.

Output:

• StatusCode (number): HTTP response status code: 204 indicates successful deletion -1 indicates a parameter validation error 500 indicates an internal exception
• ErrorMessage (string): Detailed error message; empty if the operation succeeded.

Get a User

Retrieves a user by ID in Okta using the Okta Management API.

Input Parameters:

• UserId: The ID of the user to retrieve.

Output:

• User (object): The Okta returned user object containing id, status, and profile fields.
• StatusCode (number): Operation status code: 200-299 indicates success; -1 indicates parameter validation error; 500 indicates internal exception.
• ErrorMessage (string): Detailed error message; empty if the operation succeeded.

Get Many Users

Retrieves a list of users from Okta using the Okta Management API. Supports pagination and filtering.

Options:

• Limit: Maximum number of users to return. Use 0 to apply Okta default page size.
• After: Pagination cursor from the 'after' link header of the previous response.
• Search: Okta search query, e.g., profile.email sw \"user@\" or profile.firstName Eq \"John\".

Output:

• Users (object-array): The list of user objects returned by Okta.
• StatusCode (number): Operation status code: 200–299 indicates success -1 indicates parameter validation error 500 indicates internal exception
• ErrorMessage (string): Detailed error message; empty if the operation succeeded.

Update a User

Updates a user's profile or credentials in Okta using the Okta Management API. Supports updating profile fields and password.

Input Parameters:

• UserId: ID of the user to update.

Options:

• UserName: New user name.
• Email: New email address.
• FirstName: New first name.
• LastName: New last name.
• Password: New password.

Output:

• User (object): Okta returned user object containing id, status, and profile fields.
• StatusCode (number): Operation status code: 200–299 indicates success; -1 indicates parameter validation error; 500 indicates internal exception.
• ErrorMessage (string): Detailed error message; empty if the operation succeeded.

5. Example Usage

This section will guide you through creating a simple workflow to add a new user to your Okta organization.

The workflow will consist of: Start -> Create a New User -> Answer.

Step-by-Step Guide

1. Add the Tool Node
   • In the workflow canvas, click the "+" button to add a new node.
   • Select the "Tools" tab in the pop-up panel.
   • Find and select "Okta" from the list of tools.
   • In the list of supported operations for Okta, click on "Create a New User" to add the node to the canvas.
2. Configure the Node
   • Click on the newly added "Create a New User" node to open its configuration panel on the right.
   • Credentials: In the credentials field at the top, select your pre-configured Okta credential from the dropdown menu.
   • Parameters: Fill in the required input parameters for the action.
   • UserName: Enter the user's login name, which is typically their email address (e.g., new.user@example.com).
   • Email: Enter the user's primary email address (e.g., new.user@example.com).
   • FirstName: Enter the user's first name (e.g., John).
   • LastName: Enter the user's last name (e.g., Doe).
   • Activate: You can leave this optional parameter as true to activate the user immediately upon creation.
3. Run and Verify
   • Once all required parameters are correctly filled, any error indicators on the workflow canvas should disappear.
   • Click the "Test Run" button in the top-right corner of the canvas to execute the workflow.
   • After a successful run, you can click the log icon in the top-right corner to view the detailed inputs and outputs of the node, confirming that the operation was successful and a new user object was returned.

After completing these steps, your workflow is fully configured. When you run it, a new user will be created in your Okta organization.

6. FAQs

Q: I'm getting a 401 or 403 error. What should I do?

A: This error typically indicates an issue with your API token or its permissions. Please check the following:

• Valid Token: Ensure the API token you provided in the credentials is correct and has not been revoked.
• Sufficient Permissions: The API token must have the necessary scopes to perform the requested action. For example, to create a user, it needs the okta.users.manage permission. Review the token's permissions in your Okta admin dashboard.

Q: My request is failing with a 400 Bad Request error.

A: This usually means one of the parameters you provided is invalid or improperly formatted.

• Check User Policies: Ensure the UserName and Email you are providing conform to your organization's Okta policies.
• Review Parameters: Double-check all input fields for typos or incorrect data types. For example, ensure the UserId is correct when trying to update or delete a user.

7. Official Documentation

For more advanced use cases and detailed information about the Okta API, please refer to the Okta Developer Documentation.