connections

Creates, updates, deletes, gets or lists a connections resource.

Overview

Name	connections
Type	Resource
Id	okta.apps.connections

Fields

The following fields are returned by SELECT queries:

get_default_provisioning_connection_for_application

Name	Datatype	Description
_links	object	Specifies link relations (see Web Linking) available using the JSON Hypertext Application Language specification. This object is used for dynamic discovery of related resources and lifecycle operations.
authScheme	string	A token is used to authenticate with the app. This property is only returned for the TOKEN authentication scheme. (TOKEN)
baseUrl	string	Base URL
profile	object
status	string	Provisioning connection status (DISABLED, ENABLED, UNKNOWN) (default: DISABLED)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_default_provisioning_connection_for_application	select	appId, subdomain		Retrieves the default provisioning connection for an app
update_default_provisioning_connection_for_application	update	appId, subdomain, profile	activate	Updates the default provisioning connection for an app
activate_default_provisioning_connection_for_application	exec	appId, subdomain		Activates the default provisioning connection for an app
deactivate_default_provisioning_connection_for_application	exec	appId, subdomain		Deactivates the default provisioning connection for an app
verify_provisioning_connection_for_application	exec	appName, appId, subdomain	code, state	Verifies the OAuth 2.0-based connection as part of the OAuth 2.0 consent flow. The validation of the consent flow is the last step of the provisioning setup for an OAuth 2.0-based connection. Currently, this operation only supports office365,google, zoomus, and slack apps.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
appId	string	Application ID
appName	string
subdomain	string	(default: my-org)
activate	string	Activates the provisioning connection
code	string
state	string

SELECT examples

get_default_provisioning_connection_for_application

Retrieves the default provisioning connection for an app

SELECT
_links,
authScheme,
baseUrl,
profile,
status
FROM okta.apps.connections
WHERE appId = '{{ appId }}' -- required
AND subdomain = '{{ subdomain }}' -- required
;

UPDATE examples

update_default_provisioning_connection_for_application

Updates the default provisioning connection for an app

UPDATE okta.apps.connections
SET 
baseUrl = '{{ baseUrl }}',
profile = '{{ profile }}'
WHERE 
appId = '{{ appId }}' --required
AND subdomain = '{{ subdomain }}' --required
AND profile = '{{ profile }}' --required
AND activate = '{{ activate}}'
RETURNING
_links,
authScheme,
baseUrl,
profile,
status;

Lifecycle Methods

activate_default_provisioning_connection_for_application

Activates the default provisioning connection for an app

EXEC okta.apps.connections.activate_default_provisioning_connection_for_application 
@appId='{{ appId }}' --required, 
@subdomain='{{ subdomain }}' --required
;

deactivate_default_provisioning_connection_for_application

Deactivates the default provisioning connection for an app

EXEC okta.apps.connections.deactivate_default_provisioning_connection_for_application 
@appId='{{ appId }}' --required, 
@subdomain='{{ subdomain }}' --required
;

verify_provisioning_connection_for_application

Verifies the OAuth 2.0-based connection as part of the OAuth 2.0 consent flow. The validation of the consent flow is the last step of the provisioning setup for an OAuth 2.0-based connection.
Currently, this operation only supports office365,google, zoomus, and slack apps.

EXEC okta.apps.connections.verify_provisioning_connection_for_application 
@appName='{{ appName }}' --required, 
@appId='{{ appId }}' --required, 
@subdomain='{{ subdomain }}' --required, 
@code='{{ code }}', 
@state='{{ state }}'
;