api_discovery_v1_discovery_organizations_CreateRequest

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/api_discovery_v1_discovery_organizations_CreateRequest",
  "title": "api_discovery_v1_discovery_organizations_CreateRequest",
  "type": "object",
  "properties": {
    "intermediate_session_token": {
      "type": "string",
      "description": "The Intermediate Session Token. This token does not necessarily belong to a specific instance of a Member, but represents a bag of factors that may be converted to a member session. The token can be used with the [OTP SMS Authenticate endpoint](https://stytch.com/docs/b2b/api/authenticate-otp-sms), [TOTP Authenticate endpoint](https://stytch.com/docs/b2b/api/authenticate-totp), or [Recovery Codes Recover endpoint](https://stytch.com/docs/b2b/api/recovery-codes-recover) to complete an MFA flow and log in to the Organization. The token has a default expiry of 10 minutes. It can also be used with the [Exchange Intermediate Session endpoint](https://stytch.com/docs/b2b/api/exchange-intermediate-session) to join a specific Organization that allows the factors represented by the intermediate session token; or the [Create Organization via Discovery endpoint](https://stytch.com/docs/b2b/api/create-organization-via-discovery) to create a new Organization and Member. Intermediate Session Tokens have a default expiry of 10 minutes."
    },
    "session_duration_minutes": {
      "type": "integer",
      "format": "int32",
      "description": "Set the session lifetime to be this many minutes from now. This will start a new session if one doesn't already exist,\n  returning both an opaque `session_token` and `session_jwt` for this session. Remember that the `session_jwt` will have a fixed lifetime of\n  five minutes regardless of the underlying session duration, and will need to be refreshed over time.\n\n  This value must be a minimum of 5 and a maximum of 527040 minutes (366 days).\n\n  If a `session_token` or `session_jwt` is provided then a successful authentication will continue to extend the session this many minutes.\n\n  If the `session_duration_minutes` parameter is not specified, a Stytch session will be created with a 60 minute duration. If you don't want\n  to use the Stytch session product, you can ignore the session fields in the response."
    },
    "session_custom_claims": {
      "type": "object",
      "additionalProperties": true,
      "description": "Add a custom claims map to the Session being authenticated. Claims are only created if a Session is initialized by providing a value in\n  `session_duration_minutes`. Claims will be included on the Session object and in the JWT. To update a key in an existing Session, supply a new value. To\n  delete a key, supply a null value. Custom claims made with reserved claims (`iss`, `sub`, `aud`, `exp`, `nbf`, `iat`, `jti`) will be ignored.\n  Total custom claims size cannot exceed four kilobytes."
    },
    "organization_name": {
      "type": "string",
      "description": "The name of the Organization. If the name is not specified, a default name will be created based on the email used to initiate the discovery flow. If the email domain is a common email provider such as gmail.com, or if the email is a .edu email, the organization name will be generated based on the name portion of the email. Otherwise, the organization name will be generated based on the email domain."
    },
    "organization_slug": {
      "type": "string",
      "description": "The unique URL slug of the Organization. A minimum of two characters is required. The slug only accepts alphanumeric characters and the following reserved characters: `-` `.` `_` `~`. If the slug is not specified, a default slug will be created based on the email used to initiate the discovery flow. If the email domain is a common email provider such as gmail.com, or if the email is a .edu email, the organization slug will be generated based on the name portion of the email. Otherwise, the organization slug will be generated based on the email domain."
    },
    "organization_external_id": {
      "type": "string",
      "description": "An identifier that can be used in API calls wherever a organization_id is expected. This is a string consisting of alphanumeric, `.`, `_`, `-`, or `|` characters with a maximum length of 128 characters. External IDs must be unique within a project, but may be reused across different projects in the same workspace."
    },
    "organization_logo_url": {
      "type": "string",
      "description": "The image URL of the Organization logo."
    },
    "trusted_metadata": {
      "type": "object",
      "additionalProperties": true,
      "description": "An arbitrary JSON object for storing application-specific data or identity-provider-specific data."
    },
    "sso_jit_provisioning": {
      "type": "string",
      "description": "The authentication setting that controls the JIT provisioning of Members when authenticating via SSO. The accepted values are:\n \n  `ALL_ALLOWED` \u2013 the default setting, new Members will be automatically provisioned upon successful authentication via any of the Organization's `sso_active_connections`.\n \n  `RESTRICTED` \u2013 only new Members with SSO logins that comply with `sso_jit_provisioning_allowed_connections` can be provisioned upon authentication.\n \n  `NOT_ALLOWED` \u2013 disable JIT provisioning via SSO.\n  "
    },
    "email_allowed_domains": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "An array of email domains that allow invites or JIT provisioning for new Members. This list is enforced when either `email_invites` or `email_jit_provisioning` is set to `RESTRICTED`.\n   \n   \n    Common domains such as `gmail.com` are not allowed. See the [common email domains resource](https://stytch.com/docs/b2b/api/common-email-domains) for the full list."
    },
    "email_jit_provisioning": {
      "type": "string",
      "description": "The authentication setting that controls how a new Member can be provisioned by authenticating via Email Magic Link or OAuth. The accepted values are:\n \n  `RESTRICTED` \u2013 only new Members with verified emails that comply with `email_allowed_domains` can be provisioned upon authentication via Email Magic Link or OAuth.\n \n  `NOT_ALLOWED` \u2013 the default setting, disables JIT provisioning via Email Magic Link and OAuth.\n  "
    },
    "email_invites": {
      "type": "string",
      "description": "The authentication setting that controls how a new Member can be invited to an organization by email. The accepted values are:\n \n  `ALL_ALLOWED` \u2013 any new Member can be invited to join via email.\n \n  `RESTRICTED` \u2013 only new Members with verified emails that comply with `email_allowed_domains` can be invited via email.\n \n  `NOT_ALLOWED` \u2013 disable email invites.\n  "
    },
    "auth_methods": {
      "type": "string",
      "description": "The setting that controls which authentication methods can be used by Members of an Organization. The accepted values are:\n \n  `ALL_ALLOWED` \u2013 the default setting which allows all authentication methods to be used.\n \n  `RESTRICTED` \u2013 only methods that comply with `allowed_auth_methods` can be used for authentication. This setting does not apply to Members with `is_breakglass` set to `true`.\n  "
    },
    "allowed_auth_methods": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "An array of allowed authentication methods. This list is enforced when `auth_methods` is set to `RESTRICTED`.\n  The list's accepted values are: `sso`, `magic_link`, `email_otp`, `password`, `google_oauth`, `microsoft_oauth`, `slack_oauth`, `github_oauth`, and `hubspot_oauth`.\n  "
    },
    "mfa_policy": {
      "type": "string",
      "description": "The setting that controls the MFA policy for all Members in the Organization. The accepted values are:\n \n  `REQUIRED_FOR_ALL` \u2013 All Members within the Organization will be required to complete MFA every time they wish to log in. However, any active Session that existed prior to this setting change will remain valid.\n \n  `OPTIONAL` \u2013 The default value. The Organization does not require MFA by default for all Members. Members will be required to complete MFA only if their `mfa_enrolled` status is set to true.\n  "
    },
    "rbac_email_implicit_role_assignments": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/api_organization_v1_EmailImplicitRoleAssignment"
      },
      "description": "Implicit role assignments based off of email domains.\n  For each domain-Role pair, all Members whose email addresses have the specified email domain will be granted the\n  associated Role, regardless of their login method. See the [RBAC guide](https://stytch.com/docs/b2b/guides/rbac/role-assignment)\n  for more information about role assignment."
    },
    "mfa_methods": {
      "type": "string",
      "description": "The setting that controls which MFA methods can be used by Members of an Organization. The accepted values are:\n \n  `ALL_ALLOWED` \u2013 the default setting which allows all authentication methods to be used.\n \n  `RESTRICTED` \u2013 only methods that comply with `allowed_mfa_methods` can be used for authentication. This setting does not apply to Members with `is_breakglass` set to `true`.\n  "
    },
    "allowed_mfa_methods": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "An array of allowed MFA authentication methods. This list is enforced when `mfa_methods` is set to `RESTRICTED`.\n  The list's accepted values are: `sms_otp` and `totp`.\n  "
    },
    "oauth_tenant_jit_provisioning": {
      "type": "string",
      "description": "The authentication setting that controls how a new Member can JIT provision into an organization by tenant. The accepted values are:\n \n  `RESTRICTED` \u2013 only new Members with tenants in `allowed_oauth_tenants` can JIT provision via tenant.\n \n  `NOT_ALLOWED` \u2013 the default setting, disables JIT provisioning by OAuth Tenant.\n  "
    },
    "allowed_oauth_tenants": {
      "type": "object",
      "additionalProperties": true,
      "description": "A map of allowed OAuth tenants. If this field is not passed in, the Organization will not allow JIT provisioning by OAuth Tenant. Allowed keys are \"slack\", \"hubspot\", and \"github\"."
    },
    "first_party_connected_apps_allowed_type": {
      "$ref": "#/components/schemas/api_discovery_v1_CreateRequestFirstPartyConnectedAppsAllowedType",
      "description": "The authentication setting that sets the Organization's policy towards first party Connected Apps. The accepted values are:\n \n  `ALL_ALLOWED` \u2013 the default setting, any first party Connected App in the Project is permitted for use by Members.\n \n  `RESTRICTED` \u2013 only first party Connected Apps with IDs in `allowed_first_party_connected_apps` can be used by Members.\n \n  `NOT_ALLOWED` \u2013 no first party Connected Apps are permitted.\n  "
    },
    "allowed_first_party_connected_apps": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "An array of first party Connected App IDs that are allowed for the Organization. Only used when the Organization's `first_party_connected_apps_allowed_type` is `RESTRICTED`."
    },
    "third_party_connected_apps_allowed_type": {
      "$ref": "#/components/schemas/api_discovery_v1_CreateRequestThirdPartyConnectedAppsAllowedType",
      "description": "The authentication setting that sets the Organization's policy towards third party Connected Apps. The accepted values are:\n \n  `ALL_ALLOWED` \u2013 the default setting, any third party Connected App in the Project is permitted for use by Members.\n \n  `RESTRICTED` \u2013 only third party Connected Apps with IDs in `allowed_first_party_connected_apps` can be used by Members.\n \n  `NOT_ALLOWED` \u2013 no third party Connected Apps are permitted.\n  "
    },
    "allowed_third_party_connected_apps": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "An array of third party Connected App IDs that are allowed for the Organization. Only used when the Organization's `third_party_connected_apps_allowed_type` is `RESTRICTED`."
    },
    "telemetry_id": {
      "type": "string",
      "description": "If the `telemetry_id` is passed, as part of this request, Stytch will call the [Fingerprint Lookup API](https://stytch.com/docs/fraud/api/fingerprint-lookup) and store the associated fingerprints and IPGEO information for the Member. Your workspace must be enabled for Device Fingerprinting to use this feature."
    }
  },
  "description": "Request type",
  "required": [
    "intermediate_session_token"
  ]
}