Skip to content

Commit 2aca241

Browse files
waleedlatif1waleedlatif1
committed
fix(okta): paginate the legacy list tools with the Link-header cursor
1 parent dd97063 commit 2aca241

11 files changed

Lines changed: 96 additions & 63 deletions

File tree

‎apps/docs/content/docs/en/integrations/netsuite.mdx‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ description: Manage NetSuite records, queries, datasets, batches, and async jobs
55

66
import { BlockInfoCard } from "@/components/ui/block-info-card"
77

8-
<BlockInfoCard
8+
<BlockInfoCard
99
type="netsuite"
1010
color="#FFFFFF"
1111
/>
@@ -651,3 +651,5 @@ Retrieve REST web-services concurrency limits for the NetSuite account and integ
651651
| ↳ `accountUnallocatedConcurrencyLimit` | number | Account concurrency not allocated to integrations |
652652
| ↳ `integrationConcurrencyLimit` | number | Concurrency allocated to this integration |
653653
| ↳ `integrationLimitType` | string | Limit assignment: integrationSpecific, accountLimit, or internal |
654+
655+

‎apps/docs/content/docs/en/integrations/okta.mdx‎

Lines changed: 12 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,8 @@ List all users in your Okta organization with optional search and filtering
5050
| `domain` | string | Yes | Okta domain \(e.g., dev-123456.okta.com\) |
5151
| `search` | string | No | Okta search expression \(e.g., profile.firstName eq "John" or profile.email co "example.com"\) |
5252
| `filter` | string | No | Okta filter expression \(e.g., status eq "ACTIVE"\) |
53-
| `limit` | number | No | Maximum number of users to return \(default: 200, max: 200\) |
53+
| `after` | string | No | Opaque pagination cursor returned as nextCursor by a previous call |
54+
| `limit` | number | No | Maximum number of users to return per page \(default: 200\) |
5455

5556
#### Output
5657

@@ -72,6 +73,8 @@ List all users in your Okta organization with optional search and filtering
7273
| ↳ `activated` | string | Activation timestamp |
7374
| ↳ `statusChanged` | string | Status change timestamp |
7475
| `count` | number | Number of users returned |
76+
| `nextCursor` | string | Cursor for the next page, or null on the last page |
77+
| `hasMore` | boolean | Whether more users are available |
7578
| `success` | boolean | Operation success status |
7679

7780
### Get User from Okta
@@ -320,7 +323,8 @@ List all groups in your Okta organization with optional search and filtering
320323
| `domain` | string | Yes | Okta domain \(e.g., dev-123456.okta.com\) |
321324
| `search` | string | No | Okta search expression for groups \(e.g., profile.name sw "Engineering" or type eq "OKTA_GROUP"\) |
322325
| `filter` | string | No | Okta filter expression \(e.g., type eq "OKTA_GROUP"\) |
323-
| `limit` | number | No | Maximum number of groups to return \(default: 10000, max: 10000\) |
326+
| `after` | string | No | Opaque pagination cursor returned as nextCursor by a previous call |
327+
| `limit` | number | No | Maximum number of groups to return per page \(max: 10000\) |
324328

325329
#### Output
326330

@@ -335,6 +339,8 @@ List all groups in your Okta organization with optional search and filtering
335339
| ↳ `lastUpdated` | string | Last update timestamp |
336340
| ↳ `lastMembershipUpdated` | string | Last membership change timestamp |
337341
| `count` | number | Number of groups returned |
342+
| `nextCursor` | string | Cursor for the next page, or null on the last page |
343+
| `hasMore` | boolean | Whether more groups are available |
338344
| `success` | boolean | Operation success status |
339345

340346
### Get Group from Okta
@@ -490,7 +496,8 @@ List all members of a specific group in your Okta organization
490496
| `apiKey` | string | Yes | Okta API token for authentication |
491497
| `domain` | string | Yes | Okta domain \(e.g., dev-123456.okta.com\) |
492498
| `groupId` | string | Yes | Group ID to list members for |
493-
| `limit` | number | No | Maximum number of members to return \(default: 1000, max: 1000\) |
499+
| `after` | string | No | Opaque pagination cursor returned as nextCursor by a previous call |
500+
| `limit` | number | No | Maximum number of members to return per page \(max: 1000\) |
494501

495502
#### Output
496503

@@ -512,6 +519,8 @@ List all members of a specific group in your Okta organization
512519
| ↳ `activated` | string | Activation timestamp |
513520
| ↳ `statusChanged` | string | Status change timestamp |
514521
| `count` | number | Number of members returned |
522+
| `nextCursor` | string | Cursor for the next page, or null on the last page |
523+
| `hasMore` | boolean | Whether more members are available |
515524
| `success` | boolean | Operation success status |
516525

517526
### List Group Rules from Okta

‎apps/docs/content/docs/en/integrations/snowflake.mdx‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ description: Query data and manage warehouses and tasks in Snowflake
55

66
import { BlockInfoCard } from "@/components/ui/block-info-card"
77

8-
<BlockInfoCard
8+
<BlockInfoCard
99
type="snowflake"
1010
color="#FFFFFF"
1111
/>
@@ -1316,3 +1316,5 @@ Call a stored procedure with explicitly typed Snowflake bindings.
13161316
| ↳ `rowsDeleted` | number | Rows deleted by the statement |
13171317
| ↳ `duplicateRowsUpdated` | number | Duplicate rows updated by the statement |
13181318
| ↳ `rowsAffected` | number | Total inserted, updated, and deleted rows |
1319+
1320+

‎apps/docs/content/docs/en/integrations/zoho_desk.mdx‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ description: Manage Zoho Desk tickets, comments, threads, and contacts
55

66
import { BlockInfoCard } from "@/components/ui/block-info-card"
77

8-
<BlockInfoCard
8+
<BlockInfoCard
99
type="zoho_desk"
1010
color="#FFFFFF"
1111
/>
@@ -522,3 +522,4 @@ Trigger a workflow when a Zoho Desk event occurs (ticket, comment, thread, conta
522522
| `orgId` | string | Zoho Desk organization ID |
523523
| `payload` | json | The full resource that changed \(ticket, comment, thread, etc.\). Comment and thread events gain a derived plain-text `contentText` alongside the raw `content` + `contentType`; ticket events gain `descriptionText` alongside `description`. |
524524
| `prevState` | json | Previous state of the resource \(update events only\) |
525+

‎apps/sim/blocks/blocks/okta.ts‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -816,6 +816,9 @@ export const OktaBlock: BlockConfig<OktaResponse> = {
816816
condition: {
817817
field: 'operation',
818818
value: [
819+
'okta_list_users',
820+
'okta_list_groups',
821+
'okta_list_group_members',
819822
'okta_get_logs',
820823
'okta_list_apps',
821824
'okta_list_app_users',

‎apps/sim/tools/generated/tool-metadata.ts‎

Lines changed: 1 addition & 1 deletion
Large diffs are not rendered by default.

‎apps/sim/tools/generated/tool-outputs.ts‎

Lines changed: 1 addition & 1 deletion
Large diffs are not rendered by default.

‎apps/sim/tools/okta/list_group_members.ts‎

Lines changed: 20 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
import { createLogger } from '@sim/logger'
22
import { validateOktaDomain } from '@/lib/core/security/input-validation'
33
import type {
4-
OktaApiError,
54
OktaListGroupMembersParams,
65
OktaListGroupMembersResponse,
76
OktaUser,
87
} from '@/tools/okta/types'
8+
import { oktaHeaders, parseOktaPagination, throwOktaError } from '@/tools/okta/utils'
99
import type { ToolConfig } from '@/tools/types'
1010

1111
const logger = createLogger('OktaListGroupMembers')
@@ -38,11 +38,17 @@ export const oktaListGroupMembersTool: ToolConfig<
3838
visibility: 'user-or-llm',
3939
description: 'Group ID to list members for',
4040
},
41+
after: {
42+
type: 'string',
43+
required: false,
44+
visibility: 'user-or-llm',
45+
description: 'Opaque pagination cursor returned as nextCursor by a previous call',
46+
},
4147
limit: {
4248
type: 'number',
4349
required: false,
4450
visibility: 'user-or-llm',
45-
description: 'Maximum number of members to return (default: 1000, max: 1000)',
51+
description: 'Maximum number of members to return per page (max: 1000)',
4652
},
4753
},
4854

@@ -51,32 +57,23 @@ export const oktaListGroupMembersTool: ToolConfig<
5157
const domain = validateOktaDomain(params.domain)
5258
const queryParams = new URLSearchParams()
5359

60+
if (params.after) queryParams.append('after', params.after)
5461
if (params.limit) queryParams.append('limit', params.limit.toString())
5562

5663
const queryString = queryParams.toString()
5764
const base = `https://${domain}/api/v1/groups/${encodeURIComponent(params.groupId.trim())}/users`
5865
return queryString ? `${base}?${queryString}` : base
5966
},
6067
method: 'GET',
61-
headers: (params) => ({
62-
Authorization: `SSWS ${params.apiKey}`,
63-
Accept: 'application/json',
64-
'Content-Type': 'application/json',
65-
}),
68+
headers: (params) => oktaHeaders(params.apiKey),
6669
},
6770

6871
transformResponse: async (response: Response) => {
6972
if (!response.ok) {
70-
let error: OktaApiError = {}
71-
try {
72-
error = await response.json()
73-
} catch {
74-
// non-JSON error body
75-
}
76-
logger.error('Okta API request failed', { data: error, status: response.status })
77-
throw new Error(error.errorSummary || 'Failed to list group members from Okta')
73+
await throwOktaError(response, logger, 'Failed to list group members from Okta')
7874
}
7975

76+
const { nextCursor, hasMore } = parseOktaPagination(response)
8077
const data: OktaUser[] = await response.json()
8178

8279
const members = data.map((user) => ({
@@ -101,6 +98,8 @@ export const oktaListGroupMembersTool: ToolConfig<
10198
output: {
10299
members,
103100
count: members.length,
101+
nextCursor,
102+
hasMore,
104103
success: true,
105104
},
106105
}
@@ -135,6 +134,12 @@ export const oktaListGroupMembersTool: ToolConfig<
135134
},
136135
},
137136
count: { type: 'number', description: 'Number of members returned' },
137+
nextCursor: {
138+
type: 'string',
139+
description: 'Cursor for the next page, or null on the last page',
140+
optional: true,
141+
},
142+
hasMore: { type: 'boolean', description: 'Whether more members are available' },
138143
success: { type: 'boolean', description: 'Operation success status' },
139144
},
140145
}

‎apps/sim/tools/okta/list_groups.ts‎

Lines changed: 21 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,7 @@
11
import { createLogger } from '@sim/logger'
22
import { validateOktaDomain } from '@/lib/core/security/input-validation'
3-
import type {
4-
OktaApiError,
5-
OktaGroup,
6-
OktaListGroupsParams,
7-
OktaListGroupsResponse,
8-
} from '@/tools/okta/types'
3+
import type { OktaGroup, OktaListGroupsParams, OktaListGroupsResponse } from '@/tools/okta/types'
4+
import { oktaHeaders, parseOktaPagination, throwOktaError } from '@/tools/okta/utils'
95
import type { ToolConfig } from '@/tools/types'
106

117
const logger = createLogger('OktaListGroups')
@@ -42,11 +38,17 @@ export const oktaListGroupsTool: ToolConfig<OktaListGroupsParams, OktaListGroups
4238
visibility: 'user-or-llm',
4339
description: 'Okta filter expression (e.g., type eq "OKTA_GROUP")',
4440
},
41+
after: {
42+
type: 'string',
43+
required: false,
44+
visibility: 'user-or-llm',
45+
description: 'Opaque pagination cursor returned as nextCursor by a previous call',
46+
},
4547
limit: {
4648
type: 'number',
4749
required: false,
4850
visibility: 'user-or-llm',
49-
description: 'Maximum number of groups to return (default: 10000, max: 10000)',
51+
description: 'Maximum number of groups to return per page (max: 10000)',
5052
},
5153
},
5254

@@ -57,6 +59,7 @@ export const oktaListGroupsTool: ToolConfig<OktaListGroupsParams, OktaListGroups
5759

5860
if (params.search) queryParams.append('search', params.search)
5961
if (params.filter) queryParams.append('filter', params.filter)
62+
if (params.after) queryParams.append('after', params.after)
6063
if (params.limit) queryParams.append('limit', params.limit.toString())
6164

6265
const queryString = queryParams.toString()
@@ -65,25 +68,15 @@ export const oktaListGroupsTool: ToolConfig<OktaListGroupsParams, OktaListGroups
6568
: `https://${domain}/api/v1/groups`
6669
},
6770
method: 'GET',
68-
headers: (params) => ({
69-
Authorization: `SSWS ${params.apiKey}`,
70-
Accept: 'application/json',
71-
'Content-Type': 'application/json',
72-
}),
71+
headers: (params) => oktaHeaders(params.apiKey),
7372
},
7473

7574
transformResponse: async (response: Response) => {
7675
if (!response.ok) {
77-
let error: OktaApiError = {}
78-
try {
79-
error = await response.json()
80-
} catch {
81-
// non-JSON error body
82-
}
83-
logger.error('Okta API request failed', { data: error, status: response.status })
84-
throw new Error(error.errorSummary || 'Failed to list groups from Okta')
76+
await throwOktaError(response, logger, 'Failed to list groups from Okta')
8577
}
8678

79+
const { nextCursor, hasMore } = parseOktaPagination(response)
8780
const data: OktaGroup[] = await response.json()
8881

8982
const groups = data.map((group) => ({
@@ -101,6 +94,8 @@ export const oktaListGroupsTool: ToolConfig<OktaListGroupsParams, OktaListGroups
10194
output: {
10295
groups,
10396
count: groups.length,
97+
nextCursor,
98+
hasMore,
10499
success: true,
105100
},
106101
}
@@ -128,6 +123,12 @@ export const oktaListGroupsTool: ToolConfig<OktaListGroupsParams, OktaListGroups
128123
},
129124
},
130125
count: { type: 'number', description: 'Number of groups returned' },
126+
nextCursor: {
127+
type: 'string',
128+
description: 'Cursor for the next page, or null on the last page',
129+
optional: true,
130+
},
131+
hasMore: { type: 'boolean', description: 'Whether more groups are available' },
131132
success: { type: 'boolean', description: 'Operation success status' },
132133
},
133134
}

‎apps/sim/tools/okta/list_users.ts‎

Lines changed: 21 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,7 @@
11
import { createLogger } from '@sim/logger'
22
import { validateOktaDomain } from '@/lib/core/security/input-validation'
3-
import type {
4-
OktaApiError,
5-
OktaListUsersParams,
6-
OktaListUsersResponse,
7-
OktaUser,
8-
} from '@/tools/okta/types'
3+
import type { OktaListUsersParams, OktaListUsersResponse, OktaUser } from '@/tools/okta/types'
4+
import { oktaHeaders, parseOktaPagination, throwOktaError } from '@/tools/okta/utils'
95
import type { ToolConfig } from '@/tools/types'
106

117
const logger = createLogger('OktaListUsers')
@@ -42,11 +38,17 @@ export const oktaListUsersTool: ToolConfig<OktaListUsersParams, OktaListUsersRes
4238
visibility: 'user-or-llm',
4339
description: 'Okta filter expression (e.g., status eq "ACTIVE")',
4440
},
41+
after: {
42+
type: 'string',
43+
required: false,
44+
visibility: 'user-or-llm',
45+
description: 'Opaque pagination cursor returned as nextCursor by a previous call',
46+
},
4547
limit: {
4648
type: 'number',
4749
required: false,
4850
visibility: 'user-or-llm',
49-
description: 'Maximum number of users to return (default: 200, max: 200)',
51+
description: 'Maximum number of users to return per page (default: 200)',
5052
},
5153
},
5254

@@ -57,6 +59,7 @@ export const oktaListUsersTool: ToolConfig<OktaListUsersParams, OktaListUsersRes
5759

5860
if (params.search) queryParams.append('search', params.search)
5961
if (params.filter) queryParams.append('filter', params.filter)
62+
if (params.after) queryParams.append('after', params.after)
6063
if (params.limit) queryParams.append('limit', params.limit.toString())
6164

6265
const queryString = queryParams.toString()
@@ -65,25 +68,15 @@ export const oktaListUsersTool: ToolConfig<OktaListUsersParams, OktaListUsersRes
6568
: `https://${domain}/api/v1/users`
6669
},
6770
method: 'GET',
68-
headers: (params) => ({
69-
Authorization: `SSWS ${params.apiKey}`,
70-
Accept: 'application/json',
71-
'Content-Type': 'application/json',
72-
}),
71+
headers: (params) => oktaHeaders(params.apiKey),
7372
},
7473

7574
transformResponse: async (response: Response) => {
7675
if (!response.ok) {
77-
let error: OktaApiError = {}
78-
try {
79-
error = await response.json()
80-
} catch {
81-
// non-JSON error body
82-
}
83-
logger.error('Okta API request failed', { data: error, status: response.status })
84-
throw new Error(error.errorSummary || 'Failed to list users from Okta')
76+
await throwOktaError(response, logger, 'Failed to list users from Okta')
8577
}
8678

79+
const { nextCursor, hasMore } = parseOktaPagination(response)
8780
const data: OktaUser[] = await response.json()
8881

8982
const users = data.map((user) => ({
@@ -108,6 +101,8 @@ export const oktaListUsersTool: ToolConfig<OktaListUsersParams, OktaListUsersRes
108101
output: {
109102
users,
110103
count: users.length,
104+
nextCursor,
105+
hasMore,
111106
success: true,
112107
},
113108
}
@@ -141,6 +136,12 @@ export const oktaListUsersTool: ToolConfig<OktaListUsersParams, OktaListUsersRes
141136
},
142137
},
143138
count: { type: 'number', description: 'Number of users returned' },
139+
nextCursor: {
140+
type: 'string',
141+
description: 'Cursor for the next page, or null on the last page',
142+
optional: true,
143+
},
144+
hasMore: { type: 'boolean', description: 'Whether more users are available' },
144145
success: { type: 'boolean', description: 'Operation success status' },
145146
},
146147
}

0 commit comments

Comments
 (0)