Skip to content

doc updates #7

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jeffreyaven merged 1 commit into from
Sep 12, 2025
Merged

doc updates #7

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions package-lock.json
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
},
"dependencies": {
"@stackql/pgwire-lite": "^1.0.1",
"@stackql/provider-utils": "^0.4.2"
"@stackql/provider-utils": "^0.4.6"
},
"keywords": [
"stackql",
Expand Down
6 changes: 4 additions & 2 deletions website/docs/services/agentpools/agent_pool_update_settings/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -163,7 +163,8 @@ poolId,
poolName,
releaseChannel
FROM okta.agentpools.agent_pool_update_settings
WHERE subdomain = '{{ subdomain }}' -- required;
WHERE subdomain = '{{ subdomain }}' -- required
;
```
</TabItem>
</Tabs>
Expand Down Expand Up @@ -199,7 +200,8 @@ latestVersion,
minimalSupportedVersion,
poolId,
poolName,
releaseChannel;
releaseChannel
;
```
</TabItem>
</Tabs>
30 changes: 20 additions & 10 deletions website/docs/services/agentpools/agent_pool_updates/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -338,7 +338,8 @@ status,
targetVersion
FROM okta.agentpools.agent_pool_updates
WHERE subdomain = '{{ subdomain }}' -- required
AND scheduled = '{{ scheduled }}';
AND scheduled = '{{ scheduled }}'
;
```
</TabItem>
<TabItem value="get_agent_pools_update_instance">
Expand All @@ -360,7 +361,8 @@ sortOrder,
status,
targetVersion
FROM okta.agentpools.agent_pool_updates
WHERE subdomain = '{{ subdomain }}' -- required;
WHERE subdomain = '{{ subdomain }}' -- required
;
```
</TabItem>
</Tabs>
Expand Down Expand Up @@ -523,7 +525,8 @@ reason,
schedule,
sortOrder,
status,
targetVersion;
targetVersion
;
```
</TabItem>
</Tabs>
Expand All @@ -543,7 +546,8 @@ Deletes agent pool update

```sql
DELETE FROM okta.agentpools.agent_pool_updates
WHERE subdomain = '{{ subdomain }}' --required;
WHERE subdomain = '{{ subdomain }}' --required
;
```
</TabItem>
</Tabs>
Expand All @@ -568,7 +572,8 @@ Activates a scheduled agent pool update

```sql
EXEC okta.agentpools.agent_pool_updates.activate_agent_pools_update
@subdomain='{{ subdomain }}' --required;
@subdomain='{{ subdomain }}' --required
;
```
</TabItem>
<TabItem value="deactivate_agent_pools_update">
Expand All @@ -577,7 +582,8 @@ Deactivates scheduled agent pool update

```sql
EXEC okta.agentpools.agent_pool_updates.deactivate_agent_pools_update
@subdomain='{{ subdomain }}' --required;
@subdomain='{{ subdomain }}' --required
;
```
</TabItem>
<TabItem value="pause_agent_pools_update">
Expand All @@ -586,7 +592,8 @@ Pauses a running or queued agent pool update

```sql
EXEC okta.agentpools.agent_pool_updates.pause_agent_pools_update
@subdomain='{{ subdomain }}' --required;
@subdomain='{{ subdomain }}' --required
;
```
</TabItem>
<TabItem value="resume_agent_pools_update">
Expand All @@ -595,7 +602,8 @@ Resumes a running or queued agent pool update

```sql
EXEC okta.agentpools.agent_pool_updates.resume_agent_pools_update
@subdomain='{{ subdomain }}' --required;
@subdomain='{{ subdomain }}' --required
;
```
</TabItem>
<TabItem value="retry_agent_pools_update">
Expand All @@ -604,7 +612,8 @@ Retries an agent pool update if the update is unsuccessful or communication with

```sql
EXEC okta.agentpools.agent_pool_updates.retry_agent_pools_update
@subdomain='{{ subdomain }}' --required;
@subdomain='{{ subdomain }}' --required
;
```
</TabItem>
<TabItem value="stop_agent_pools_update">
Expand All @@ -613,7 +622,8 @@ Stops an agent pool update

```sql
EXEC okta.agentpools.agent_pool_updates.stop_agent_pools_update
@subdomain='{{ subdomain }}' --required;
@subdomain='{{ subdomain }}' --required
;
```
</TabItem>
</Tabs>
3 changes: 2 additions & 1 deletion website/docs/services/agentpools/agent_pools/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -180,7 +180,8 @@ FROM okta.agentpools.agent_pools
WHERE subdomain = '{{ subdomain }}' -- required
AND limitPerPoolType = '{{ limitPerPoolType }}'
AND poolType = '{{ poolType }}'
AND after = '{{ after }}';
AND after = '{{ after }}'
;
```
</TabItem>
</Tabs>
19 changes: 12 additions & 7 deletions website/docs/services/api_tokens/api_tokens/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -92,7 +92,7 @@ The following fields are returned by `SELECT` queries:
<tr>
<td><CopyableCode code="tokenWindow" /></td>
<td><code>string</code></td>
<td>A time duration specified as an [ISO 8601 duration](https://en.wikipedia.org/wiki/ISO_8601#Durations). (pattern: ^P(?:$)(\d+Y)?(\d+M)?(\d+W)?(\d+D)?(T(?:\d)(\d+H)?(\d+M)?(\d+S)?)?$)</td>
<td>A time duration specified as an [ISO 8601 duration](https://en.wikipedia.org/wiki/ISO_8601#Durations). (pattern: <code>^P(?:$)(\d+Y)?(\d+M)?(\d+W)?(\d+D)?(T(?:\d)(\d+H)?(\d+M)?(\d+S)?)?$</code>)</td>
</tr>
<tr>
<td><CopyableCode code="userId" /></td>
Expand Down Expand Up @@ -156,7 +156,7 @@ The following fields are returned by `SELECT` queries:
<tr>
<td><CopyableCode code="tokenWindow" /></td>
<td><code>string</code></td>
<td>A time duration specified as an [ISO 8601 duration](https://en.wikipedia.org/wiki/ISO_8601#Durations). (pattern: ^P(?:$)(\d+Y)?(\d+M)?(\d+W)?(\d+D)?(T(?:\d)(\d+H)?(\d+M)?(\d+S)?)?$)</td>
<td>A time duration specified as an [ISO 8601 duration](https://en.wikipedia.org/wiki/ISO_8601#Durations). (pattern: <code>^P(?:$)(\d+Y)?(\d+M)?(\d+W)?(\d+D)?(T(?:\d)(\d+H)?(\d+M)?(\d+S)?)?$</code>)</td>
</tr>
<tr>
<td><CopyableCode code="userId" /></td>
Expand Down Expand Up @@ -268,7 +268,8 @@ network,
tokenWindow,
userId
FROM okta.api_tokens.api_tokens
WHERE subdomain = '{{ subdomain }}' -- required;
WHERE subdomain = '{{ subdomain }}' -- required
;
```
</TabItem>
<TabItem value="get_api_token">
Expand All @@ -288,7 +289,8 @@ network,
tokenWindow,
userId
FROM okta.api_tokens.api_tokens
WHERE subdomain = '{{ subdomain }}' -- required;
WHERE subdomain = '{{ subdomain }}' -- required
;
```
</TabItem>
</Tabs>
Expand Down Expand Up @@ -324,7 +326,8 @@ expiresAt,
lastUpdated,
network,
tokenWindow,
userId;
userId
;
```
</TabItem>
</Tabs>
Expand All @@ -345,7 +348,8 @@ Revokes the API token provided in the Authorization header

```sql
DELETE FROM okta.api_tokens.api_tokens
WHERE subdomain = '{{ subdomain }}' --required;
WHERE subdomain = '{{ subdomain }}' --required
;
```
</TabItem>
<TabItem value="revoke_api_token">
Expand All @@ -354,7 +358,8 @@ Revokes an API token by `apiTokenId`

```sql
DELETE FROM okta.api_tokens.api_tokens
WHERE subdomain = '{{ subdomain }}' --required;
WHERE subdomain = '{{ subdomain }}' --required
;
```
</TabItem>
</Tabs>
18 changes: 11 additions & 7 deletions website/docs/services/apps/application_users/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -242,7 +242,7 @@ The following methods are available for this resource:
<td><CopyableCode code="insert" /></td>
<td><a href="#parameter-subdomain"><code>subdomain</code></a>, <a href="#parameter-data__id"><code>data__id</code></a></td>
<td></td>
<td>Assigns a user to an app for:<br /><br /> * SSO only&lt;br&gt;<br /> Assignments to SSO apps typically don't include a user profile.<br /> However, if your SSO app requires a profile but doesn't have provisioning enabled, you can add profile attributes in the request body.<br /><br /> * SSO and provisioning&lt;br&gt;<br /> Assignments to SSO and provisioning apps typically include credentials and an app-specific profile.<br /> Profile mappings defined for the app are applied first before applying any profile properties that are specified in the request body.<br /> &gt; **Notes:**<br /> &gt; * When Universal Directory is enabled, you can only specify profile properties that aren't defined in profile mappings.<br /> &gt; * Omit mapped properties during assignment to minimize assignment errors.</td>
<td>Assigns a user to an app for:<br /><br /> * SSO only<br /><br /> Assignments to SSO apps typically don't include a user profile.<br /> However, if your SSO app requires a profile but doesn't have provisioning enabled, you can add profile attributes in the request body.<br /><br /> * SSO and provisioning<br /><br /> Assignments to SSO and provisioning apps typically include credentials and an app-specific profile.<br /> Profile mappings defined for the app are applied first before applying any profile properties that are specified in the request body.<br /> &gt; **Notes:**<br /> &gt; * When Universal Directory is enabled, you can only specify profile properties that aren't defined in profile mappings.<br /> &gt; * Omit mapped properties during assignment to minimize assignment errors.</td>
</tr>
<tr>
<td><a href="#update_application_user"><CopyableCode code="update_application_user" /></a></td>
Expand Down Expand Up @@ -341,7 +341,8 @@ WHERE subdomain = '{{ subdomain }}' -- required
AND after = '{{ after }}'
AND limit = '{{ limit }}'
AND q = '{{ q }}'
AND expand = '{{ expand }}';
AND expand = '{{ expand }}'
;
```
</TabItem>
<TabItem value="get_application_user">
Expand All @@ -366,7 +367,8 @@ statusChanged,
syncState
FROM okta.apps.application_users
WHERE subdomain = '{{ subdomain }}' -- required
AND expand = '{{ expand }}';
AND expand = '{{ expand }}'
;
```
</TabItem>
</Tabs>
Expand All @@ -383,7 +385,7 @@ AND expand = '{{ expand }}';
>
<TabItem value="assign_user_to_application">

Assigns a user to an app for:<br /><br /> * SSO only&lt;br&gt;<br /> Assignments to SSO apps typically don't include a user profile.<br /> However, if your SSO app requires a profile but doesn't have provisioning enabled, you can add profile attributes in the request body.<br /><br /> * SSO and provisioning&lt;br&gt;<br /> Assignments to SSO and provisioning apps typically include credentials and an app-specific profile.<br /> Profile mappings defined for the app are applied first before applying any profile properties that are specified in the request body.<br /> &gt; **Notes:**<br /> &gt; * When Universal Directory is enabled, you can only specify profile properties that aren't defined in profile mappings.<br /> &gt; * Omit mapped properties during assignment to minimize assignment errors.
Assigns a user to an app for:<br /><br /> * SSO only<br /><br /> Assignments to SSO apps typically don't include a user profile.<br /> However, if your SSO app requires a profile but doesn't have provisioning enabled, you can add profile attributes in the request body.<br /><br /> * SSO and provisioning<br /><br /> Assignments to SSO and provisioning apps typically include credentials and an app-specific profile.<br /> Profile mappings defined for the app are applied first before applying any profile properties that are specified in the request body.<br /> &gt; **Notes:**<br /> &gt; * When Universal Directory is enabled, you can only specify profile properties that aren't defined in profile mappings.<br /> &gt; * Omit mapped properties during assignment to minimize assignment errors.

```sql
INSERT INTO okta.apps.application_users (
Expand All @@ -395,7 +397,7 @@ subdomain
)
SELECT
'{{ credentials }}',
'{{ id }}' --required,
'{{ id }}' /* required */,
'{{ profile }}',
'{{ scope }}',
'{{ subdomain }}'
Expand Down Expand Up @@ -488,7 +490,8 @@ profile,
scope,
status,
statusChanged,
syncState;
syncState
;
```
</TabItem>
</Tabs>
Expand All @@ -509,7 +512,8 @@ Unassigns a user from an app<br /><br />For directories like Active Directory an
```sql
DELETE FROM okta.apps.application_users
WHERE subdomain = '{{ subdomain }}' --required
AND sendEmail = '{{ sendEmail }}';
AND sendEmail = '{{ sendEmail }}'
;
```
</TabItem>
</Tabs>
31 changes: 20 additions & 11 deletions website/docs/services/apps/applications/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -415,7 +415,8 @@ AND useOptimization = '{{ useOptimization }}'
AND limit = '{{ limit }}'
AND filter = '{{ filter }}'
AND expand = '{{ expand }}'
AND includeNonDeleted = '{{ includeNonDeleted }}';
AND includeNonDeleted = '{{ includeNonDeleted }}'
;
```
</TabItem>
<TabItem value="get_application">
Expand All @@ -441,7 +442,8 @@ universalLogout,
visibility
FROM okta.apps.applications
WHERE subdomain = '{{ subdomain }}' -- required
AND expand = '{{ expand }}';
AND expand = '{{ expand }}'
;
```
</TabItem>
</Tabs>
Expand Down Expand Up @@ -474,10 +476,10 @@ OktaAccessGateway-Agent
)
SELECT
'{{ accessibility }}',
'{{ label }}' --required,
'{{ label }}' /* required */,
'{{ licensing }}',
'{{ profile }}',
'{{ signOnMode }}' --required,
'{{ signOnMode }}' /* required */,
'{{ visibility }}',
'{{ subdomain }}',
'{{ activate }}',
Expand Down Expand Up @@ -610,7 +612,8 @@ profile,
signOnMode,
status,
universalLogout,
visibility;
visibility
;
```
</TabItem>
</Tabs>
Expand All @@ -630,7 +633,8 @@ Deletes an inactive application

```sql
DELETE FROM okta.apps.applications
WHERE subdomain = '{{ subdomain }}' --required;
WHERE subdomain = '{{ subdomain }}' --required
;
```
</TabItem>
</Tabs>
Expand All @@ -654,7 +658,8 @@ Activates an inactive application

```sql
EXEC okta.apps.applications.activate_application
@subdomain='{{ subdomain }}' --required;
@subdomain='{{ subdomain }}' --required
;
```
</TabItem>
<TabItem value="deactivate_application">
Expand All @@ -663,7 +668,8 @@ Deactivates an active application<br /><br />&gt; **Note:** Deactivating an app

```sql
EXEC okta.apps.applications.deactivate_application
@subdomain='{{ subdomain }}' --required;
@subdomain='{{ subdomain }}' --required
;
```
</TabItem>
<TabItem value="upload_application_logo">
Expand All @@ -676,7 +682,8 @@ EXEC okta.apps.applications.upload_application_logo
@@json=
'{
"file": "{{ file }}"
}';
}'
;
```
</TabItem>
<TabItem value="assign_application_policy">
Expand All @@ -685,7 +692,8 @@ Assigns an app to an [authentication policy](https://developer.okta.com/docs/api

```sql
EXEC okta.apps.applications.assign_application_policy
@subdomain='{{ subdomain }}' --required;
@subdomain='{{ subdomain }}' --required
;
```
</TabItem>
<TabItem value="preview_samlmetadata_for_application">
Expand All @@ -695,7 +703,8 @@ Previews the SSO SAML metadata for an application
```sql
EXEC okta.apps.applications.preview_samlmetadata_for_application
@kid='{{ kid }}' --required,
@subdomain='{{ subdomain }}' --required;
@subdomain='{{ subdomain }}' --required
;
```
</TabItem>
</Tabs>
Loading
Loading