sessions

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

Overview

Name	sessions
Type	Resource
Id	okta.identity_sources.sessions

Fields

The following fields are returned by SELECT queries:

get_identity_source_session

Name	Datatype	Description
id	string	The ID of the identity source session
created	string (date-time)	The timestamp when the identity source session was created
identitySourceId	string	The ID of the custom identity source for which the session is created
importType	string	The type of import. All imports are INCREMENTAL imports.
lastUpdated	string (date-time)	The timestamp when the identity source session was created
status	string	The current status of the identity source session (CLOSED, COMPLETED, CREATED, ERROR, EXPIRED, IN_PROGRESS, TRIGGERED)

list_identity_source_sessions

Name	Datatype	Description
id	string	The ID of the identity source session
created	string (date-time)	The timestamp when the identity source session was created
identitySourceId	string	The ID of the custom identity source for which the session is created
importType	string	The type of import. All imports are INCREMENTAL imports.
lastUpdated	string (date-time)	The timestamp when the identity source session was created
status	string	The current status of the identity source session (CLOSED, COMPLETED, CREATED, ERROR, EXPIRED, IN_PROGRESS, TRIGGERED)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_identity_source_session	select	identitySourceId, sessionId, subdomain		Retrieves an identity source session for a given identity source ID and session ID
list_identity_source_sessions	select	identitySourceId, subdomain		Lists all identity source sessions for the given identity source instance
create_identity_source_session	insert	identitySourceId, subdomain		Creates an identity source session for the given identity source instance
delete_identity_source_session	delete	identitySourceId, sessionId, subdomain		Deletes an identity source session for a given identity source ID and session Id

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
identitySourceId	string	The ID of the identity source for which the session is created (example: 0oa3l6l6WK6h0R0QW0g4)
sessionId	string	The ID of the identity source session (example: aps1qqonvr2SZv6o70h8)
subdomain	string	(default: my-org)

SELECT examples

get_identity_source_session

Retrieves an identity source session for a given identity source ID and session ID

SELECT
id,
created,
identitySourceId,
importType,
lastUpdated,
status
FROM okta.identity_sources.sessions
WHERE identitySourceId = '{{ identitySourceId }}' -- required
AND sessionId = '{{ sessionId }}' -- required
AND subdomain = '{{ subdomain }}' -- required
;

list_identity_source_sessions

Lists all identity source sessions for the given identity source instance

SELECT
id,
created,
identitySourceId,
importType,
lastUpdated,
status
FROM okta.identity_sources.sessions
WHERE identitySourceId = '{{ identitySourceId }}' -- required
AND subdomain = '{{ subdomain }}' -- required
;

INSERT examples

create_identity_source_session

Creates an identity source session for the given identity source instance

INSERT INTO okta.identity_sources.sessions (
identitySourceId,
subdomain
)
SELECT 
'{{ identitySourceId }}',
'{{ subdomain }}'
RETURNING
id,
created,
identitySourceId,
importType,
lastUpdated,
status
;

Manifest

# Description fields are for documentation purposes
- name: sessions
props:
  - name: identitySourceId
    value: "{{ identitySourceId }}"
    description: Required parameter for the sessions resource.
  - name: subdomain
    value: "{{ subdomain }}"
    description: Required parameter for the sessions resource.

DELETE examples

delete_identity_source_session

Deletes an identity source session for a given identity source ID and session Id

DELETE FROM okta.identity_sources.sessions
WHERE identitySourceId = '{{ identitySourceId }}' --required
AND sessionId = '{{ sessionId }}' --required
AND subdomain = '{{ subdomain }}' --required
;