POST /api/v1/orgs
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.
Servers
- https://{yourOktaDomain}
Request headers
Name | Type | Required | Description |
---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Request body fields
Name | Type | Required | Description |
---|---|---|---|
admin |
Object | Yes |
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.
|
admin.profile |
Object | Yes |
Specifies the profile attributes for the first super admin user. The minimal set of required attributes are |
admin.profile.email |
String | Yes |
The primary email address of the User. For validation, see RFC 5322 Section 3.2.3. |
admin.profile.lastName |
String | Yes |
The family name of the User ( |
admin.profile.firstName |
String | Yes |
Given name of the User ( |
admin.profile.login |
String | Yes |
The unique identifier for the User ( |
admin.credentials |
Object | No |
Specifies primary authentication and recovery credentials for a User. Credential types and requirements vary depending on the provider and security policy of the org. |
admin.credentials.recovery_question |
Object | No |
Specifies a secret question and answer that's validated (case insensitive) when a User forgets their password or unlocks their account. The answer property is write-only. |
admin.credentials.recovery_question.answer |
String | No |
The answer to the recovery question |
admin.credentials.recovery_question.question |
String | No |
The recovery question |
admin.credentials.password |
Object | No |
Specifies a password for a user
|
admin.credentials.password.value |
String | No |
Password value (which is validated by the Password Policy) |
edition |
String | Yes |
Edition for the Org. Possible values:
|
subdomain |
String | Yes |
Subdomain of the Org. Must be unique and include no spaces. |
tokenType |
String | No |
Type of returned Possible values:
|
website |
String | No |
Default website for the Org |
status |
String | No |
Status of the Org. Possible values:
|
lastUpdated |
String | No |
Timestamp when the Org was last updated |
id |
String | No |
Org ID |
_links |
Object | No |
Specifies available link relations (see Web Linking) using the JSON Hypertext Application Language specification |
created |
String | No |
Timestamp when the Org was created |
name |
String | Yes |
Unique name of the Org.
This name appears in the HTML |
token |
String | No |
API token associated with the child Org super admin account. Use this API token to provision resources (such as policies, apps, and groups) on the newly created child Org. This token is revoked if the super admin account is deactivated.
|
settings |
Object | No |
Settings associated with the created Org |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.