-
-
Notifications
You must be signed in to change notification settings - Fork 413
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
90 additions
and
0 deletions.
There are no files selected for viewing
90 changes: 90 additions & 0 deletions
90
packages/core/src/routes/organization/index.email-domain.openapi.json
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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." | ||
} | ||
} | ||
} | ||
} | ||
} | ||
} |