Onboard web application allows users to create VT accounts they need to access email, storage, and more.
Onboard entry points
The following entry points describe the urls to be used for various creation scenarios:
1. Creation of an APPLICANT ID on an existing APPLICANT User
Entrypoint
https://[dev.][pprd.]onboard.it.vt.edu/applicantCreate
Scenario
Used by an applicant who has created an account with Slate/Coalition and submitted an application to Virginia Tech to create their APPLICANT ID at Virginia Tech. The applicant must authenticate to Onboard by entering their VT ID 90 number, the email on the application, and DOB (date of birth). Additionally, the applicant must prove ownership of the email selected for the account.
Optional query params
- return_url: URL where Onboard will return the applicant at the end of account creation.
Must be in a whitelisted domain
- prod: vt.edu
- pprd: vt.edu, technolutions.net
- dev: vt.edu, technolutions.net
The URL host must be in a whitelisted domain or one of its subdomains (in prod, any *.vt.edu host). A return_url that is not whitelisted is silently ignored, and the success page shows the default button.
- admission type: Admission type (a) set to one of the following types:
- agtech sets the contact email address to agtech@vt.edu: URL?a=agtech
- grad sets the contact email address to grads@vt.edu: URL?a=grad
- undergrad sets the contact email address to admissions@vt.edu: URL?a=undergrad
- none provided. Default behavior sets the contact email address to admissions@vt.edu
To add to the whitelisted domains, please open a ticket at 4help for SIS Identity Strategy & Solutions.
2. Self-service creation of an APPLICANT ID
Entrypoint
https://[dev.][pprd.]onboard.it.vt.edu/onboardApplicantCreate
Scenario
Used by a person who needs an APPLICANT ID to log in to Slate and apply to Virginia Tech. The person must prove ownership of the email selected for the account.
Note: the previous URL /graduateApplicantCreate has been retired and now shows Not Found. Update existing links to /onboardApplicantCreate.
Optional query params
- return_url: URL where Onboard will return the applicant at the end of account creation.
Must be in a whitelisted domain
- prod: vt.edu
- pprd: vt.edu, technolutions.net
- dev: vt.edu, technolutions.net
The URL host must be in a whitelisted domain or one of its subdomains (in prod, any *.vt.edu host). A return_url that is not whitelisted is silently ignored and the success page shows the default button.
- admission type: Admission type (a) set to one of the following types:
- agtech sets the contact email address to agtech@vt.edu: URL?a=agtech
- grad sets the contact email address to grads@vt.edu: URL?a=grad
- undergrad sets the contact email address to admissions@vt.edu: URL?a=undergrad
- none provided. Default behavior sets the contact email address to grads@vt.edu
To add to the whitelisted domains, please open a ticket at 4help for SIS Identity Strategy & Solutions.
3. Self service/Gateway creation of Guest ID
Entrypoint
https://[dev.][pprd.]onboard.it.vt.edu/gatewayCreate
Scenario
Used by any user to create an Guest ID. User must prove ownership of the email selected for the account. Note: endpoint should not be used by an applicant.
Optional query params
- return_url: URL where Onboard will return the user at the end of account creation.
Must be in a whitelisted domain
- prod: vt.edu
- pprd: vt.edu, technolutions.net
- dev: vt.edu, technolutions.net
The URL host must be in a whitelisted domain or one of its subdomains (in prod, any *.vt.edu host). A return_url that is not whitelisted is silently ignored and the success page shows the default button.
To add to the whitelisted domains, please open a ticket at 4help for SIS Identity Strategy & Solutions.
4. Parent creation of Guest ID
Entrypoint
https://[dev.][pprd.]onboard.it.vt.edu/invitationCreate?token=tokenId
Scenario
Used by any user invited to create a Guest ID. User clicks on the link in the invitation email which takes them to Onboard with that tokenId. Onboard validates the token and allows the user to complete the Guest account creation. A typical user case is a parent invited by their student.
Optional login metadata
- return_url: URL where Onboard will return the user at the end of account creation. This must be presented to the
invitation process when creating the invitation as a key value pair. For eg:
curl -XPOST “https://apps[-dev.][-pprd.].middleware.vt.edu/ws/v2/accounts/?email=emailId&kv=return_url=https://example.vt.edu”.
Must be in a whitelisted domain.- prod: vt.edu
- pprd: vt.edu, technolutions.net
- dev: vt.edu, technolutions.net
5. Applicant creation of VT Username
Entrypoint
https://[dev.][pprd.]login.vt.edu/profile/cas/login?service=https%3A%2F%2F[dev.][pprd.]onboard.it.vt.edu%2Fsso
Scenario
Used by a student applicant who has an APPLICANT ID to create VT Username. The applicant must authenticate to Onboard by logging in with their APPLICANT ID.
6. Creation of VT username
Entrypoint
https://[dev.][pprd.]onboard.it.vt.edu
Scenario
Used by any qualifying user to create VT Username. User must authenticate to Onboard by answering challenge/response questions such as VT ID 90 number, First name, Last name, DOB (date of birth), Major etc