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

chore: add api docs

Browse source
This commit is contained in:
Gao Sun 2024-06-06 13:37:43 +08:00
parent b85ecb6c93
commit f6dbb0aad1
No known key found for this signature in database
GPG key ID: 13EBE123E4773688
1 changed files with 90 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

90
packages/core/src/routes/organization/index.email-domain.openapi.json Normal file
View file

@ -0,0 +1,90 @@
{
"tags": [{
"name": "Organizations"
}],
"paths": {
"/api/organizations/{id}/email-domains": {
"get": {
"summary": "Get organization email domains",
"description": "Get email domains for just-in-time provisioning of users in the organization.",
"responses": {
"200": {
"description": "A list of email domains."
}
}
},
"post": {
"summary": "Add organization email domain",
"description": "Add a new email domain for just-in-time provisioning of users in the organization.",
"requestBody": {
"content": {
"application/json": {
"schema": {
"properties": {
"emailDomain": {
"description": "The email domain to add."
}
}
}
}
}
},
"responses": {
"201": {
"description": "The email domain was added successfully."
},
"422": {
"description": "The email domain is already in use."
}
}
},
"put": {
"summary": "Replace organization email domains",
"description": "Replace all just-in-time provisioning email domains for the organization with the given data.",
"requestBody": {
"content": {
"application/json": {
"schema": {
"properties": {
"emailDomains": {
"description": "An array of email domains to replace existing email domains."
}
}
}
}
}
},
"responses": {
"204": {
"description": "The email domains were replaced successfully."
}
}
}
},
"/api/organizations/{id}/email-domains/{emailDomain}": {
"delete": {
"summary": "Remove organization email domain",
"description": "Remove an email domain for just-in-time provisioning of users in the organization.",
"parameters": [
{
"schema": {
"type": "string"
},
"name": "emailDomain",
"in": "path",
"required": true,
"description": "The email domain to remove."
}
],
"responses": {
"204": {
"description": "The email domain was removed successfully."
},
"404": {
"description": "The email domain was not found."
}
}
}
}
}
}