Skip to content

Commit d2a17c4

Browse files
aeneasraeneasr
committed
docs: bump to 3938f690127a9f0640024391169aab245de3af4d
1 parent 5bd0fad commit d2a17c4

File tree

1 file changed

+147
-3
lines changed

1 file changed

+147
-3
lines changed

‎docs/reference/api.json

Lines changed: 147 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4185,6 +4185,9 @@
41854185
},
41864186
"password": {
41874187
"$ref": "#/components/schemas/identityWithCredentialsPassword"
4188+
},
4189+
"saml": {
4190+
"$ref": "#/components/schemas/identityWithCredentialsSaml"
41884191
}
41894192
},
41904193
"type": "object"
@@ -4200,9 +4203,6 @@
42004203
},
42014204
"identityWithCredentialsOidcConfig": {
42024205
"properties": {
4203-
"config": {
4204-
"$ref": "#/components/schemas/identityWithCredentialsPasswordConfig"
4205-
},
42064206
"providers": {
42074207
"description": "A list of OpenID Connect Providers",
42084208
"items": {
@@ -4216,6 +4216,9 @@
42164216
"identityWithCredentialsOidcConfigProvider": {
42174217
"description": "Create Identity and Import Social Sign In Credentials Configuration",
42184218
"properties": {
4219+
"organization": {
4220+
"$ref": "#/components/schemas/NullUUID"
4221+
},
42194222
"provider": {
42204223
"description": "The OpenID Connect provider to link the subject to. Usually something like `google` or `github`.",
42214224
"type": "string"
@@ -4259,6 +4262,46 @@
42594262
},
42604263
"type": "object"
42614264
},
4265+
"identityWithCredentialsSaml": {
4266+
"description": "Payload to import SAML credentials",
4267+
"properties": {
4268+
"config": {
4269+
"$ref": "#/components/schemas/identityWithCredentialsSamlConfig"
4270+
}
4271+
},
4272+
"type": "object"
4273+
},
4274+
"identityWithCredentialsSamlConfig": {
4275+
"description": "Payload of SAML providers",
4276+
"properties": {
4277+
"providers": {
4278+
"description": "A list of SAML Providers",
4279+
"items": {
4280+
"$ref": "#/components/schemas/identityWithCredentialsSamlConfigProvider"
4281+
},
4282+
"type": "array"
4283+
}
4284+
},
4285+
"type": "object"
4286+
},
4287+
"identityWithCredentialsSamlConfigProvider": {
4288+
"description": "Payload of specific SAML provider",
4289+
"properties": {
4290+
"organization": {
4291+
"$ref": "#/components/schemas/NullUUID"
4292+
},
4293+
"provider": {
4294+
"description": "The SAML provider to link the subject to.",
4295+
"type": "string"
4296+
},
4297+
"subject": {
4298+
"description": "The unique subject of the SAML connection. This value must be immutable at the source.",
4299+
"type": "string"
4300+
}
4301+
},
4302+
"required": ["subject", "provider"],
4303+
"type": "object"
4304+
},
42624305
"internalGetProjectBrandingBody": {
42634306
"description": "Get Project Branding Request Body",
42644307
"properties": {
@@ -9326,6 +9369,7 @@
93269369
"discriminator": {
93279370
"mapping": {
93289371
"a": "#/components/schemas/uiNodeAnchorAttributes",
9372+
"div": "#/components/schemas/uiNodeDivisionAttributes",
93299373
"img": "#/components/schemas/uiNodeImageAttributes",
93309374
"input": "#/components/schemas/uiNodeInputAttributes",
93319375
"script": "#/components/schemas/uiNodeScriptAttributes",
@@ -9348,6 +9392,9 @@
93489392
},
93499393
{
93509394
"$ref": "#/components/schemas/uiNodeScriptAttributes"
9395+
},
9396+
{
9397+
"$ref": "#/components/schemas/uiNodeDivisionAttributes"
93519398
}
93529399
],
93539400
"title": "Attributes represents a list of attributes (e.g. `href=\"foo\"` for links)."
@@ -9681,6 +9728,7 @@
96819728
"oidc": "#/components/schemas/updateLoginFlowWithOidcMethod",
96829729
"passkey": "#/components/schemas/updateLoginFlowWithPasskeyMethod",
96839730
"password": "#/components/schemas/updateLoginFlowWithPasswordMethod",
9731+
"saml": "#/components/schemas/updateLoginFlowWithSamlMethod",
96849732
"totp": "#/components/schemas/updateLoginFlowWithTotpMethod",
96859733
"webauthn": "#/components/schemas/updateLoginFlowWithWebAuthnMethod"
96869734
},
@@ -9693,6 +9741,9 @@
96939741
{
96949742
"$ref": "#/components/schemas/updateLoginFlowWithOidcMethod"
96959743
},
9744+
{
9745+
"$ref": "#/components/schemas/updateLoginFlowWithSamlMethod"
9746+
},
96969747
{
96979748
"$ref": "#/components/schemas/updateLoginFlowWithTotpMethod"
96989749
},
@@ -9879,6 +9930,29 @@
98799930
"required": ["method", "password", "identifier"],
98809931
"type": "object"
98819932
},
9933+
"updateLoginFlowWithSamlMethod": {
9934+
"description": "Update login flow using SAML",
9935+
"properties": {
9936+
"csrf_token": {
9937+
"description": "The CSRF Token",
9938+
"type": "string"
9939+
},
9940+
"method": {
9941+
"description": "Method to use\n\nThis field must be set to `saml` when using the saml method.",
9942+
"type": "string"
9943+
},
9944+
"provider": {
9945+
"description": "The provider to register with",
9946+
"type": "string"
9947+
},
9948+
"transient_payload": {
9949+
"description": "Transient data to pass along to any webhooks",
9950+
"type": "object"
9951+
}
9952+
},
9953+
"required": ["provider", "method"],
9954+
"type": "object"
9955+
},
98829956
"updateLoginFlowWithTotpMethod": {
98839957
"description": "Update Login Flow with TOTP Method",
98849958
"properties": {
@@ -10010,6 +10084,7 @@
1001010084
"passkey": "#/components/schemas/updateRegistrationFlowWithPasskeyMethod",
1001110085
"password": "#/components/schemas/updateRegistrationFlowWithPasswordMethod",
1001210086
"profile": "#/components/schemas/updateRegistrationFlowWithProfileMethod",
10087+
"saml": "#/components/schemas/updateRegistrationFlowWithSamlMethod",
1001310088
"webauthn": "#/components/schemas/updateRegistrationFlowWithWebAuthnMethod"
1001410089
},
1001510090
"propertyName": "method"
@@ -10021,6 +10096,9 @@
1002110096
{
1002210097
"$ref": "#/components/schemas/updateRegistrationFlowWithOidcMethod"
1002310098
},
10099+
{
10100+
"$ref": "#/components/schemas/updateRegistrationFlowWithSamlMethod"
10101+
},
1002410102
{
1002510103
"$ref": "#/components/schemas/updateRegistrationFlowWithWebAuthnMethod"
1002610104
},
@@ -10188,6 +10266,33 @@
1018810266
"required": ["traits", "method"],
1018910267
"type": "object"
1019010268
},
10269+
"updateRegistrationFlowWithSamlMethod": {
10270+
"description": "Update registration flow using SAML",
10271+
"properties": {
10272+
"csrf_token": {
10273+
"description": "The CSRF Token",
10274+
"type": "string"
10275+
},
10276+
"method": {
10277+
"description": "Method to use\n\nThis field must be set to `saml` when using the saml method.",
10278+
"type": "string"
10279+
},
10280+
"provider": {
10281+
"description": "The provider to register with",
10282+
"type": "string"
10283+
},
10284+
"traits": {
10285+
"description": "The identity traits",
10286+
"type": "object"
10287+
},
10288+
"transient_payload": {
10289+
"description": "Transient data to pass along to any webhooks",
10290+
"type": "object"
10291+
}
10292+
},
10293+
"required": ["provider", "method"],
10294+
"type": "object"
10295+
},
1019110296
"updateRegistrationFlowWithWebAuthnMethod": {
1019210297
"description": "Update Registration Flow with WebAuthn Method",
1019310298
"properties": {
@@ -10228,6 +10333,7 @@
1022810333
"passkey": "#/components/schemas/updateSettingsFlowWithPasskeyMethod",
1022910334
"password": "#/components/schemas/updateSettingsFlowWithPasswordMethod",
1023010335
"profile": "#/components/schemas/updateSettingsFlowWithProfileMethod",
10336+
"saml": "#/components/schemas/updateSettingsFlowWithSamlMethod",
1023110337
"totp": "#/components/schemas/updateSettingsFlowWithTotpMethod",
1023210338
"webauthn": "#/components/schemas/updateSettingsFlowWithWebAuthnMethod"
1023310339
},
@@ -10243,6 +10349,9 @@
1024310349
{
1024410350
"$ref": "#/components/schemas/updateSettingsFlowWithOidcMethod"
1024510351
},
10352+
{
10353+
"$ref": "#/components/schemas/updateSettingsFlowWithSamlMethod"
10354+
},
1024610355
{
1024710356
"$ref": "#/components/schemas/updateSettingsFlowWithTotpMethod"
1024810357
},
@@ -10396,6 +10505,41 @@
1039610505
"required": ["traits", "method"],
1039710506
"type": "object"
1039810507
},
10508+
"updateSettingsFlowWithSamlMethod": {
10509+
"description": "Update settings flow using SAML",
10510+
"properties": {
10511+
"csrf_token": {
10512+
"description": "The CSRF Token",
10513+
"type": "string"
10514+
},
10515+
"flow": {
10516+
"description": "Flow ID is the flow's ID.\n\nin: query",
10517+
"type": "string"
10518+
},
10519+
"link": {
10520+
"description": "Link this provider\n\nEither this or `unlink` must be set.\n\ntype: string\nin: body",
10521+
"type": "string"
10522+
},
10523+
"method": {
10524+
"description": "Method\n\nShould be set to saml when trying to update a profile.",
10525+
"type": "string"
10526+
},
10527+
"traits": {
10528+
"description": "The identity's traits\n\nin: body",
10529+
"type": "object"
10530+
},
10531+
"transient_payload": {
10532+
"description": "Transient data to pass along to any webhooks",
10533+
"type": "object"
10534+
},
10535+
"unlink": {
10536+
"description": "Unlink this provider\n\nEither this or `link` must be set.\n\ntype: string\nin: body",
10537+
"type": "string"
10538+
}
10539+
},
10540+
"required": ["method"],
10541+
"type": "object"
10542+
},
1039910543
"updateSettingsFlowWithTotpMethod": {
1040010544
"description": "Update Settings Flow with TOTP Method",
1040110545
"properties": {

0 commit comments

Comments
 (0)