governance_bundles

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

Overview

Name	governance_bundles
Type	Resource
Id	okta.iam.governance_bundles

Fields

The following fields are returned by SELECT queries:

list_governance_bundles

Name	Datatype	Description
_links
bundles	array

get_governance_bundle

Name	Datatype	Description
id	string
name	string
_links	object
description	string
orn	string
status	string

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_governance_bundles	select	subdomain	after, limit	Lists all Governance Bundles for the Admin Console in your org
get_governance_bundle	select	subdomain		Retrieves a Governance Bundle from RAMP
create_governance_bundle	insert	subdomain		Creates a Governance Bundle for the Admin Console in RAMP
replace_governance_bundle	replace	subdomain		Replaces a Governance Bundle in RAMP
delete_governance_bundle	delete	subdomain		Deletes a Governance Bundle from RAMP

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)
after	string	The cursor to use for pagination. It is an opaque string that specifies your current location in the list and is obtained from the Link response header. See Pagination.
limit	integer	A limit on the number of objects to return

SELECT examples

list_governance_bundles

Lists all Governance Bundles for the Admin Console in your org

SELECT
_links,
bundles
FROM okta.iam.governance_bundles
WHERE subdomain = '{{ subdomain }}' -- required
AND after = '{{ after }}'
AND limit = '{{ limit }}'
;

get_governance_bundle

Retrieves a Governance Bundle from RAMP

SELECT
id,
name,
_links,
description,
orn,
status
FROM okta.iam.governance_bundles
WHERE subdomain = '{{ subdomain }}' -- required
;

INSERT examples

create_governance_bundle

Creates a Governance Bundle for the Admin Console in RAMP

INSERT INTO okta.iam.governance_bundles (
data__description,
data__entitlements,
data__name,
subdomain
)
SELECT 
'{{ description }}',
'{{ entitlements }}',
'{{ name }}',
'{{ subdomain }}'
RETURNING
id,
name,
_links,
description,
orn,
status
;

Manifest

# Description fields are for documentation purposes
- name: governance_bundles
  props:
    - name: subdomain
      value: string
      description: Required parameter for the governance_bundles resource.
    - name: description
      value: string
    - name: entitlements
      value: array
    - name: name
      value: string

REPLACE examples

replace_governance_bundle

Replaces a Governance Bundle in RAMP

REPLACE okta.iam.governance_bundles
SET 
data__description = '{{ description }}',
data__entitlements = '{{ entitlements }}',
data__name = '{{ name }}'
WHERE 
subdomain = '{{ subdomain }}' --required
RETURNING
id,
name,
_links,
description,
orn,
status
;

DELETE examples

delete_governance_bundle

Deletes a Governance Bundle from RAMP

DELETE FROM okta.iam.governance_bundles
WHERE subdomain = '{{ subdomain }}' --required
;