child_orgs

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

Overview

Name	child_orgs
Type	Resource
Id	okta.orgs.child_orgs

Fields

The following fields are returned by SELECT queries:

SELECT not supported for this resource, use SHOW METHODS to view available operations for the resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
create_child_org	insert	subdomain, data__admin, data__edition, data__name, data__subdomain		Creates an org (child org) that has the same features as the current requesting org (parent org). A child org inherits any new features added to the parent org, but new features added to the child org aren't propagated back to the parent org. > Notes: > * Some features associated with products, such as Atspoke, Workflows, and Okta Identity Governance, aren't propagated to the child org. > * Wait at least 30 seconds after a 201-Created response before you make API requests to the new child org. > * For rate limits, see Org creation rate limits.

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)

INSERT examples

create_child_org

Creates an org (child org) that has the same features as the current requesting org (parent org).
A child org inherits any new features added to the parent org, but new features added to the child org aren't propagated back to the parent org.
> Notes:
> * Some features associated with products, such as Atspoke, Workflows, and Okta Identity Governance, aren't propagated to the child org.
> * Wait at least 30 seconds after a 201-Created response before you make API requests to the new child org.
> * For rate limits, see Org creation rate limits.

INSERT INTO okta.orgs.child_orgs (
data__admin,
data__edition,
data__name,
data__subdomain,
data__website,
subdomain
)
SELECT 
'{{ admin }}' --required,
'{{ edition }}' --required,
'{{ name }}' --required,
'{{ subdomain }}' --required,
'{{ website }}',
'{{ subdomain }}'
RETURNING
id,
name,
_links,
admin,
created,
edition,
lastUpdated,
settings,
status,
subdomain,
token,
tokenType,
website
;

Manifest

# Description fields are for documentation purposes
- name: child_orgs
  props:
    - name: subdomain
      value: string
      description: Required parameter for the child_orgs resource.
    - name: admin
      value: object
      description: >
        Profile and credential information for the first super admin user of the child org.
If you plan to configure and manage the org programmatically, create a system user with a dedicated email address and a strong password.
> **Note:** If you don't provide `credentials`, the super admin user is prompted to set up their credentials when they sign in to the org for the first time.
        
    - name: edition
      value: string
      description: >
        Edition for the org. `SKU` is the only supported value.
        
      valid_values: ['SKU']
    - name: name
      value: string
      description: >
        Unique name of the org.
This name appears in the HTML `<title>` tag of the new org sign-in page.
Only less than 4-width UTF-8 encoded characters are allowed.
        
    - name: subdomain
      value: string
      description: >
        Subdomain of the org. Must be unique and include no spaces.
        
    - name: website
      value: string
      description: >
        Default website for the org