Infrastructure/logto
0
Fork 0
mirror of https://github.com/logto-io/logto.git synced 2024-12-16 20:26:19 -05:00
Code Issues Activity

chore(core): add sign-in experience api doc descriptions (#5019)

Browse source
This commit is contained in:
Xiao Yijun 2023-12-01 11:03:00 +08:00 committed by GitHub
parent a49c3c33f7
commit 65306682ec
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 137 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

137
packages/core/src/routes/sign-in-experience/index.openapi.json Normal file
View file

@ -0,0 +1,137 @@
{
"tags": [
{
"name": "Sign in exp",
"description": "Set the Sign-in experience configuration to customize your sign-in experience."
}
],
"paths": {
"/api/sign-in-exp": {
"get": {
"summary": "Get default sign-in experience settings",
"description": "Get the default sign-in experience settings.",
"responses": {
"200": {
"description": "Default sign-in experience settings.",
"content": {
"application/json": {
"schema": {
"properties": {
"color": {
"description": "The primary branding color for the sign-in page (both light/dark mode)."
},
"languageInfo": {
"description": "The language detection policy for the sign-in page."
},
"signIn": {
"description": "Sign-in method settings"
},
"signUp": {
"description": "Sign-up method settings",
"properties": {
"identifiers": {
"description": "Allowed identifiers when signing-up."
},
"password": {
"description": "Whether the user is required to set a password when signing-up."
},
"verify": {
"description": "Whether the user is required to verify their email/phone when signing-up."
}
}
},
"socialSignInConnectorTargets": {
"description": "Enabled social sign-in connectors, will displayed on the sign-in page."
},
"customContent": {
"description": "Custom content to display on experience flow pages. the page pathname will be the config key, the content will be the config value."
},
"passwordPolicy": {
"description": "Password policies to adjust the password strength requirements."
},
"mfa": {
"description": "MFA settings"
}
}
}
}
}
},
"404": {
"description": "Default sign-in experience settings not found."
}
}
},
"patch": {
"summary": "Update default sign-in experience settings",
"description": "Update the default sign-in experience settings with the provided data.",
"parameters": [
{
"name": "removeUnusedDemoSocialConnector",
"in": "query",
"description": "Whether to remove unused demo social connectors. (These demo social connectors are only used during cloud user onboarding)"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"properties": {
"color": {
"description": "Specify the primary branding color for the sign-in page (both light/dark mode)."
},
"languageInfo": {
"description": "Control the language detection policy for the sign-in page."
},
"signIn": {
"description": "Sign-in method settings"
},
"signUp": {
"description": "Sign-up method settings",
"properties": {
"identifiers": {
"description": "Specify allowed identifiers when signing-up."
},
"password": {
"description": "Whether the user is required to set a password when signing-up."
},
"verify": {
"description": "Whether the user is required to verify their email/phone when signing-up."
}
}
},
"socialSignInConnectorTargets": {
"description": "Specify the social sign-in connectors to display on the sign-in page."
},
"customContent": {
"description": "Custom content to display on experience flow pages. the page pathname will be the config key, the content will be the config value."
},
"passwordPolicy": {
"description": "Password policies to adjust the password strength requirements."
},
"mfa": {
"description": "MFA settings"
}
}
}
}
}
},
"responses": {
"200": {
"description": "Updated default sign-in experience settings."
},
"400": {
"description": "Bad request. Invalid data provided."
},
"404": {
"description": "Default sign-in experience settings not found."
},
"422": {
"description": "Unprocessable Entity. Invalid data provided."
}
}
}
}
}
}