Skip to content

Commit

Permalink
chore: add api docs
Browse files Browse the repository at this point in the history
  • Loading branch information
gao-sun committed Jun 6, 2024
1 parent b85ecb6 commit 056c30d
Showing 1 changed file with 85 additions and 0 deletions.
Original file line number Diff line number Diff line change
@@ -0,0 +1,85 @@
{
"tags": ["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": [
{
"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."
}
}
}
}
}
}

0 comments on commit 056c30d

Please sign in to comment.