|
|
|
@ -32,6 +32,8 @@ tags: |
|
|
|
|
description: Operations related to the UW LDAP directory |
|
|
|
|
- name: database |
|
|
|
|
description: Operations related to databases |
|
|
|
|
- name: cloud |
|
|
|
|
description: Operations related to the CSC Cloud |
|
|
|
|
security: |
|
|
|
|
- GSSAPIAuth: [] |
|
|
|
|
paths: |
|
|
|
@ -702,6 +704,59 @@ paths: |
|
|
|
|
$ref: "#/components/responses/UserNotFoundErrorResponse" |
|
|
|
|
"500": |
|
|
|
|
$ref: "#/components/responses/DBConnectionOrPermissionErrorResponse" |
|
|
|
|
/cloud/accounts/create: |
|
|
|
|
post: |
|
|
|
|
tags: ['cloud'] |
|
|
|
|
servers: |
|
|
|
|
- url: https://biloba.csclub.uwaterloo.ca:9987/api |
|
|
|
|
summary: Activate a cloud account |
|
|
|
|
description: Activate a cloud account for the calling user |
|
|
|
|
responses: |
|
|
|
|
"200": |
|
|
|
|
description: Success |
|
|
|
|
content: |
|
|
|
|
application/json: |
|
|
|
|
schema: |
|
|
|
|
type: object |
|
|
|
|
properties: |
|
|
|
|
status: |
|
|
|
|
type: string |
|
|
|
|
description: '"OK"' |
|
|
|
|
example: {"status": "OK"} |
|
|
|
|
"403": |
|
|
|
|
"$ref": "#/components/responses/InvalidMembershipErrorResponse" |
|
|
|
|
/cloud/accounts/purge: |
|
|
|
|
post: |
|
|
|
|
tags: ['cloud'] |
|
|
|
|
servers: |
|
|
|
|
- url: https://biloba.csclub.uwaterloo.ca:9987/api |
|
|
|
|
summary: Purge expired accounts |
|
|
|
|
description: | |
|
|
|
|
Delete the cloud accounts of expired members. |
|
|
|
|
|
|
|
|
|
There is a one-month grace period after the expiration. |
|
|
|
|
After one month, expired members will be sent an email warning them |
|
|
|
|
that their account will be deleted. |
|
|
|
|
One week after that, if an expired member has still not renewed their |
|
|
|
|
membership, their account will be deleted. |
|
|
|
|
responses: |
|
|
|
|
"200": |
|
|
|
|
description: Success |
|
|
|
|
content: |
|
|
|
|
application/json: |
|
|
|
|
schema: |
|
|
|
|
type: object |
|
|
|
|
properties: |
|
|
|
|
accounts_to_be_deleted: |
|
|
|
|
type: array |
|
|
|
|
description: usernames of accounts which will be deleted |
|
|
|
|
items: |
|
|
|
|
type: string |
|
|
|
|
accounts_deleted: |
|
|
|
|
type: array |
|
|
|
|
description: usernames of accounts which were deleted |
|
|
|
|
items: |
|
|
|
|
type: string |
|
|
|
|
components: |
|
|
|
|
securitySchemes: |
|
|
|
|
GSSAPIAuth: |
|
|
|
@ -874,3 +929,6 @@ components: |
|
|
|
|
DBConnectionOrPermissionErrorResponse: |
|
|
|
|
<<: *ErrorResponse |
|
|
|
|
description: Unable to connect to database or action failed due to permissions |
|
|
|
|
InvalidMembershipErrorResponse: |
|
|
|
|
<<: *ErrorResponse |
|
|
|
|
description: Membership is invalid or expired |
|
|
|
|