Skip to main content

Create a suborganization​

Create a new organization subordinate to your organization.

Header Parameters
  • SlashID-OrgID string required

    The organization ID

    Example: af5fbd30-7ce7-4548-8b30-4cd59cb2aba1
  • SlashID-Required-Consistency string

    Possible values: [local_region, all_regions]

    Default value: local_region

    The consistency level required for this request. If the consistency level is not achieved within the timeout, the request will fail with a 408 Request Timeout error. 408 Request Timeout error indicates that request was not handled within the timeout, but it may still be handled after request timeout. Allowed values: * local_region: Wait while the request executes in the local region. * all_regions: Wait while the request executes across all regions. You can learn more about our replication model on our Cross-region Replication Model page.

  • SlashID-Required-Consistency-Timeout integer

    Possible values: >= 1 and <= 120

    Default value: 30

    The maximum amount of seconds to wait for the requested consistency level to be achieved. If the consistency level is not achieved within this time, the request will fail with a 408 Request Timeout error. 408 Request Timeout error indicates that request was not handled within the timeout, but it may still be handled after request timeout. You can learn more about our replication model on our Cross-region Replication Model page.

Request Body
  • sub_org_name string required
  • admins object[] required
  • type string required

    Possible values: [email_address, phone_number, username]

  • value string required
  • persons_org_id string
  • groups_org_id string
  • inherit_rbac_pools boolean

    This setting determines how permissions and roles are managed for a suborganization. When inherit_rbac_pools is set to false: - The suborganization has its own independent permissions and roles. - Permissions and roles can be fully customized for this suborganization. When inherit_rbac_pools is set to true: - Permissions:

    • Inherited from the nearest ancestor with 'inherit_rbac_pools' set to false.

    • Read-only for this suborganization.

    • Cannot be modified within this suborganization.

    • Roles:

      • Scoped to each organization, including this suborganization.
      • Visible across all organizations within the inheritance pool.
      • Roles from other organizations can be assigned to users in this suborganization.

    Note: - Individual role and permission assignments are not inherited. - This setting cannot be changed after the suborganization is created.

Responses

OK

Schema
  • meta object
  • pagination object
  • limit integer
  • offset integer
  • total_count int64
  • errors object[]
  • httpcode integer
  • message string
  • result object
  • id string
  • parent_id string
  • org_name string
  • tenant_name string
  • api_key string