Okta Workflows

https://help.okta.com/wf/en-us/content/topics/workflows/
Admin
Okta Workflows is a platform that enables users to build, run, and manage custom automated flows...
Tokens:690,205
Snippets:7,336
Trust Score:10
Update:2 months ago
Show doc for...
Tokens:
Raw
### Helper Flow: Flow Started JSON

Source: https://help.okta.com/wf/en-us/content/topics/workflows/execute/log-streaming-schema.htm

Example JSON payload for a helper flow start event, including parent and root execution context.

```json
{
  "event_type": "FLOW_START",
  "execution_id": "538911d5-6234-4edc-9f24-38bb633a4574",
  "timestamp": "2024-04-04T18:58:15.861Z",
  "flow_id": "625207",
  "flow_name": "2. Simple Helper flow ",
  "org_id": "00o4mhtja45vHndwd0g7",
  "org_name": "logstream-01",
  "user_email": "j_xyht433h5oxg1qsdvi3hj_jmr0rpxkckkxw-uzsys",
  "parent_execution_id": "c0e2a040-9c6e-44fe-8c45-5b40dae3c4ab",
  "parent_flow_id": "0ff53d44-7c49-4dcd-ae8a-b16fc5a5a5d2",
  "parent_flow_name": "Flow 1: API Invoke Flow",
  "root_execution_id": "13881f3b-b0e0-4385-afca-7ad833e40c77",
  "root_flow_id": "543087",
  "folder_id_path": "",
  "folder_id": "",
  "engine_mode": "realtime",
  "idempotency_key": "23ac58e41d9b376f5fceb59881bd5c4",
  "throttled": false,
  "address": "root:kernel:control:0.0.1:callable"
}
```

--------------------------------

### Participants Configuration Example

Source: https://help.okta.com/wf/en-us/content/topics/workflows/connector-reference/opsgenie/actions/createschedulerotation.htm

Example JSON array defining the participants (escalations, users, teams, or none) for the schedule rotation.

```json
[
	{
		"type":"escalation",
		"id":"3f145401-e6f3-428f-9f3c-41b0e1d172d5",
		"name":"Team 2_escalation"
	},
	{
		"type":"user",
		"id":"d92b2aa1-4bc8-481b-a30e-4f19e5a27f83",
		"username":"johnathan.doe@okta.com"
	},
	{
		"type":"team",
		"id":"d00f95c1-2cce-4110-adbc-2ceca786c305",
		"username":"lily.doe@okta.com"
	},
	{
		"type":"none"
	}
]
```

--------------------------------

### PagerDuty User Object Output Example

Source: https://help.okta.com/wf/en-us/content/topics/workflows/connector-reference/pagerduty/actions/builduserobject.htm

Example of the JSON object structure returned by the Build User Object action.

```json
{
	"User ID":"PS79DJO",
	"Type":"user_reference"
}
```

--------------------------------

### Parent Flow: Flow Started JSON

Source: https://help.okta.com/wf/en-us/content/topics/workflows/execute/log-streaming-schema.htm

Example JSON payload for a parent flow start event.

```json
{
  "event_type": "FLOW_START",
  "execution_id": "326b7317-6ea5-4d6a-a9f5-0ee8675c0428",
  "timestamp": "2024-04-04T18:30:38.730Z",
  "flow_id": "632567",
  "flow_name": "PDV Log Streaming",
  "org_id": "00o4mhtja45vHndwd0g7",
  "org_name": "logstream-01",
  "user_email": "j_xyht433h5oxg1qsdvi3hj_jmr0rpxkckkxw-uzsys",
  "folder_id_path": "372061/378378",
  "folder_id": "378378",
  "engine_mode": "realtime",
  "idempotency_key": "67c775008e83c5205f1114a86bba2521",
  "throttled": false,
  "address": "root:kernel:string:0.0.1:compose"
}
```

--------------------------------

### Example output list from helper flow

Source: https://help.okta.com/wf/en-us/content/topics/workflows/learn/about-helper-flows.htm

The resulting list of objects after processing the input object through a helper flow.

```json
[
	{
		"propertyname":"custom:this",
                
		"propertyvalue":"that"
                
	},
                
	{
                
		"propertyname":"custom:up",
                
		"propertyvalue":"down"
                
	},
                
	{
                
		"propertyname":"custom:left",
                
		"propertyvalue":"right"
                
	}
]
```

--------------------------------

### Read Directory Roles JSON Output Example

Source: https://help.okta.com/wf/en-us/content/topics/workflows/connector-reference/azuread/actions/readdirectoryroles.htm

Example of the JSON object returned by the Read Directory Roles action.

```json
{
	"@odata.id": "https://graph.microsoft.com/v2/28d029a7-1d11-4ce0-85f5-d9502f2cd5b1/directoryObjects/06265c7a-1373-4033-8d26-3a9a04226e15/Microsoft.DirectoryServices.DirectoryRole",
	"id": "06265c7a-1373-4033-8d26-3a9a04226e15",
	"deletedDateTime": null,
	"description": "Can reset passwords for non-administrators and Helpdesk Administrators.",
	"displayName": "Helpdesk Administrator",
	"roleTemplateId": "729827e3-9c14-49f7-bb1b-9608f156bbb8"
}
```

--------------------------------

### Day and Time Restriction Example

Source: https://help.okta.com/wf/en-us/content/topics/workflows/connector-reference/opsgenie/actions/createschedulerotation.htm

Example JSON array for limiting schedule rotation based on specific days and times when 'Day and Time' is selected.

```json
[
	{
		"startDay":"monday",
		"endDay":"tuesday",
		"startHour":8,
		"endHour":18,
		"startMin":0,
		"endMin":30
	},
	{
		"startDay":"thursday",
		"endDay":"sunday",
		"startHour":6,
		"endHour":8,
		"startMin":0,
		"endMin":30
	}
]
```

--------------------------------

### Map to List Input Object Example

Source: https://help.okta.com/wf/en-us/content/topics/workflows/function-reference/object/object_map.htm

Example of an input object containing key-value pairs to be processed by the Map to List function.

```json
{ "this": "that", "up": "down", "left": "right" }
```

--------------------------------

### Example input object for helper flow

Source: https://help.okta.com/wf/en-us/content/topics/workflows/learn/about-helper-flows.htm

A simple JSON object used as input for a helper flow transformation.

```json
{"this":"that","up":"down","left":"right"}
```

--------------------------------

### Example JSON response structure

Source: https://help.okta.com/wf/en-us/content/topics/workflows/tutorials/processjson-walkthrough/processjson-walkthrough.htm

The JSON string returned from the Amazon Petstore API call used for manipulation in the workflow.

```json
[
	{
		"id": 4,
		"type": "Dog",
		"price": 999.99
	},
	{
		"id": 5,
		"type": "Dog",
		"price": 249.99
	},
	{
		"id": 6,
		"type": "Dog",
		"price": 49.97
	}
]
```

--------------------------------

### Split List Example Output

Source: https://help.okta.com/wf/en-us/content/topics/workflows/function-reference/list/list_split.htm

Shows the resulting two lists after splitting a list of six items at position 2.

```text
{Alan},
{Bob}
```

```text
{Charles},
{Alicia},
{Brittany},
{Catherine}
```

--------------------------------

### Input Object Structure

Source: https://help.okta.com/wf/en-us/content/topics/workflows/function-reference/object/object_pick.htm

Example of a JSON object structure used as input for the Get Multiple card.

```json
{
  "product": "a123",
  "parts": [
    {
      "partno": 12
    },
    {
      "partno": 16
    },
    {
      "partno": 27
    }
  ],
  "inventory": {
    "instock": 12,
    "ordered": 10
  }
}
```

--------------------------------

### GraphQL Query Example

Source: https://help.okta.com/wf/en-us/content/topics/workflows/connector-reference/mondaycom/actions/customapiaction.htm

Example of querying a user by ID using dynamic variables.

```json
Headers
     `{}` 

Query
     `query($my_user_id: Int!) { users(ids: [$my_user_id]) { id name }}` 

Variables
     `{ "my_user_id": 11111111 }`
```

--------------------------------

### Input List of Objects

Source: https://help.okta.com/wf/en-us/content/topics/workflows/function-reference/list/list_uniqueby.htm

An example input list containing objects with name and value properties.

```json
[
  {
    "name": "Nicole",
    "value": 10
  },
  {
    "name": "Sarah",
    "value": 20
  },
  {
    "name": "Emily",
    "value": 10
  }
]
```

--------------------------------

### Restriction Object JSON Example

Source: https://help.okta.com/wf/en-us/content/topics/workflows/connector-reference/pagerduty/actions/buildrestrictionobject.htm

An example of the resulting restriction object structure produced by the action.

```json
{
	"Type":"daily_restriction",
	"Duration Seconds":3600,
	"Start Time Of Day":"12:31:23Z",
	"Start Day Of Week":null}
```

--------------------------------

### Create Project

Source: https://help.okta.com/wf/en-us/content/topics/workflows/connector-reference/advancedserveraccess/actions/createproject.htm

Creates a new Advanced Server Access project using the specified configuration parameters.

```APIDOC
## Create Project

### Description
Creates a new Advanced Server Access project. The action returns all project properties upon successful creation.

### Input Parameters
- **Project Name** (Text) - Required - Specifies the project name.
- **Create Server users** (True/False) - Optional - Specifies whether to create Server Users for Advanced Server Access Users in this Project. Defaults to false.
- **Forward Traffic** (True/False) - Optional - Whether to require that all traffic in the Project be forwarded through selected Gateways.
- **Next Unix GroupID** (Number) - Optional - The GID to use when creating a new server user.
- **Next Unix UserID** (Number) - Optional - The UID to use when creating a new server user. Must be over 100.
- **Require Preauth For Creds** (True/False) - Optional - Whether to require preauthorization before an Advanced Server Access User can retrieve credentials to sign in. Default is false.
- **SSH Session Recording** (True/False) - Optional - Whether to enable ssh recording on all Servers in this Project. Default is false.

### Output
- **Name** (Text) - Name of the new project.
- **ID** (Text) - Unique identifier for the new project.
- **Create Server Users** (True/False) - Status of the Create Server Users property.
- **Deleted At** (Date & Time) - Mandatory field returned by the ASA API.
- **Force Shared SSH Users** (True/False) - Status of the Force Shared SSH Users property.
- **Forward Traffic** (True/False) - Status of the Forward Traffic property.
- **Next Unix GID** (Number) - Value of the Next Unix GroupID property.
- **Next Unix UID** (Number) - Value of the Next Unix UserID property.
- **Require Preauth for Creds** (True/False) - Status of the Require Preauth for Creds property.
- **Shared Admin User Name** (Text) - Value of the Shared Admin User Name property.
- **Shared Standard User Name** (Text) - Value of the Shared Standard User Name property.
- **SSH Session Recording** (True/False) - Value of the SSH Session Recording property.
```

--------------------------------

### Time Restriction Object Examples

Source: https://help.okta.com/wf/en-us/content/topics/workflows/connector-reference/opsgenie/actions/buildtimerestrictionsobject.htm

Examples of the JSON structure for time-only and day-and-time restriction objects.

```json
{
	"startHour": 5
	"startMin": 30
	"endHour": 16
	"endMin": 0
}
```

```json
[
	{
		"startDay":"monday",
		"endDay":"tuesday",
		"startHour":8,
		"endHour":18,
		"startMin":0,
		"endMin":30
	},
	{
		"startDay":"thursday",
		"endDay":"sunday",
		"startHour":6,
		"endHour":8,
		"startMin":0,
		"endMin":30
	}
]
```

--------------------------------

### Extension Attribute Response Example

Source: https://help.okta.com/wf/en-us/content/topics/workflows/connector-reference/jamf/actions/readuser.htm

Example of an extension attribute object returned in the response list.

```json
{
"extension_attribute": 
	{
	"name": "FirstExtension",
	"value": "TestAttribute"
	}
}
```

--------------------------------

### Collapse Input and Output Example

Source: https://help.okta.com/wf/en-us/content/topics/workflows/function-reference/object/object_collapse.htm

Demonstrates the transformation of two key-value objects into a single collapsed JSON object.

```json
{
    "key":  "foo",
    "value": "bar"
}
{
    "key":  "baz",
    "value": "taz"
}
```

```json
{"foo":"bar","baz":"taz"}
```

--------------------------------

### GET

Source: https://help.okta.com/wf/en-us/content/topics/workflows/function-reference/http/http_get.htm

Performs an API Connector GET request, returning the result of the request and response headers.

```APIDOC
## GET

### Description
Performs an API Connector GET request to a specified URL. The function returns the response body, headers, and status code. Note that GET does not support body inputs.

### Parameters
#### Input
- **URL** (text) - Required - The URL for the API Connector GET request.
- **headers** (Section) - Optional - Key-value pairs for request headers.
- **query** (Section) - Optional - Key-value pairs for query string parameters.

### Output
- **statusCode** (Number) - The HTTP status code associated with the request.
- **body** (Section) - The response body content.
- **headers** (Section) - The response headers.
```

--------------------------------

### HMAC Function Example

Source: https://help.okta.com/wf/en-us/content/topics/workflows/function-reference/encryption/encryption_hmac.htm

Example configuration for generating a SHA256 hash with a secret key and Base64 output.

```text
Input
  * algorithm: `sha256`
  * key: `my secret key`
  * data: `My secret message!`
  * digest: `base64`


Output
`qd83l7nEE4gBpuaueA+XtKFeZO99aV7IvGgsJ15qmyo=`
```

--------------------------------

### Combine All Output Example

Source: https://help.okta.com/wf/en-us/content/topics/workflows/function-reference/list/list_concat.htm

Shows the resulting list structure when concatenating two lists containing three items each.

```text
{Alan},
{Bob},
{Charles},
{Alicia},
{Brittany},
{Catherine},
```

--------------------------------

### Create Server Enrollment Token for Project

Source: https://help.okta.com/wf/en-us/content/topics/workflows/connector-reference/advancedserveraccess/actions/createserverenrollmenttokenforproject.htm

Creates a new server enrollment token for a specified Advanced Server Access project.

```APIDOC
## Create Server Enrollment Token for Project

### Description
Creates a server enrollment token for an Advanced Server Access project. These tokens are used to enroll a server in a specific project in Advanced Server Access.

### Parameters
#### Input
- **Project Name** (Text) - Required - Target project to create the enrollment token.
- **Description** (Text) - Optional - Description for the enrollment token.

### Response
#### Output
- **ID** (Text) - Unique ID of the enrollment token.
- **Token** (Text) - Token attribute of the returned JSON object.
- **Created By User** (Text) - User who created the server enrollment token.
- **Issued At** (Date & Time) - Date and time when the server enrollment token was issued.
- **Description** (Text) - Description for the enrollment token.
```

--------------------------------

### Charkey output example

Source: https://help.okta.com/wf/en-us/content/topics/workflows/function-reference/xml/xml_parse.htm

Example showing how the charkey option affects the structure of an XML element when explicitCharkey is enabled.

```json
"ARTIST": [
        "The Men"
      ],
```

```json
"ARTIST": [
        {
          "_": "The Men"
        }
      ],
```

--------------------------------

### List Server Enrollment Tokens

Source: https://help.okta.com/wf/en-us/content/topics/workflows/connector-reference/advancedserveraccess/actions/listserverenrollmenttokenswithinaproject.htm

Retrieves a list of server enrollment tokens for a specified project.

```APIDOC
## List Server Enrollment Tokens

### Description
Retrieves a list of server enrollment tokens and related metadata associated with a specific Advanced Server Access project.

### Parameters
#### Input
- **Project Name** (Text) - Required - Target project to whose enrollment token is returned.

### Response
- **Server Enrollment Tokens** (List of Objects) - List of objects of server enrollment tokens and related metadata that are associated with a project.
```

--------------------------------

### Example JWT Header Output

Source: https://help.okta.com/wf/en-us/content/topics/workflows/function-reference/jwt/jwt_decode.htm

An example of the JSON structure returned in the header output field of the Decode function.

```json
{
	"typ":"JWT",
	"alg":"HS256"
}
```

--------------------------------

### Split Function Input and Output

Source: https://help.okta.com/wf/en-us/content/topics/workflows/function-reference/object/object_split.htm

Example showing the transformation of a JSON object into a list of key-value pair objects.

```json
{
  "name": "Jessie Doe",
  "empno": "C45X13"
}
```

```json
[
  {
    "key": "name",
    "value": "Jessie Doe"
  },
  {
    "key": "empno",
    "value": "C45X13"
  }
]
```

--------------------------------

### Combined Filter Group Example

Source: https://help.okta.com/wf/en-us/content/topics/workflows/connector-reference/hubspotcrm/actions/searchcontacts.htm

Example of multiple entries in a filter group combined using a logical AND operator.

```json
{
    "propertyName": "associations.company",
    "operator": "EQ",
    "value": "Example"
},
{
    "propertyName": "associations.contact",
    "operator": "EQ",
    "value": "123"
},
{
    "propertyName": "associations.deal",
    "operator": "EQ",
    "value": "456"
}
```

--------------------------------

### Example of supported schema type and item

Source: https://help.okta.com/wf/en-us/content/topics/workflows/connector-reference/jiraservicedesk/overviews/custom-fields.htm

JSON structure demonstrating a field with a supported schema type and item.

```json
{

 "id": "customfield_107",

 "key": "customfield_107",

 "name": "Approvers",

 ...

 "schema": {

   "type": "array",

   "items": "user",

   "custom": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker",

   "customId": 107

 }

}
```

--------------------------------

### HTTP GET Request

Source: https://help.okta.com/wf/en-us/content/topics/workflows/function-reference/functions.htm

Performs an HTTP GET request to a specified URL, returning the response body and headers.

```APIDOC
## GET API Connector

### Description
Performs an HTTP GET request, returning the result of this request and the response headers.

### Parameters
- **URL** (string) - Required - The endpoint URL to request.
- **auth** (object) - Optional - Authentication details.
- **header** (object) - Optional - Request headers.
- **query** (object) - Optional - Query parameters.

### Response
- **headers** (object) - The response headers.
- **output** (object) - The response body.
```

--------------------------------

### Create User

Source: https://help.okta.com/wf/en-us/content/topics/workflows/connector-reference/netskope/actions/createuser.htm

Creates a new user in the Netskope environment.

```APIDOC
## Create User

### Description
Creates a new user in your Netskope environment.

### Parameters
#### Request Body
- **User Name** (Text) - Required - Username of the user.
- **Primary Email** (Text) - Required - The primary email address of the user.
- **External ID** (Text) - Optional - The external identifier of the user.
- **Is Active** (True/False) - Optional - If true, the user is active.
- **Given Name** (Text) - Optional - Given name of the user.
- **Family Name** (Text) - Optional - Last name of the user.
- **Display Name** (Text) - Optional - Name displayed for the user.
- **Title** (Text) - Optional - The user's job title.
- **User Type** (Text) - Optional - The user's type or classification.
- **Preferred Language** (Dropdown) - Optional - The user's preferred language for communication.
- **Locale** (Dropdown) - Optional - The user's preferred language and region.
- **Timezone** (Dropdown) - Optional - The user's preferred time zone.
- **Employee Number** (Text) - Optional - The user's organization or company-assigned unique identifier.
- **Cost Center** (Text) - Optional - The name of the cost center that's assigned to the user.
- **Organization** (Text) - Optional - The name of the user's organization.
- **Division** (Text) - Optional - The name of the user's division.
- **Department** (Text) - Optional - The name of the user's department.
- **Manager ID** (Text) - Optional - The unique identifier of the user's manager.

### Response
- **ID** (Text) - Unique identifier of the user.
- **External ID** (Text) - The external identifier of the user.
- **User Name** (Text) - Username of the user.
- **Primary Email** (Text) - The primary email address of the user.
- **Emails** (List of Objects) - List of email objects.
- **Is Active** (True/False) - If true, the user is active.
- **Given Name** (Text) - Given name of the user.
- **Family Name** (Text) - Last name of the user.
- **Display Name** (Text) - Name displayed for the user.
- **Title** (Text) - The user's job title.
- **User Type** (Text) - The user's type or classification.
- **Preferred Language** (Text) - The user's preferred language.
- **Locale** (Text) - The user's preferred language and region.
- **Timezone** (Text) - The user's preferred time zone.
- **Employee Number** (Text) - The user's organization or company-assigned unique identifier.
- **Cost Center** (Text) - The name of the cost center assigned to the user.
- **Organization** (Text) - The name of the user's organization.
- **Division** (Text) - The name of the user's division.
- **Department** (Text) - The name of the user's department.
- **Manager** (Object) - Object containing manager ID and display name.
- **Record Source** (Text) - The record origin (always 'SCIM').
- **Custom Attributes** (Object) - User-defined custom fields.
```

--------------------------------

### Format

Source: https://help.okta.com/wf/en-us/content/topics/workflows/function-reference/url/url_format.htm

Constructs a URL string from individual components.

```APIDOC
## Format

### Description
Constructs a URL string from individual components.

### Parameters
- **protocol** (Text) - Optional - The URL protocol field (e.g., http or https).
- **host** (Text) - Required - The fully qualified domain name.
- **port** (Number) - Optional - The port number (e.g., 80 or 443).
- **path** (Text) - Optional - The resource path within the host.
- **query** (Text) - Optional - The query string, without the ? question mark.

### Response
- **url** (Text) - The formatted URL value.
```

--------------------------------

### Time Only Restriction Example

Source: https://help.okta.com/wf/en-us/content/topics/workflows/connector-reference/opsgenie/actions/createschedulerotation.htm

Example JSON structure for limiting schedule rotation to specific hours and minutes when 'Time Only' is selected.

```json
{
	"startHour": 5
	"startMin": 30
	"endHour": 16
	"endMin": 0
}
```
Tokens:
Raw