Infrastructure/logto
0
Fork 0
mirror of https://github.com/logto-io/logto.git synced 2025-02-17 22:04:19 -05:00
Code Issues Activity

feat(core): add sso-connectors openapi file (#5040)

Browse source 
* feat(core): add sso api doc

add sso api doc

* chore(core): polish docs

* chore(core): polish docs

---------

Co-authored-by: Gao Sun <gao@silverhand.io>
This commit is contained in:
simeng-li 2023-12-02 22:34:47 +08:00 • committed by GitHub
parent 00dc158c70
commit b1461b42ea
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 87 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

87
packages/core/src/routes/sso-connector/index.openapi.json Normal file
View file

@ -0,0 +1,87 @@
{
"tags": [
{
"name": "Sso connectors",
"description": "APIs for managing single sign-on (SSO) connectors. Your sign-in experience can use these well-configured SSO connectors to authenticate users and sync user attributes from external identity providers (IdPs).\n\nSSO connectors are created by SSO connector factories."
}
],
"paths": {
"/api/sso-connector-factories": {
"summary": "APIs for SSO (single sign-on) connector factories",
"description": "SSO connector factories are used to create Enterprise SSO connectors. The created connectors are used to connect to external SSO providers.",
"get": {
"summary": "Get SSO connector factories",
"description": "Returns all SSO connector factories, including standard protocol factories and pre-configured SSO providers (e.g. Google Workspace, Okta, etc.).",
"responses": {
"200": {
"description": "An array of SSO connector factories."
}
}
}
},
"/api/sso-connectors": {
"get": {
"summary": "List SSO connectors",
"description": "Get SSO connectors with pagination. In addition to the raw SSO connector data, a copy of fetched or parsed IdP configs and a copy of connector factory's data will be attached.",
"responses": {
"200": {
"description": "An array of SSO connectors."
}
}
},
"post": {
"summary": "Create SSO connector",
"description": "Create an new SSO connector by a specified connector factory.",
"responses": {
"200": {
"description": "The created SSO connector."
},
"422": {
"description": "At lease one of the given input fields is invalid or IdP connection cannot be verified with the given config."
}
}
}
},
"/api/sso-connectors/{id}": {
"get": {
"summary": "Get SSO connector",
"description": "Get SSO connector data by ID. In addition to the raw SSO connector data, a copy of fetched or parsed IdP configs and a copy of connector factory's data will be attached.",
"responses": {
"200": {
"description": "The SSO connector data with the given ID."
},
"404": {
"description": "SSO connector not found."
}
}
},
"delete": {
"summary": "Delete SSO connector",
"description": "Delete an SSO connector by ID.",
"responses": {
"204": {
"description": "SSO connector deleted successfully."
},
"404": {
"description": "SSO connector not found."
}
}
},
"patch": {
"summary": "Update SSO connector",
"description": "Update an SSO connector by ID. This method performs a partial update.",
"responses": {
"200": {
"description": "The updated SSO connector."
},
"404": {
"description": "SSO connector not found."
},
"422": {
"description": "At lease one of the update fields is invalid or IdP connection can not be verified with the given connection config."
}
}
}
}
}
}