trusted_origins

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

Overview

Name	trusted_origins
Type	Resource
Id	okta.trustedorigins.trusted_origins

Fields

The following fields are returned by SELECT queries:

get_trusted_origin

Name	Datatype	Description
id	string	Unique identifier for the trusted origin
name	string	Unique name for the trusted origin
_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.
created	string (date-time)	Timestamp when the trusted origin was created
createdBy	string	The ID of the user who created the trusted origin
lastUpdated	string (date-time)	Timestamp when the trusted origin was last updated
lastUpdatedBy	string	The ID of the user who last updated the trusted origin
origin	string	Unique origin URL for the trusted origin. The supported schemes for this attribute are HTTP, HTTPS, FTP, Ionic 2, and Capacitor.
scopes	array	Array of scope types that this trusted origin is used for
status	string	(ACTIVE, INACTIVE)

list_trusted_origins

Name	Datatype	Description
id	string	Unique identifier for the trusted origin
name	string	Unique name for the trusted origin
_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.
created	string (date-time)	Timestamp when the trusted origin was created
createdBy	string	The ID of the user who created the trusted origin
lastUpdated	string (date-time)	Timestamp when the trusted origin was last updated
lastUpdatedBy	string	The ID of the user who last updated the trusted origin
origin	string	Unique origin URL for the trusted origin. The supported schemes for this attribute are HTTP, HTTPS, FTP, Ionic 2, and Capacitor.
scopes	array	Array of scope types that this trusted origin is used for
status	string	(ACTIVE, INACTIVE)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_trusted_origin	select	trustedOriginId, subdomain		Retrieves a trusted origin
list_trusted_origins	select	subdomain	q, filter, after, limit	Lists all trusted origins
create_trusted_origin	insert	subdomain		Creates a trusted origin
replace_trusted_origin	replace	trustedOriginId, subdomain		Replaces a trusted origin
delete_trusted_origin	delete	trustedOriginId, subdomain		Deletes a trusted origin
activate_trusted_origin	exec	trustedOriginId, subdomain		Activates a trusted origin. Sets the status to ACTIVE.
deactivate_trusted_origin	exec	trustedOriginId, subdomain		Deactivates a trusted origin. Sets the status to INACTIVE.

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
subdomain	string	(default: my-org)
trustedOriginId	string	id of the trusted origin
after	string	After cursor provided by a prior request
filter	string	Filter trusted origins with a supported expression for a subset of properties. You can filter on the following properties: name, origin, status, and type (type of scopes).
limit	integer (int32)	Specifies the number of results
q	string	A search string that prefix matches against the name and origin

SELECT examples

get_trusted_origin

Retrieves a trusted origin

SELECT
id,
name,
_links,
created,
createdBy,
lastUpdated,
lastUpdatedBy,
origin,
scopes,
status
FROM okta.trustedorigins.trusted_origins
WHERE trustedOriginId = '{{ trustedOriginId }}' -- required
AND subdomain = '{{ subdomain }}' -- required
;

list_trusted_origins

Lists all trusted origins

SELECT
id,
name,
_links,
created,
createdBy,
lastUpdated,
lastUpdatedBy,
origin,
scopes,
status
FROM okta.trustedorigins.trusted_origins
WHERE subdomain = '{{ subdomain }}' -- required
AND q = '{{ q }}'
AND filter = '{{ filter }}'
AND after = '{{ after }}'
AND limit = '{{ limit }}'
;

INSERT examples

create_trusted_origin

Creates a trusted origin

INSERT INTO okta.trustedorigins.trusted_origins (
name,
origin,
scopes,
subdomain
)
SELECT 
'{{ name }}',
'{{ origin }}',
'{{ scopes }}',
'{{ subdomain }}'
RETURNING
id,
name,
_links,
created,
createdBy,
lastUpdated,
lastUpdatedBy,
origin,
scopes,
status
;

Manifest

# Description fields are for documentation purposes
- name: trusted_origins
props:
  - name: subdomain
    value: "{{ subdomain }}"
    description: Required parameter for the trusted_origins resource.
  - name: name
    value: "{{ name }}"
    description: |
      Unique name for the trusted origin
  - name: origin
    value: "{{ origin }}"
    description: |
      Unique origin URL for the trusted origin. The supported schemes for this attribute are HTTP, HTTPS, FTP, Ionic 2, and Capacitor.
  - name: scopes
    description: |
      Array of scope types that this trusted origin is used for
    value:
      - allowedOktaApps: "{{ allowedOktaApps }}"
        type: "{{ type }}"

REPLACE examples

replace_trusted_origin

Replaces a trusted origin

REPLACE okta.trustedorigins.trusted_origins
SET 
createdBy = '{{ createdBy }}',
lastUpdatedBy = '{{ lastUpdatedBy }}',
name = '{{ name }}',
origin = '{{ origin }}',
scopes = '{{ scopes }}',
status = '{{ status }}'
WHERE 
trustedOriginId = '{{ trustedOriginId }}' --required
AND subdomain = '{{ subdomain }}' --required
RETURNING
id,
name,
_links,
created,
createdBy,
lastUpdated,
lastUpdatedBy,
origin,
scopes,
status;

DELETE examples

delete_trusted_origin

Deletes a trusted origin

DELETE FROM okta.trustedorigins.trusted_origins
WHERE trustedOriginId = '{{ trustedOriginId }}' --required
AND subdomain = '{{ subdomain }}' --required
;

Lifecycle Methods

activate_trusted_origin

Activates a trusted origin. Sets the status to ACTIVE.

EXEC okta.trustedorigins.trusted_origins.activate_trusted_origin 
@trustedOriginId='{{ trustedOriginId }}' --required, 
@subdomain='{{ subdomain }}' --required
;

deactivate_trusted_origin

Deactivates a trusted origin. Sets the status to INACTIVE.

EXEC okta.trustedorigins.trusted_origins.deactivate_trusted_origin 
@trustedOriginId='{{ trustedOriginId }}' --required, 
@subdomain='{{ subdomain }}' --required
;