Okta

Learn how to connect Engini to Okta

Using Engini’s Okta activities, you can:

• Create, Update, and Get Users
• Create, Update, and Get Groups
• Listen to Events on Users and Groups

To get started with the Okta app, create an account at https://login.okta.com/signin/.

Getting Started with Okta #

Prerequisites #

1. Active okta account.
2. Access to okta’s admin area or an active access token.

Connecting Engini to Okta #

Retrieve your okta access token #

If you already obtained an active okta access token jump to the next step.

1. Navigate to the Admin section in the top right corner of your Okta account.

3. If you have already generated your access token, you can copy it from here. If not, you can create a new one. Copy the access token and save it, as you will need it to add the connection to your Okta account in Engini.

Add a connection to okta in Engini #

1. Enter your Engini account at https://app.engini.io.
2. Navigate to the Connections page by clicking on Connections in the left sidebar or by clicking here.
3. Click on the Add Connection option located at the top.

4. Choose the Okta option from the available applications.

5. Enter the following details in the “Add Connection” form:
   • Connection name
   • Url – Copy the URL from the address bar of your browser and paste it here.
   • API Key – Enter the access token you obtained from Okta.com.

6. Click the Save button located at the bottom of the form.
7. Engini will now save this connection and grant access to all the boards you have access to with the provided access token.

Please note that any board created in Okta after saving this connection will not be shown in the board list in Engini activity blocks. To access these new boards using Engini, you will need to refresh your Okta objects in Engini.

Steps to Refresh:

1. At the far right of the okta connection row, click on the three dots to open the options menu.
2. click on the “Refresh objects” option to refresh the objects associated with this connection.

Triggers #

The trigger is executed automatically in response to a specific event. Every workflow must start with a trigger. You can use triggers like “Check recent event logs” or “Event hook”.

Check recent event logs #

This trigger will check the event logs in Okta.

Starting (UTC):

• Date and Time: Specifies when the trigger should start. In this example, it is set to start on August 5, 2024, at 00:00 UTC.

Recur Every:

• Interval: Defines how often the trigger should recur. In this case, it is set to recur every 15 minutes.

Add Time Frame:

• Allows you to specify a time frame for which the logs should be checked.

Add Sorting:

• Option to sort the event logs based on certain criteria.
• Use the up (↑) and down (↓) arrows to adjust the priority of the sorting rules if you have multiple sorting criteria.

Add Conditions:

• By adding a condition, the workflow will only execute if the specified condition(s) are met.

Event hook #

The “Event hook” trigger in Okta is used to execute a workflow in response to specific events related to user management in Okta.

Event Type: You can select an event type that will trigger the workflow. The available event types in the dropdown menu are:

1. Activate Okta user:
   • The workflow is triggered when a user is activated in Okta.

2. Create Okta user:
   • The workflow is triggered when a new user is created in Okta.

3. Deactivate Okta user:
   • The workflow is triggered when a user is deactivated in Okta.

4. Delete Okta user completed:
   • The workflow is triggered when the deletion of a user is completed in Okta.

Example Use Case:

If you select “Create Okta user” as the event type, the workflow will be triggered whenever a new user is created in Okta. This could be useful for automatically setting up new users in other systems, sending welcome emails, or adding them to specific groups.

Actions #

Activate User #

The “Activate User” action is used to change a user’s status in Okta from inactive to active. This is typically part of onboarding processes where a newly created user is activated to start using their account.

Configuration Fields:

1. UserId:
   • This field requires the unique identifier (ID) of the user you want to activate. You need to provide the specific user ID of the Okta user.
2. Sends an activation email to the user if true:
   • This field is a boolean option (true/false).
   • If set to true, Okta will send an activation email to the user. This email usually contains instructions for the user to complete the activation process, such as setting up a password.

Add Group #

The “Add Group” action is used to create a new group in Okta. Groups in Okta are used to organize users and apply policies, permissions, and configurations collectively.

Configuration Fields:

1. Choose Field: This dropdown allows you to select different fields that define the properties of the group.
2. Field Value: Once you select a field, you need to provide the corresponding value for that field.
   • You can fill in the field value using one of the following:
     • Static Value: Enter a number or string (strings must be in single quotes (‘) ).
     • Property Value from a Previous Activity: Use the tooltip that opens when clicking on the field to select a value from a prior activity.
     • Expression: Combine functions, previous activity properties, and static values using the tooltip that opens when clicking on the field.

Add User to Group #

The “Add User to Group” action is used to assign a user to a group in Okta. This can be useful for organizing users into groups that share common access permissions, policies, or roles.

Configuration Fields:

1. GroupId:
   • This field requires the unique identifier (ID) of the group to which you want to add the user. You need to provide the specific group ID of the Okta group.
2. UserId:
   • This field requires the unique identifier (ID) of the user you want to add to the group. You need to provide the specific user ID of the Okta user.

Create Group Rule #

The “Create Group Rule” action is used to create rules that automatically assign users to groups based on specific criteria. This can help automate group management and ensure users are placed in the correct groups based on attributes such as their department, role, or location.

Configuration Fields:

1. Choose Field: This dropdown allows you to select different fields that define the criteria for the rule.
2. Field Value: Once you select a field, you need to provide the corresponding value for that field.
   • You can fill in the field value using one of the following:
     • Static Value: Enter a number or string (strings must be in single quotes (‘) ).
     • Property Value from a Previous Activity: Use the tooltip that opens when clicking on the field to select a value from a prior activity.
     • Expression: Combine functions, previous activity properties, and static values using the tooltip that opens when clicking on the field.

Create User #

The “Create User” action is used to add a new user to your Okta organization. This includes setting up the user’s profile with essential details such as email, first name, last name, and login information.

Configuration Fields:

1. Profile – email:
   • Enter the user’s email address. This is typically used as the primary contact method and sometimes as the username.
2. Profile – first Name:
   • Enter the user’s first name.
3. Profile – last Name:
   • Enter the user’s last name.
4. Profile – login:
   • Enter the user’s login name. This is often the same as the email address but can be different depending on your organization’s login policies.
5. Add Additional Fields (if needed):
   • If you need to add more profile fields for the user, click the “Add Field” button.
   • You can include additional fields such as mobile phone, organization, nick name, etc., depending on your organization’s requirements
   • You can fill in the field value using one of the following:
     • Static Value: Enter a number or string (strings must be in single quotes (‘) ).
     • Property Value from a Previous Activity: Use the tooltip that opens when clicking on the field to select a value from a prior activity.
     • Expression: Combine functions, previous activity properties, and static values using the tooltip that opens when clicking on the field.

Deactivate User #

The “Deactivate User” action is used to change a user’s status in Okta from active to deactivated. Deactivating a user prevents them from accessing your organization’s resources but retains their profile and associated data for potential reactivation or auditing purposes.

Configuration Fields:

1. UserId:
   • This field requires the unique identifier (ID) of the user you want to deactivate. You need to provide the specific user ID of the Okta user.

2. Add Additional Fields (if needed):
   • Click the “Add Field” button to include the option for sending a deactivation email.
   • You can fill in the field value using one of the following:
     • Static Value: Enter a number or string (strings must be in single quotes (‘) ).
     • Property Value from a Previous Activity: Use the tooltip that opens when clicking on the field to select a value from a prior activity.
     • Expression: Combine functions, previous activity properties, and static values using the tooltip that opens when clicking on the field.

Delete User #

The “Delete User” action is used to permanently delete a user from your Okta organization. This action removes the user and all associated data from Okta, making it irreversible.

Configuration Fields:

1. UserId:
   • This field requires the unique identifier (ID) of the user you want to delete. You need to provide the specific user ID of the Okta user.
2. Add Additional Fields (if needed):
   • If you want Okta to send an email notification to the user upon deletion, you can configure this field.
   • You can fill in the field value using one of the following:
     • Static Value: Enter a number or string (strings must be in single quotes (‘) ).
     • Property Value from a Previous Activity: Use the tooltip that opens when clicking on the field to select a value from a prior activity.
     • Expression: Combine functions, previous activity properties, and static values using the tooltip that opens when clicking on the field.

Get Event Logs #

The “Get Event Logs” action is used to fetch event logs from Okta. Event logs contain information about various activities and changes within your Okta organization, such as user logins, password changes, and administrative actions.

Configuration Fields:

1. Add Sorting:
   • This option allows you to define how the retrieved event logs should be sorted.
   • Choose published to sort the logs by the timestamp of when the events were logged.

2. Add Filter:
   • This option allows you to add filters to narrow down the event logs based on specific criteria, such as event type, user ID, version, etc.
   • You can fill in the field value using one of the following:
     • Static Value: Enter a number or string (strings must be in single quotes (‘) ).
     • Property Value from a Previous Activity: Use the tooltip that opens when clicking on the field to select a value from a prior activity.
     • Expression: Combine functions, previous activity properties, and static values using the tooltip that opens when clicking on the field.

3. Top N:
   • In this field, you can specify the total number of entries to retrieve. The default value is often set to a certain number (e.g., 100). You can adjust this to retrieve more or fewer entries as needed.

Get Group Members #

The “Get Group Members” action is used to fetch the list of users who are members of a specified group in Okta. This can be useful for managing group memberships and understanding which users have access to certain resources or permissions.

Configuration Fields:

1. GroupId:
   • This field requires the unique identifier (ID) of the group whose members you want to retrieve. You need to provide the specific group ID of the Okta group.

Get User #

The “Get User” action is used to fetch the details of a specific user in Okta. This can include information such as the user’s profile details, status, group memberships, and more.

Configuration Fields:

1. UserId:
   • This field requires the unique identifier (ID) of the user whose details you want to retrieve. You need to provide the specific user ID of the Okta user.

Get Users #

The “Get Users” action is used to fetch a list of users from your Okta organization. This can include various user details and can be filtered or sorted based on specific criteria.

Configuration Fields:

1. Add Sorting:
   • This option allows you to define how the retrieved user list should be sorted.
   • Choose a field from the available options (e.g., profile – email) to sort the users by.
2. Add Filter:
   • This option allows you to add filters to narrow down the list of users based on specific criteria, such as activated, created and more.
   • Specify the condition for the filter.
   • You can fill in the field value using one of the following:
     • Static Value: Enter a number or string (strings must be in single quotes (‘) ).
     • Property Value from a Previous Activity: Use the tooltip that opens when clicking on the field to select a value from a prior activity.
     • Expression: Combine functions, previous activity properties, and static values using the tooltip that opens when clicking on the field.
3. Top N:
   • In this field, you can specify the total number of user entries to retrieve. The default value is often set to a certain number (e.g., 100). You can adjust this to retrieve more or fewer entries as needed.

Remove Group #

The “Remove Group” action is used to permanently delete a group from your Okta organization. This action removes the group and all associated memberships, making it irreversible.

Configuration Fields:

1. GroupId:
   • This field requires the unique identifier (ID) of the group you want to remove. You need to provide the specific group ID of the Okta group.

Remove User from Group #

The “Remove User from Group” action is used to disassociate a user from a group in Okta. This action can be part of managing group memberships, ensuring that users are only part of relevant groups.

Configuration Fields:

1. GroupId:
   • This field requires the unique identifier (ID) of the group from which you want to remove the user. You need to provide the specific group ID of the Okta group.
2. UserId:
   • This field requires the unique identifier (ID) of the user you want to remove from the group. You need to provide the specific user ID of the Okta user.

Send Api Request #

The “Send API Request” action allows you to send custom HTTP requests to an API endpoint. This can be used to perform a wide range of operations, such as creating, updating, or deleting resources, fetching data, or triggering specific actions.

Configuration Fields:

1. Base URL:
   • This is the root URL of the API you are interacting with. For Okta, this is typically in the format https://{yourOktaDomain}.okta.com.
2. Relative URL:
   • This is the specific endpoint path you want to interact with. It is appended to the base URL. For example, to get a list of users, you might use /api/v1/users.
3. Method:
   • Delete:Used to delete a resource from the server.
   • Get:Used to retrieve data from the server.
   • Patch:Used to partially update a resource on the server.
   • Post:Used to create a new resource on the server.
   • Put:Used to fully update a resource on the server.
4. Body Type:
   • Allows you to specify the content type of the request body.
5. Add Headers:
   • Click Add Headers to specify any necessary headers for the request.
6. Add Queries:
   • Click Add Queries to include any query parameters needed for the request.

Update User #

The “Update User” action is used to update the profile information of an existing user in Okta. This includes modifying fields such as email, first name, last name, and login.

Configuration Fields:

1. UserId:
   • This field requires the unique identifier (ID) of the user whose profile you want to update. You need to provide the specific user ID of the Okta user.
2. Profile – email:
   • Enter the new email address for the user.
3. Profile – first Name:
   • Enter the new first name for the user.
4. Profile – last Name:
   • Enter the new last name for the user.
5. Profile – login:
   • Enter the new login name for the user.
6. Add Field:
   • Click this button to add more fields to update other profile attributes as needed.
   • You can fill in the field value using one of the following:
     • Static Value: Enter a number or string (strings must be in single quotes (‘) ).
     • Property Value from a Previous Activity: Use the tooltip that opens when clicking on the field to select a value from a prior activity.
     • Expression: Combine functions, previous activity properties, and static values using the tooltip that opens when clicking on the field.