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:

get_governance_bundle

Name	Datatype	Description
id	string	Governance bundle ID
name	string	Name of the governance bundle
_links	object	Link relations available
description	string	Description of the governance bundle
orn	string	The governance bundle resource, in ORN format
status	string	Status of the governance bundle

list_governance_bundles

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.
bundles	array	List of governance bundles

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_governance_bundle	select	bundleId, subdomain		Retrieves a governance bundle for the Admin Console
list_governance_bundles	select	subdomain	after, limit	Lists all governance bundles for the Admin Console in your org
create_governance_bundle	insert	subdomain		Creates a governance bundle of entitlements for the Admin Console
replace_governance_bundle	replace	bundleId, subdomain		Replaces the properties of a governance bundle for the Admin Console
delete_governance_bundle	delete	bundleId, subdomain		Deletes an Admin Console governance bundle

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
bundleId	string	The id of a bundle
subdomain	string	(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 and Link header.
limit	integer	A limit on the number of objects to return

SELECT examples

get_governance_bundle

Retrieves a governance bundle for the Admin Console

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

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 }}'
;

INSERT examples

create_governance_bundle

Creates a governance bundle of entitlements for the Admin Console

INSERT INTO okta.iam.governance_bundles (
description,
entitlements,
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: "{{ subdomain }}"
    description: Required parameter for the governance_bundles resource.
  - name: description
    value: "{{ description }}"
    description: |
      Description of the governance bundle
  - name: entitlements
    description: |
      List of entitlements to include in the governance bundle
    value:
      - resourceSets: "{{ resourceSets }}"
        role: "{{ role }}"
        targets: "{{ targets }}"
  - name: name
    value: "{{ name }}"
    description: |
      Name of the governance bundle

REPLACE examples

replace_governance_bundle

Replaces the properties of a governance bundle for the Admin Console

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

DELETE examples

delete_governance_bundle

Deletes an Admin Console governance bundle

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