Every API here is available over the APIs.io API and to AI agents over MCP.
openapi: 3.2.0
info:
title: Stytch B2B Authentication B2B IDP API
version: 2.0.0
description: Stytch's B2B API for multi-tenant authentication. Supports Organizations, Members, SSO (SAML/OIDC), Magic Links, OTP, OAuth, Discovery, Sessions, B2B RBAC, SCIM, TOTP, Recovery Codes, Passwords, Impersonation, and the B2B IDP.
contact:
name: Stytch
url: https://stytch.com/docs
license:
name: Proprietary
servers:
- url: https://api.stytch.com
description: Production
- url: https://test.stytch.com
description: Test
tags:
- name: B2B IDP
paths:
/v1/b2b/idp/oauth/authorize/start:
post:
summary: Authorizestart
operationId: api_b2b_idp_v1_b2b_idp_oauth_AuthorizeStart
tags:
- B2B IDP
description: 'Initiates a request for authorization of a Connected App to access a Member''s account.
Call this endpoint using the query parameters from an OAuth Authorization request.
This endpoint validates various fields (`scope`, `client_id`, `redirect_uri`, `prompt`, etc...) are correct and returns
relevant information for rendering an OAuth Consent Screen.
This endpoint returns:
- A public representation of the Connected App requesting authorization
- Whether _explicit_ consent must be granted before proceeding with the authorization
- A list of scopes the Member has the ability to grant the Connected App
Use this response to prompt the Member for consent (if necessary) before calling the [Submit OAuth Authorization](https://stytch.com/docs/b2b/api/connected-apps-oauth-authorize) endpoint.
Exactly one of the following must be provided to identify the Member granting authorization:
- `organization_id` + `member_id`
- `session_token`
- `session_jwt`
If a `session_token` or `session_jwt` is passed, the OAuth Authorization will be linked to the Member''s session for tracking purposes.
One of these fields must be used if the Connected App intends to complete the [Exchange Access Token](https://stytch.com/docs/b2b/api/connected-app-access-token-exchange) flow.'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/api_b2b_idp_v1_b2b_idp_oauth_AuthorizeStartRequest'
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/api_b2b_idp_v1_b2b_idp_oauth_AuthorizeStartResponse'
'400':
description: Bad request
'401':
description: Unauthorized
content:
application/json:
example:
status_code: 401
request_id: request-id-test-b05c992f-ebdc-489d-a754-c7e70ba13141
error_type: unauthorized_credentials
error_message: Unauthorized credentials.
error_url: https://stytch.com/docs/api/errors/401
'429':
description: Too Many Requests
content:
application/json:
example:
status_code: 429
request_id: request-id-test-b05c992f-ebdc-489d-a754-c7e70ba13141
error_type: too_many_requests
error_message: Too many requests have been made.
error_url: https://stytch.com/docs/api/errors/429
'500':
description: Internal server error
content:
application/json:
example:
status_code: 500
request_id: request-id-test-b05c992f-ebdc-489d-a754-c7e70ba13141
error_type: internal_server_error
error_message: Oops, something seems to have gone wrong, please reach out to support@stytch.com to let us know what went wrong.
error_url: https://stytch.com/docs/api/errors/500
x-code-samples:
- lang: csharp
label: C#
source: "// POST /v1/b2b/idp/oauth/authorize/start\nconst stytch = require('stytch');\n\nconst client = new stytch.B2BClient({\n project_id: '${projectId}',\n secret: '${secret}',\n});\n\nconst params = {\n client_id: \"${exampleConnectedAppClientID}\",\n redirect_uri: \"https://app.example/oauth/callback\",\n response_type: \"code\",\n scopes: [\"openid\"],\n};\n\nclient.IDP.OAuth.AuthorizeStart(params)\n .then(resp => { console.log(resp) })\n .catch(err => { console.log(err) });"
- lang: go
label: Go
source: "// POST /v1/b2b/idp/oauth/authorize/start\npackage main\n\nimport (\n\t\"context\"\n\t\"log\"\n\n\t\"github.com/stytchauth/stytch-go/v17/stytch/b2b/b2bstytchapi\"\n\t\"github.com/stytchauth/stytch-go/v17/stytch/b2b/idp/oauth\"\n)\n\nfunc main() {\n\tclient, err := b2bstytchapi.NewClient(\n\t\t\"${projectId}\",\n\t\t\"${secret}\",\n\t)\n\tif err != nil {\n\t\tlog.Fatalf(\"error instantiating client: %v\", err)\n\t}\n\n\tparams := &oauth.AuthorizeStartParams{\n\t\tClientID: \"${exampleConnectedAppClientID}\",\n\t\tRedirectURI: \"https://app.example/oauth/callback\",\n\t\tResponseType: \"code\",\n\t\tScopes: []string{\"openid\"},\n\t}\n\n\tresp, err := client.IDP.OAuth.AuthorizeStart(context.Background(), params)\n\tif err != nil {\n\t\tlog.Fatalf(\"error in method call: %v\", err)\n\t}\n\n\tlog.Println(resp)\n}\n"
- lang: java
label: Java
source: "// POST /v1/b2b/idp/oauth/authorize/start\npackage com.example;\n\nimport com.stytch.java.b2b.models.idpoauth.AuthorizeStartRequest;\nimport com.stytch.java.b2b.StytchB2BClient;\nimport com.stytch.java.common.StytchResult;\n\npublic class Main {\n public static void main(String[] args) {\n StytchB2BClient.configure(\"${projectId}\", \"${secret}\");\n\n AuthorizeStartRequest params = new AuthorizeStartRequest();\n params.setClientId(\"${exampleConnectedAppClientID}\");\n params.setRedirectUri(\"https://app.example/oauth/callback\");\n params.setResponseType(\"code\");\n params.setScopes(new String(\"openid\"));\n\n Object result = StytchB2BClient.getIDP().getOAuth().authorizeStart(params);\n if (result instanceof StytchResult.Success) {\n System.out.println(((StytchResult.Success) result).getValue());\n } else {\n System.out.println(((StytchResult.Error) result).getException());\n }\n }\n}"
- lang: kotlin
label: Kotlin
source: "// POST /v1/b2b/idp/oauth/authorize/start\npackage com.example\n\nimport com.stytch.java.b2b.StytchB2BClient\nimport com.stytch.java.b2b.models.idpoauth.AuthorizeStartRequest\n\nfun main() {\n StytchB2BClient.configure(\n projectId = \"${projectId}\",\n secret = \"${secret}\",\n )\n\n when (\n val result =\n StytchB2BClient.idp.oauth.authorizeStart(\n AuthorizeStartRequest(\n clientId = \"${exampleConnectedAppClientID}\",\n redirectUri = \"https://app.example/oauth/callback\",\n responseType = \"code\",\n scopes = arrayOf(\"openid\"),\n ),\n )\n ) {\n is StytchResult.Success -> println(result.value)\n is StytchResult.Error -> println(result.exception)\n }\n}\n"
- lang: javascript
label: Node.js
source: "// POST /v1/b2b/idp/oauth/authorize/start\nconst stytch = require('stytch');\n\nconst client = new stytch.B2BClient({\n project_id: '${projectId}',\n secret: '${secret}',\n});\n\nconst params = {\n client_id: \"${exampleConnectedAppClientID}\",\n redirect_uri: \"https://app.example/oauth/callback\",\n response_type: \"code\",\n scopes: [\"openid\"],\n};\n\nclient.idp.oauth.authorizeStart(params)\n .then(resp => { console.log(resp) })\n .catch(err => { console.log(err) });"
- lang: php
label: PHP
source: "$response = $client->idp->oauth->authorize_start([\n 'client_id' => '${exampleConnectedAppClientID}',\n 'redirect_uri' => 'https://app.example/oauth/callback',\n 'response_type' => 'code',\n 'scopes' => ['openid'],\n]);"
- lang: python
label: Python
source: "# POST /v1/b2b/idp/oauth/authorize/start\nfrom stytch import B2BClient\n\nclient = B2BClient(\n project_id=\"${projectId}\",\n secret=\"${secret}\",\n)\n\nresp = client.idp.oauth.authorize_start(\n client_id=\"${exampleConnectedAppClientID}\",\n redirect_uri=\"https://app.example/oauth/callback\",\n response_type=\"code\",\n scopes=[\"openid\"],\n)\n\nprint(resp)\n"
- lang: ruby
label: Ruby
source: "# POST /v1/b2b/idp/oauth/authorize/start\nrequire 'stytch'\n\nclient = StytchB2B::Client.new(\n project_id: \"${projectId}\",\n secret: \"${secret}\"\n)\n\nresp = client.idp.oauth.authorize_start(\n client_id: \"${exampleConnectedAppClientID}\",\n redirect_uri: \"https://app.example/oauth/callback\",\n response_type: \"code\",\n scopes: ['openid']\n \n)\n\nputs resp"
- lang: rust
label: Rust
source: "// POST /v1/b2b/idp/oauth/authorize/start\nuse stytch::b2b::client::Client;\nuse stytch::b2b::idp_oauth::AuthorizeStartRequest;\n\nfn main() {\n let client = Client::new(\"${projectId}\", \"${secret}\").unwrap();\n let resp = client.idp.oauth.authorize_start(\n AuthorizeStartRequest{\n client_id: \"${exampleConnectedAppClientID}\",\n redirect_uri: \"https://app.example/oauth/callback\",\n response_type: \"code\",\n scopes: vec![\"openid\"],\n ..Default::default()\n }\n ).await;\n println!(\"The response is {:?}\", resp);\n}"
- lang: bash
label: cURL
source: "# POST /v1/b2b/idp/oauth/authorize/start\ncurl --request POST \\\n --url https://test.stytch.com/v1/b2b/idp/oauth/authorize/start \\\n -u '${projectId}:${secret}' \\\n -H 'Content-Type: application/json' \\\n -d '{\n \"client_id\": \"${exampleConnectedAppClientID}\",\n \"redirect_uri\": \"https://app.example/oauth/callback\",\n \"response_type\": \"code\",\n \"scopes\": [\"openid\"]\n }'"
/v1/b2b/idp/oauth/authorize:
post:
summary: Authorize
operationId: api_b2b_idp_v1_b2b_idp_oauth_Authorize
tags:
- B2B IDP
description: 'Completes a request for authorization of a Connected App to access a Member''s account.
Call this endpoint using the query parameters from an OAuth Authorization request, after previously validating those parameters using the
[Preflight Check](https://stytch.com/docs/b2b/api/connected-apps-oauth-authorize-start) API.
Note that this endpoint takes in a few additional parameters the preflight check does not- `state`, `nonce`, and `code_challenge`.
If the authorization was successful, the `redirect_uri` will contain a valid `authorization_code` embedded as a query parameter.
If the authorization was unsuccessful, the `redirect_uri` will contain an OAuth2.1 `error_code`.
In both cases, redirect the Member to the location for the response to be consumed by the Connected App.
Exactly one of the following must be provided to identify the Member granting authorization:
- `organization_id` + `member_id`
- `session_token`
- `session_jwt`
If a `session_token` or `session_jwt` is passed, the OAuth Authorization will be linked to the Member''s session for tracking purposes.
One of these fields must be used if the Connected App intends to complete the [Exchange Access Token](https://stytch.com/docs/b2b/api/connected-app-access-token-exchange) flow.'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/api_b2b_idp_v1_b2b_idp_oauth_AuthorizeRequest'
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/api_b2b_idp_v1_b2b_idp_oauth_AuthorizeResponse'
'400':
description: Bad request
'401':
description: Unauthorized
content:
application/json:
example:
status_code: 401
request_id: request-id-test-b05c992f-ebdc-489d-a754-c7e70ba13141
error_type: unauthorized_credentials
error_message: Unauthorized credentials.
error_url: https://stytch.com/docs/api/errors/401
'429':
description: Too Many Requests
content:
application/json:
example:
status_code: 429
request_id: request-id-test-b05c992f-ebdc-489d-a754-c7e70ba13141
error_type: too_many_requests
error_message: Too many requests have been made.
error_url: https://stytch.com/docs/api/errors/429
'500':
description: Internal server error
content:
application/json:
example:
status_code: 500
request_id: request-id-test-b05c992f-ebdc-489d-a754-c7e70ba13141
error_type: internal_server_error
error_message: Oops, something seems to have gone wrong, please reach out to support@stytch.com to let us know what went wrong.
error_url: https://stytch.com/docs/api/errors/500
x-code-samples:
- lang: csharp
label: C#
source: "// POST /v1/b2b/idp/oauth/authorize\nconst stytch = require('stytch');\n\nconst client = new stytch.B2BClient({\n project_id: '${projectId}',\n secret: '${secret}',\n});\n\nconst params = {\n consent_granted: true,\n scopes: [\"openid\"],\n client_id: \"${exampleConnectedAppClientID}\",\n redirect_uri: \"https://app.example/oauth/callback\",\n response_type: \"code\",\n};\n\nclient.IDP.OAuth.Authorize(params)\n .then(resp => { console.log(resp) })\n .catch(err => { console.log(err) });"
- lang: go
label: Go
source: "// POST /v1/b2b/idp/oauth/authorize\npackage main\n\nimport (\n\t\"context\"\n\t\"log\"\n\n\t\"github.com/stytchauth/stytch-go/v17/stytch/b2b/b2bstytchapi\"\n\t\"github.com/stytchauth/stytch-go/v17/stytch/b2b/idp/oauth\"\n)\n\nfunc main() {\n\tclient, err := b2bstytchapi.NewClient(\n\t\t\"${projectId}\",\n\t\t\"${secret}\",\n\t)\n\tif err != nil {\n\t\tlog.Fatalf(\"error instantiating client: %v\", err)\n\t}\n\n\tparams := &oauth.AuthorizeParams{\n\t\tConsentGranted: true,\n\t\tScopes: []string{\"openid\"},\n\t\tClientID: \"${exampleConnectedAppClientID}\",\n\t\tRedirectURI: \"https://app.example/oauth/callback\",\n\t\tResponseType: \"code\",\n\t}\n\n\tresp, err := client.IDP.OAuth.Authorize(context.Background(), params)\n\tif err != nil {\n\t\tlog.Fatalf(\"error in method call: %v\", err)\n\t}\n\n\tlog.Println(resp)\n}\n"
- lang: java
label: Java
source: "// POST /v1/b2b/idp/oauth/authorize\npackage com.example;\n\nimport com.stytch.java.b2b.models.idpoauth.AuthorizeRequest;\nimport com.stytch.java.b2b.StytchB2BClient;\nimport com.stytch.java.common.StytchResult;\n\npublic class Main {\n public static void main(String[] args) {\n StytchB2BClient.configure(\"${projectId}\", \"${secret}\");\n\n AuthorizeRequest params = new AuthorizeRequest();\n params.setConsentGranted(true);\n params.setScopes(new String(\"openid\"));\n params.setClientId(\"${exampleConnectedAppClientID}\");\n params.setRedirectUri(\"https://app.example/oauth/callback\");\n params.setResponseType(\"code\");\n\n Object result = StytchB2BClient.getIDP().getOAuth().authorize(params);\n if (result instanceof StytchResult.Success) {\n System.out.println(((StytchResult.Success) result).getValue());\n } else {\n System.out.println(((StytchResult.Error) result).getException());\n }\n }\n}"
- lang: kotlin
label: Kotlin
source: "// POST /v1/b2b/idp/oauth/authorize\npackage com.example\n\nimport com.stytch.java.b2b.StytchB2BClient\nimport com.stytch.java.b2b.models.idpoauth.AuthorizeRequest\n\nfun main() {\n StytchB2BClient.configure(\n projectId = \"${projectId}\",\n secret = \"${secret}\",\n )\n\n when (\n val result =\n StytchB2BClient.idp.oauth.authorize(\n AuthorizeRequest(\n consentGranted = true,\n scopes = arrayOf(\"openid\"),\n clientId = \"${exampleConnectedAppClientID}\",\n redirectUri = \"https://app.example/oauth/callback\",\n responseType = \"code\",\n ),\n )\n ) {\n is StytchResult.Success -> println(result.value)\n is StytchResult.Error -> println(result.exception)\n }\n}\n"
- lang: javascript
label: Node.js
source: "// POST /v1/b2b/idp/oauth/authorize\nconst stytch = require('stytch');\n\nconst client = new stytch.B2BClient({\n project_id: '${projectId}',\n secret: '${secret}',\n});\n\nconst params = {\n consent_granted: true,\n scopes: [\"openid\"],\n client_id: \"${exampleConnectedAppClientID}\",\n redirect_uri: \"https://app.example/oauth/callback\",\n response_type: \"code\",\n};\n\nclient.idp.oauth.authorize(params)\n .then(resp => { console.log(resp) })\n .catch(err => { console.log(err) });"
- lang: php
label: PHP
source: "$response = $client->idp->oauth->authorize([\n 'consent_granted' => true,\n 'scopes' => ['openid'],\n 'client_id' => '${exampleConnectedAppClientID}',\n 'redirect_uri' => 'https://app.example/oauth/callback',\n 'response_type' => 'code',\n]);"
- lang: python
label: Python
source: "# POST /v1/b2b/idp/oauth/authorize\nfrom stytch import B2BClient\n\nclient = B2BClient(\n project_id=\"${projectId}\",\n secret=\"${secret}\",\n)\n\nresp = client.idp.oauth.authorize(\n consent_granted=True,\n scopes=[\"openid\"],\n client_id=\"${exampleConnectedAppClientID}\",\n redirect_uri=\"https://app.example/oauth/callback\",\n response_type=\"code\",\n)\n\nprint(resp)\n"
- lang: ruby
label: Ruby
source: "# POST /v1/b2b/idp/oauth/authorize\nrequire 'stytch'\n\nclient = StytchB2B::Client.new(\n project_id: \"${projectId}\",\n secret: \"${secret}\"\n)\n\nresp = client.idp.oauth.authorize(\n consent_granted: true,\n scopes: ['openid'],\n client_id: \"${exampleConnectedAppClientID}\",\n redirect_uri: \"https://app.example/oauth/callback\",\n response_type: \"code\"\n \n)\n\nputs resp"
- lang: rust
label: Rust
source: "// POST /v1/b2b/idp/oauth/authorize\nuse stytch::b2b::client::Client;\nuse stytch::b2b::idp_oauth::AuthorizeRequest;\n\nfn main() {\n let client = Client::new(\"${projectId}\", \"${secret}\").unwrap();\n let resp = client.idp.oauth.authorize(\n AuthorizeRequest{\n consent_granted: true,\n scopes: vec![\"openid\"],\n client_id: \"${exampleConnectedAppClientID}\",\n redirect_uri: \"https://app.example/oauth/callback\",\n response_type: \"code\",\n ..Default::default()\n }\n ).await;\n println!(\"The response is {:?}\", resp);\n}"
- lang: bash
label: cURL
source: "# POST /v1/b2b/idp/oauth/authorize\ncurl --request POST \\\n --url https://test.stytch.com/v1/b2b/idp/oauth/authorize \\\n -u '${projectId}:${secret}' \\\n -H 'Content-Type: application/json' \\\n -d '{\n \"consent_granted\": true,\n \"scopes\": [\"openid\"],\n \"client_id\": \"${exampleConnectedAppClientID}\",\n \"redirect_uri\": \"https://app.example/oauth/callback\",\n \"response_type\": \"code\"\n }'"
components:
schemas:
api_organization_v1_ActiveSSOConnection:
type: object
properties:
connection_id:
type: string
description: Globally unique UUID that identifies a specific SSO `connection_id` for a Member.
display_name:
type: string
description: A human-readable display name for the connection.
identity_provider:
type: string
required:
- connection_id
- display_name
- identity_provider
api_connectedapps_v1_ConnectedAppPublic:
type: object
properties:
client_id:
type: string
client_name:
type: string
client_description:
type: string
client_type:
type: string
logo_url:
type: string
required:
- client_id
- client_name
- client_description
- client_type
api_organization_v1_Organization:
type: object
properties:
organization_id:
type: string
description: Globally unique UUID that identifies a specific Organization. The `organization_id` is critical to perform operations on an Organization, so be sure to preserve this value. You may also use the organization_slug or organization_external_id here as a convenience.
organization_name:
type: string
description: The name of the Organization. Must be between 1 and 128 characters in length.
organization_logo_url:
type: string
description: The image URL of the Organization logo.
organization_slug:
type: string
description: 'The unique URL slug of the Organization. The slug only accepts alphanumeric characters and the following reserved characters: `-` `.` `_` `~`. Must be between 2 and 128 characters in length. Wherever an organization_id is expected in a path or request parameter, you may also use the organization_slug as a convenience.'
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` – the default setting, new Members will be automatically provisioned upon successful authentication via any of the Organization's `sso_active_connections`.\n \n `RESTRICTED` – only new Members with SSO logins that comply with `sso_jit_provisioning_allowed_connections` can be provisioned upon authentication.\n \n `NOT_ALLOWED` – disable JIT provisioning via SSO.\n "
sso_jit_provisioning_allowed_connections:
type: array
items:
type: string
description: "An array of `connection_id`s that reference [SAML Connection objects](https://stytch.com/docs/b2b/api/saml-connection-object).\n Only these connections will be allowed to JIT provision Members via SSO when `sso_jit_provisioning` is set to `RESTRICTED`."
sso_active_connections:
type: array
items:
$ref: '#/components/schemas/api_organization_v1_ActiveSSOConnection'
description: An array of active [SAML Connection references](https://stytch.com/docs/b2b/api/saml-connection-object) or [OIDC Connection references](https://stytch.com/docs/b2b/api/oidc-connection-object).
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` – 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` – 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` – any new Member can be invited to join via email.\n \n `RESTRICTED` – only new Members with verified emails that comply with `email_allowed_domains` can be invited via email.\n \n `NOT_ALLOWED` – 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` – the default setting which allows all authentication methods to be used.\n \n `RESTRICTED` – 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` – 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` – 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` – the default setting which allows all authentication methods to be used.\n \n `RESTRICTED` – 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` – only new Members with tenants in `allowed_oauth_tenants` can JIT provision via tenant.\n \n `NOT_ALLOWED` – the default setting, disables JIT provisioning by OAuth Tenant.\n "
claimed_email_domains:
type: array
items:
type: string
description: A list of email domains that are claimed by the Organization.
first_party_connected_apps_allowed_type:
type: string
description: "The authentication setting that sets the Organization's policy towards first party Connected Apps. The accepted values are:\n \n `ALL_ALLOWED` – the default setting, any first party Connected App in the Project is permitted for use by Members.\n \n `RESTRICTED` – only first party Connected Apps with IDs in `allowed_first_party_connected_apps` can be used by Members.\n \n `NOT_ALLOWED` – 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:
type: string
description: "The authentication setting that sets the Organization's policy towards third party Connected Apps. The accepted values are:\n \n `ALL_ALLOWED` – the default setting, any third party Connected App in the Project is permitted for use by Members.\n \n `RESTRICTED` – only third party Connected Apps with IDs in `allowed_first_party_connected_apps` can be used by Members.\n \n `NOT_ALLOWED` – 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`.
custom_roles:
type: array
items:
$ref: '#/components/schemas/api_organization_v1_CustomRole'
trusted_metadata:
type: object
additionalProperties: true
description: An arbitrary JSON object for storing application-specific data or identity-provider-specific data.
created_at:
type: string
description: The timestamp of the Organization's creation. Values conform to the RFC 3339 standard and are expressed in UTC, e.g. `2021-12-29T12:33:09Z`.
updated_at:
type: string
description: The timestamp of when the Organization was last updated. Values conform to the RFC 3339 standard and are expressed in UTC, e.g. `2021-12-29T12:33:09Z`.
organization_external_id:
type: string
description: A unique identifier for the organization.
sso_default_connection_id:
type: string
description: The default connection used for SSO when there are multiple active connections.
scim_active_connection:
$ref: '#/components/schemas/api_organization_v1_ActiveSCIMConnection'
description: An active [SCIM Connection references](https://stytch.com/docs/b2b/api/scim-connection-object).
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".
required:
- organization_id
- organization_name
- organization_logo_url
- organization_slug
- sso_jit_provisioning
- sso_jit_provisioning_allowed_connections
- sso_active_connections
- email_allowed_domains
- email_jit_provisioning
- email_invites
- auth_methods
- allowed_auth_methods
- mfa_policy
- rbac_email_implicit_role_assignments
- mfa_methods
- allowed_mfa_methods
- oauth_tenant_jit_provisioning
- claimed_email_domains
- first_party_connected_apps_allowed_type
- allowed_first_party_connected_apps
- third_party_connected_apps_allowed_type
- allowed_third_party_connected_apps
- custom_roles
api_b2b_idp_v1_b2b_idp_oauth_AuthorizeRequest:
type: object
properties:
consent_granted:
type: boolean
description: Indicates whether the user granted the requested scopes.
scopes:
type: array
items:
type: string
description: An array of scopes requested by the client.
client_id:
type: string
description: The ID of the Connected App client.
redirect_uri:
type: string
descriptio
# --- truncated at 32 KB (61 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/stytch/refs/heads/main/openapi/stytch-b2b-idp-api-openapi.yml