risk_providers

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

Overview

Name	risk_providers
Type	Resource
Id	okta.risk.risk_providers

Fields

The following fields are returned by SELECT queries:

list_risk_providers

Name	Datatype	Description
id	string	The ID of the risk provider object (example: 00rp12r4skkjkjgsn)
name	string	Name of the risk provider (example: Risk-Partner-X)
_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.
action	string	Action taken by Okta during authentication attempts based on the risk events sent by this provider (default: log_only)
clientId	string	The ID of the OAuth 2.0 service app that's used to send risk events to Okta (example: 00cjkjjkkgjkdkjdkkljjsd)
created	string (date-time)	Timestamp when the risk provider object was created (example: 2021-01-05 22:18:30)
lastUpdated	string (date-time)	Timestamp when the risk provider object was last updated (example: 2021-01-05 22:18:30)

get_risk_provider

Name	Datatype	Description
id	string	The ID of the risk provider object (example: 00rp12r4skkjkjgsn)
name	string	Name of the risk provider (example: Risk-Partner-X)
_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.
action	string	Action taken by Okta during authentication attempts based on the risk events sent by this provider (default: log_only)
clientId	string	The ID of the OAuth 2.0 service app that's used to send risk events to Okta (example: 00cjkjjkkgjkdkjdkkljjsd)
created	string (date-time)	Timestamp when the risk provider object was created (example: 2021-01-05 22:18:30)
lastUpdated	string (date-time)	Timestamp when the risk provider object was last updated (example: 2021-01-05 22:18:30)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_risk_providers	select	subdomain		Lists all risk provider objects
get_risk_provider	select	subdomain		Retrieves a risk provider object by ID
create_risk_provider	insert	subdomain, data__name, data__clientId, data__action, data__id, data___links		Creates a risk provider object. You can create a maximum of three risk provider objects.
replace_risk_provider	replace	subdomain, data__name, data__clientId, data__action, data__id, data___links		Replaces the properties for a given risk provider object ID
delete_risk_provider	delete	subdomain		Deletes a risk provider object by its 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
subdomain	string	The domain of your organization. This can be a provided subdomain of an official okta domain (okta.com, oktapreview.com, etc) or one of your configured custom domains. (default: my-org)

SELECT examples

list_risk_providers

Lists all risk provider objects

SELECT
id,
name,
_links,
action,
clientId,
created,
lastUpdated
FROM okta.risk.risk_providers
WHERE subdomain = '{{ subdomain }}' -- required;

get_risk_provider

Retrieves a risk provider object by ID

SELECT
id,
name,
_links,
action,
clientId,
created,
lastUpdated
FROM okta.risk.risk_providers
WHERE subdomain = '{{ subdomain }}' -- required;

INSERT examples

create_risk_provider

Creates a risk provider object. You can create a maximum of three risk provider objects.

INSERT INTO okta.risk.risk_providers (
data__action,
data__clientId,
data__name,
subdomain
)
SELECT 
'{{ action }}' --required,
'{{ clientId }}' --required,
'{{ name }}' --required,
'{{ subdomain }}'
RETURNING
id,
name,
_links,
action,
clientId,
created,
lastUpdated
;

Manifest

# Description fields are for documentation purposes
- name: risk_providers
  props:
    - name: subdomain
      value: string
      description: Required parameter for the risk_providers resource.
    - name: action
      value: string
      description: >
        Action taken by Okta during authentication attempts based on the risk events sent by this provider
        
      valid_values: ['enforce_and_log', 'log_only', 'none']
      default: log_only
    - name: clientId
      value: string
      description: >
        The ID of the [OAuth 2.0 service app](https://developer.okta.com/docs/guides/implement-oauth-for-okta-serviceapp/main/#create-a-service-app-and-grant-scopes) that's used to send risk events to Okta
        
    - name: name
      value: string
      description: >
        Name of the risk provider
        

REPLACE examples

replace_risk_provider

Replaces the properties for a given risk provider object ID

REPLACE okta.risk.risk_providers
SET 
data__action = '{{ action }}',
data__clientId = '{{ clientId }}',
data__name = '{{ name }}'
WHERE 
subdomain = '{{ subdomain }}' --required
AND data__name = '{{ name }}' --required
AND data__clientId = '{{ clientId }}' --required
AND data__action = '{{ action }}' --required
RETURNING
id,
name,
_links,
action,
clientId,
created,
lastUpdated;

DELETE examples

delete_risk_provider

Deletes a risk provider object by its ID

DELETE FROM okta.risk.risk_providers
WHERE subdomain = '{{ subdomain }}' --required;