Okta

Actions

This section lists the actions supported by the Okta connector. To understand how to configure the actions, see Action examples.

ReactivateUser action

This action reactivates a user.

Input parameters of the ReactivateUser action

For example on how to configure the ReactivateUser action, see ActivateUser Example.

ActivateUser action

This action activates a user.

Input parameters of the ActivateUser action

For example on how to configure the ActivateUser action, see ActivateUser Example.

DeactivateUser action

This action deactivates a user.

Input parameters of the DeactivateUser action

For example on how to configure the DeactivateUser action, see DeactivateUser Example.

Assignusertogroup action

This action assigns a user to a group.

Input parameters of the Assignusertogroup action

For example on how to configure the Assignusertogroup action, see Assignusertogroup Example.

UnassignUsertoRole action

This action unassigns a user from a role.

Input parameters of the UnassignUsertoRole action

For example on how to configure the UnassignUsertoRole action, see UnassignUsertoRole Example.

AssignUsertoRole action

This action assigns a user to a role.

Input parameters of the AssignUsertoRole action

For example on how to configure the AssignUsertoRole action, see AssignUsertoRole Example.

AssignUsertoApp action

This action assigns a user to an app.

Input parameters of the AssignUsertoApp action

For example on how to configure the AssignUsertoApp action, see AssignUsertoApp Example.

UnassignUsertoGroup action

This action unassigns a user from a group.

Input parameters of the UnassignUsertoGroup action

For example on how to configure the UnassignUsertoGroup action, see UnassignUsertoGroup Example.

UnassignUsertoApp action

This action unassigns a user from an App.

Input parameters of the UnassignUsertoApp action

For example on how to configure the UnassignUsertoApp action, see UnassignUsertoApp Example.

Assigngrouptoapp action

This action assigns a group to an app.

Input parameters of the Assigngrouptoapp action

For example on how to configure the Assigngrouptoapp action, see Assigngrouptoapp Example.

AssignGrouptoRole action

This action assigns a group to a role.

Input parameters of the AssignGrouptoRole action

For example on how to configure the AssignGrouptoRole action, see AssignGrouptoRole Example.

UnassignGrouptoApp action

This action unassigns a group from an app.

Input parameters of the UnassignGrouptoApp action

For example on how to configure the UnassignGrouptoApp action, see UnassignGrouptoApp Example.

UnassignGrouptoRole action

This action unassigns a group from a role.

Input parameters of the UnassignGrouptoRole action

For example on how to configure the UnassignGrouptoRole action, see UnassignGrouptoRole Example.

SuspendUser action

This action suspends a user.

Input parameters of the SuspendUser action

For example on how to configure the SuspendUser action, see SuspendUser Example.

UnsuspendUser action

This action unsuspends a user.

Input parameters of the UnsuspendUser action

For example on how to configure the UnsuspendUser action, see UnsuspendUser Example.

Action examples

Example - Reactivate a user

1. In the Configure connector task dialog, click Actions.
2. Select the ReactivateUser action, and then click Done.
3. In the Task Input section of the Connectors task, click connectorInputPayload and then enter a value similar to the following in the Default Value field:

   {
       "UserId": "00ulgqf2s4Zs5Ohge5d7"
   }
   

If the action is successful, the ReactivateUser task's connectorOutputPayload response parameter will have a value similar to the following:

{ 
    "Status": "Success",
    "ActivationToken": "PKeQTJMUW9vg0wyh8czA",
    "ActivationUrl": "https://dev-99779501.okta.com/tokens/PKeQTJMUW9vg0wyh8czA/verify" 
}

Example - Activate a user

1. In the Configure connector task dialog, click Actions.
2. Select the ActivateUser action, and then click Done.
3. In the Task Input section of the Connectors task, click connectorInputPayload and then enter a value similar to the following in the Default Value field:

   {
       "UserId": "00ulgqf2s4Zs5Ohge5d7"
   }
   
   

If the action is successful, the ActivateUser task's connectorOutputPayload response parameter will have a value similar to the following:

{ 
  "Status": "Success",
    "activationurl": null,
    "activationtoken": null
}

Example - Deactivate a user

1. In the Configure connector task dialog, click Actions.
2. Select the DeactivateUser action, and then click Done.
3. In the Task Input section of the Connectors task, click connectorInputPayload and then enter a value similar to the following in the Default Value field:

   {
       "UserId": "00ulgqf2s4Zs5Ohge5d7"
   }
   

If the action is successful, the DeactivateUser task's connectorOutputPayload response parameter will have a value similar to the following:

{ 
 "Status": "Success",
"activationurl": null,
"activationtoken": null 
} 

Example - Assign a user to a group

1. In the Configure connector task dialog, click Actions.
2. Select the Assignusertogroup action, and then click Done.
3. In the Task Input section of the Connectors task, click connectorInputPayload and then enter a value similar to the following in the Default Value field:

   {
       "UserId": "00ulgqf2s4Zs5Ohge5d7",
       "GroupId": "7463874b834938475d"
   }
   

If the action is successful, the Assignusertogroup task's connectorOutputPayload response parameter will have a value similar to the following:

{
 "Status": "Success",
}

Example - Unassign a user from a role

1. In the Configure connector task dialog, click Actions.
2. Select the UnassignUsertoRole action, and then click Done.
3. In the Task Input section of the Connectors task, click connectorInputPayload and then enter a value similar to the following in the Default Value field:

   {
       "UserId": "00ukxucmpl25SNLP65d7",
       "RoleAssignmentId": "irblawnjpom1bLBcJ5d7"
   }
   

If the action is successful, the UnassignUsertoRole task's connectorOutputPayload response parameter will have a value similar to the following:

{
 "Status": "Success",
}

Example - Assign a user to a role

1. In the Configure connector task dialog, click Actions.
2. Select the AssignUsertoRole action, and then click Done.
3. In the Task Input section of the Connectors task, click connectorInputPayload and then enter a value similar to the following in the Default Value field:

   {
   "UserId": "00ukxucmpl25SNLP65d7",
   "RoleId": "cr0l2n9ay0pCCxLgG5d7",
   "ResourceSet": "iaml81kep6zefR4Oq5d7",
   "Type": "CUSTOM"
   }
   

If the action is successful, the AssignUsertoRole task's connectorOutputPayload response parameter will have a value similar to the following:

{
 "Status": "Success",
    "Id": "irblawfe99RsUfILD5d7",
    "Label": "UserCreatorByabhishkePostman",
    "Type": "CUSTOM", 
    "Created": "2024-11-21 07:33:05.0",
    "LastUpdated": "2024-11-21 07:33:05.0",
    "AssignmentStatus": "ACTIVE",
    "AssignmentType": "USER",
    "resource-set": "iaml81kep6zefR4Oq5d7",
    "role": "cr0l2n9ay0pCCxLgG5d7",
    "_links_role_href": "https://dev-99779501-admin.okta.com/api/v1/iam/roles/cr0l2n9ay0pCCxLgG5d7",
    "_links_resource-set_href": "https://dev-99779501.okta.com/api/v1/iam/resource-sets/iaml81kep6zefR4Oq5d7",
    "_links_permissions_href": "https://dev-99779501-admin.okta.com/api/v1/iam/roles/cr0l2n9ay0pCCxLgG5d7/permissions",
    "_links_member_href": "https://dev-99779501.okta.com/api/v1/iam/resource-sets/iaml81kep6zefR4Oq5d7/bindings/cr0l2n9ay0pCCxLgG5d7/members/irblawfe99RsUfILD5d7",
    "_links_assignee_href": "https://dev-99779501.okta.com/api/v1/users/00ukxucmpl25SNLP65d7"

}

Example - Assign a user to an app

1. In the Configure connector task dialog, click Actions.
2. Select the AssignUsertoApp action, and then click Done.
3. In the Task Input section of the Connectors task, click connectorInputPayload and then enter a value similar to the following in the Default Value field:

   {
       "UserId": "00ukxucmpl25SNLP65d7",
       "AppId": "0oakn3j0bfGPR1Esk5d7"
   }
   

If the action is successful, the AssignUsertoApp task's connectorOutputPayload response parameter will have a value similar to the following:

{
    "Status": "Success",
    "Id": "00ukxucmpl25SNLP65d7",
    "Created": "2024-11-21 07:08:40.0",
    "LastUpdated": "2024-11-21 07:08:45.0",
    "Scope": "USER",
    "AssignmentStatus": "ACTIVE",
    "externalid": null, 
    "statuschanged": "2024-11-21T07:08:40.000Z",
    "passwordchanged": null,
    "syncstate": "DISABLED",
    "credentials_username": "baklavainthebalkans@gmail.com",
    "profile_street_address": null,
    "profile_country": null, 
    "profile_website": null,
    "profile_zoneinfo": "America/Los_Angeles",
    "profile_birthdate": null,
    "profile_gender": null,
    "profile_formatted": null,
    "profile_profile": null,
    "profile_locality": null,
    "profile_given_name": "Baklavainthe",
    "profile_middle_name": null,
    le_phone_number": null,
    "profile_region": null,
    "profile_postal_code": null,
    "profile_family_name": "Balkans",
    "profile_email": "baklavainthebalkans@gmail.com",
    "_links_app_href": "https://dev-99779501.okta.com/api/v1/apps/0oakn3j0bfGPR1Esk5d7", 
    "_links_user_href": "https://dev-99779501.okta.com/api/v1/users/00ukxucmpl25SNLP65d7"

}

Example - Unassign a user from a group

1. In the Configure connector task dialog, click Actions.
2. Select the UnassignUsertoGroup action, and then click Done.
3. In the Task Input section of the Connectors task, click connectorInputPayload and then enter a value similar to the following in the Default Value field:

   {
       "UserId": "00ukxucmpl25SNLP65d7",
       "GroupId": "0oakn3j0bfGPR1Esk5d7"
   }
   

If the action is successful, the UnassignUsertoGroup task's connectorOutputPayload response parameter will have a value similar to the following:

{
"Status": "Success"
}

Example - Unassign a user from an app

1. In the Configure connector task dialog, click Actions.
2. Select the UnassignUsertoApp action, and then click Done.
3. In the Task Input section of the Connectors task, click connectorInputPayload and then enter a value similar to the following in the Default Value field:

   {
       "UserId": "00ukxucmpl25SNLP65d7",
       "AppId": "0oakn3j0bfGPR1Esk5d7"
   }
   
   

If the action is successful, the UnassignUsertoApp task's connectorOutputPayload response parameter will have a value similar to the following:

 
{
"Status": "Success"
}

Example - Assign a group to an app

1. In the Configure connector task dialog, click Actions.
2. Select the Assigngrouptoapp action, and then click Done.
3. In the Task Input section of the Connectors task, click connectorInputPayload and then enter a value similar to the following in the Default Value field:

   {
      "GroupId": "00gl5wovm8GuLr8vg5d7",
       "AppId": "0oakn3j0bfGPR1Esk5d7"
   }
   

If the action is successful, the Assigngrouptoapp task's connectorOutputPayload response parameter will have a value similar to the following:

{
"Status": "Success",
"Id": "00gl5wovm8GuLr8vg5d7",
"LastUpdated": "2024-11-21 08:42:53.0",
"Priority": 0,
"_links_app_href": "https://dev-99779501.okta.com/api/v1/apps/0oakn3j0bfGPR1Esk5d7",
"_links_self_href": "https://dev-99779501.okta.com/api/v1/apps/0oakn3j0bfGPR1Esk5d7/groups/00gl5wovm8GuLr8vg5d7", "_links_group_href": "https://dev-99779501.okta.com/api/v1/groups/00gl5wovm8GuLr8vg5d7"
}

Example - Assign a group to a role

1. In the Configure connector task dialog, click Actions.
2. Select the AssignGrouptoRole action, and then click Done.
3. In the Task Input section of the Connectors task, click connectorInputPayload and then enter a value similar to the following in the Default Value field:

   {
   "GroupId": "00gl9xqojqXq0TJgS5d7",
   "RoleId": "cr0l5tqddvkDtcfPl5d7",
   "Type": "CUSTOM", "ResourceSet": "iaml81kep6zefR4Oq5d7"
   }
   

If the action is successful, the AssignGrouptoRole task's connectorOutputPayload response parameter will have a value similar to the following:

{
"Status": "Success",
"Id": "irbla1k8uy8XxDDFF5d7",
"Label": "ReadAdmin_Altostrat",
"Type": "CUSTOM",
"Created": "2024-11-20 12:28:33.0",
"LastUpdated": "2024-11-20 12:28:33.0",
"AssignmentStatus": "ACTIVE",
"AssignmentType": "GROUP",
"resource-set": "iaml81kep6zefR4Oq5d7",
"role": "cr0l5tqddvkDtcfPl5d7",
"_links_role_href": "https://dev-99779501-admin.okta.com/api/v1/iam/roles/cr0l5tqddvkDtcfPl5d7",
"_links_resource-set_href": "https://dev-99779501.okta.com/api/v1/iam/resource-sets/iaml81kep6zefR4Oq5d7", "_links_permissions_href": "https://dev-99779501-admin.okta.com/api/v1/iam/roles/cr0l5tqddvkDtcfPl5d7/permissions", "_links_member_href": "https://dev-99779501.okta.com/api/v1/iam/resource-sets/iaml81kep6zefR4Oq5d7/bindings/cr0l5tqddvkDtcfPl5d7/members/irbla1k8uy8XxDDFF5d7", "_links_assignee_href": "https://dev-99779501.okta.com/api/v1/groups/00gl9xqojqXq0TJgS5d7"
}

Example - Unassign a group from an app

1. In the Configure connector task dialog, click Actions.
2. Select the UnassignGrouptoApp action, and then click Done.
3. In the Task Input section of the Connectors task, click connectorInputPayload and then enter a value similar to the following in the Default Value field:

   {
    "GroupId": "00gl5wovm8GuLr8vg5d7",
    "AppId": "0oakn3j0bfGPR1Esk5d7" 
   }
   

If the action is successful, the UnassignGrouptoApp task's connectorOutputPayload response parameter will have a value similar to the following:

{
"Status": "Success"
}

Example - Unassign a group from a role

1. In the Configure connector task dialog, click Actions.
2. Select the UnassignGrouptoRole action, and then click Done.
3. In the Task Input section of the Connectors task, click connectorInputPayload and then enter a value similar to the following in the Default Value field:

   {
   "GroupId": "00gl5wovm8GuLr8vg5d7",
   "RoleAssignmentId": "irbl94sbyit77SGpg5d7"
   }
   

If the action is successful, the UnassignGrouptoRole task's connectorOutputPayload response parameter will have a value similar to the following:

{
"Status": "Success"
}

Example - Suspend a user

1. In the Configure connector task dialog, click Actions.
2. Select the SuspendUser action, and then click Done.
3. In the Task Input section of the Connectors task, click connectorInputPayload and then enter a value similar to the following in the Default Value field:

   {
   "UserId": "00ulkdsubxO6W6LgJ5d7" 
   }
   

If the action is successful, the SuspendUser task's connectorOutputPayload response parameter will have a value similar to the following:

{
"Status": "Success"
}

Example - Unsuspend a user

1. In the Configure connector task dialog, click Actions.
2. Select the UnsuspendUser action, and then click Done.
3. In the Task Input section of the Connectors task, click connectorInputPayload and then enter a value similar to the following in the Default Value field:

   {
   "UserId": "00ulkdsubxO6W6LgJ5d7" 
   }
   

If the action is successful, the UnsuspendUser task's connectorOutputPayload response parameter will have a value similar to the following:

{
"Status": "Success"
}

Entity operation examples

This section shows how to perform some of the entity operations in this connector.

Example - List all users

1. In the Configure connector task dialog, click Entities.
2. Select Users from the Entity list.
3. Select the List operation, and then click Done.
4. In the Task Input section of the Connectors task, you can set the filterClause as per your requirement.

You must use single quotes (') to enclose the value for a filter clause. You can use the filter clause to filter records based on the columns.

Example - Get a user

1. In the Configure connector task dialog, click Entities.
2. Select Users from the Entity list.
3. Select the Get operation, and then click Done.
4. Set the entity ID to "20001" which is the Key to be passed. To set the entity ID, in the Data Mapper section of the Data Mapping, click Open Data Mapping Editor and then enter "20001" in the Input Value field and choose the EntityId as Local variable.

You must pass the entity ID directly, such as "20001". Here, "20001" is the unique primary key value, which is passed

You must use filter clause in queries where passing an Entity Id would thrown an error as there will be two composite keys, such as id='20001'

Example - Delete a user

1. In the Configure connector task dialog, click Entities.
2. Select Users from the Entity list.
3. Select the Delete operation, and then click Done.
4. Set the entity ID to "00ul7l5fdyTdHDfSj5d7" which is the Key to be passed.To set the entity ID, in the Data Mapper section of the Data Mapping, click Open Data Mapping Editor and then enter "20001" in the Input Value field and choose the EntityId as Local variable.

   If Entity has two composite Business or primary Keys instead of specifying the entityId, you can also set the filterClause to id='00ul7l5fdyTdHDfSj5d7'.

Example - Create a user

1. In the Configure connector task dialog, click Entities.
2. Select Users from the Entity list.
3. Select the Create operation, and then click Done.
4. In the Data Mapper section of the Data Mapping task, click Open Data Mapping Editor and then enter a value similar to the following in the Input Value field and choose the EntityId/ConnectorInputPayload as Local variable.

   { "ProfileFirstName": "Test",
       "ProfileLastName": "Test User",
       "ProfileEmail": "Test@gmail.com",
       "ProfileLogin": "Test11@example.com"
   }
   

   If the integration is successful, the Vendor task's connectorOutputPayload response parameter will have a value similar to the following:

   {
       "Id": "00ula502hjbwWYsO25d7"
   }
   

Example - Create a group

1. In the Configure connector task dialog, click Entities.
2. Select Groups from the Entity list.
3. Select the Create operation, and then click Done.
4. In the Data Mapper section of the Data Mapping task, click Open Data Mapping Editor and then enter a value similar to the following in the Input Value field and choose the EntityId/ConnectorInputPayload as Local variable.

   {
       "ProfileDescription": "Googlecloud group",
       "ProfileName": "Goolecloud created grp\n"
   }
   

   If the integration is successful, the APBill task's connectorOutputPayload response parameter will have a value similar to the following:

   {
       "Id": "00gl7lb5gniIAOMwA5d7"
   }
   

Example - Create an app

1. In the Configure connector task dialog, click Entities.
2. Select Apps from the Entity list.
3. Select the Create operation, and then click Done.
4. In the Data Mapper section of the Data Mapping task, click Open Data Mapping Editor and then enter a value similar to the following in the Input Value field and choose the EntityId/ConnectorInputPayload as Local variable.

   { "Label": "Googlecloud generated app",
       "SignOnMode": "AUTO_LOGIN",
       "AutoSubmitToolbar": false,
       "Settings": "{\"signOn\":{\"redirectUrl\":\"https://www.example.com\",\"loginUrl\":\"https://www.example.com\"}}"
   }
   

   This example will create the Vendtype. If the integration is successful, the Vendtype task's connectorOutputPayload response parameter will have a value similar to the following:

   {
       "Id": "0oal9vwooxEXXpdjS5d7"
   }
   

Example - Create a role

1. In the Configure connector task dialog, click Entities.
2. Select Roles from the Entity list.
3. Select the Create operation, and then click Done.
4. In the Data Mapper section of the Data Mapping task, click Open Data Mapping Editor and then enter a value similar to the following in the Input Value field and choose the EntityId/ConnectorInputPayload as Local variable.

   { "Label": "new role2", 
       "Description": "GABA Role1",
       "Permissions": "\"okta.users.read\", \"okta.groups.read\"" 
   }
   

   If the integration is successful, the Customer task's connectorOutputPayload response parameter will have a value similar to the following:

   {
       "Id": "cr0l824rbiTvtJDoi5d7"
   }
   

Example - Update a user

1. In the Configure connector task dialog, click Entities.
2. Select Users from the Entity list.
3. Select the Update operation, and then click Done.
4. In the Data Mapper section of the Data Mapping task, click Open Data Mapping Editor and then enter a value similar to the following in the Input Value field and choose the EntityId/ConnectorInputPayload/FilterClause as Local variable.

   {
       "ProfileFirstName": "ShubhGillL" 
   }
   

5. Set the entity ID in Data Mapper to the entity of the Users. To set the entity ID, click Open Data Mapping Editor and then enter a value similar to the following in the Input Value field and choose the EntityId/ConnectorInputPayload/FilterClause as Local variable.

   Instead of specifying the entityId, you can also set the filterClause to 20044.

   Running this example, returns a response similar to the following in the Connector task's connectorOutputPayload output variable:

   {
       "Id": "00ul7u8cyobt8SGRK5d7" 
   }
   

Example - Update a group

1. In the Configure connector task dialog, click Entities.
2. Select Groups from the Entity list.
3. Select the Update operation, and then click Done.
4. In the Data Mapper section of the Data Mapping task, click Open Data Mapping Editor and then enter a value similar to the following in the Input Value field and choose the EntityId/ConnectorInputPayload/FilterClause as Local variable.

   {
       "ProfileName": "Updated Googlecloud group"
   }
   

5. Set the entity ID in Data Mapper to the entity of the Groups. To set the entity ID, click Open Data Mapping Editor and then enter a value similar to the following in the Input Value field and choose the EntityId/ConnectorInputPayload/FilterClause as Local variable.

   Instead of specifying the entityId, you can also set the filterClause to 1371.

   Running this example, returns a response similar to the following in the Connector task's connectorOutputPayload output variable:

   {
       "Id": "00gl92veg4VSQQb5A5d7"
   }
   

Example - Update an app

1. In the Configure connector task dialog, click Entities.
2. Select Apps from the Entity list.
3. Select the Update operation, and then click Done.
4. In the Data Mapper section of the Data Mapping task, click Open Data Mapping Editor and then enter a value similar to the following in the Input Value field and choose the EntityId/ConnectorInputPayload/FilterClause as Local variable.

   {
       "Label": "Googlecloud updated label"
   }
   

5. Set the entity ID in Data Mapper to the entity of the Apps. To set the entity ID, click Open Data Mapping Editor and then enter a value similar to the following in the Input Value field and choose the EntityId/ConnectorInputPayload/FilterClause as Local variable.

   Instead of specifying the entityId, you can also set the filterClause to Customerid='10100'\n.

   Running this example, returns a response similar to the following in the Connector task's connectorOutputPayload output variable:

   {
       "Id": "0oal9vwooxEXXpdjS5d7"
   }
   

Example - Update a role

1. In the Configure connector task dialog, click Entities.
2. Select Roles from the Entity list.
3. Select the Update operation, and then click Done.
4. In the Data Mapper section of the Data Mapping task, click Open Data Mapping Editor and then enter a value similar to the following in the Input Value field and choose the EntityId/ConnectorInputPayload/FilterClause as Local variable.

   {
       "Label": "Googlecloud updated label"
   }
   

5. Set the entity ID in Data Mapper to the entity of the Roles. To set the entity ID, click Open Data Mapping Editor and then enter a value similar to the following in the Input Value field and choose the EntityId/ConnectorInputPayload/FilterClause as Local variable.

   Instead of specifying the entityId, you can also set the filterClause to 1.

   Running this example, returns a response similar to the following in the Connector task's connectorOutputPayload output variable:

   {
       "Id": "cr0l7dqeatRuIrn5x5d7"
   }