Onboard Web Application

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. Applicant creation of Guest ID

Entrypoint

https://[dev.][pprd.]onboard.it.vt.edu/applicantCreate

Scenario

Used by an applicant who has created an account with Slate/Coalition to create their Guest ID. The applicant must authenticate to Onboard by entering their VT ID 90 number, DOB (date of birth), and the email on the application.

Optional query params

  1. return_uri: URL where Onboard will return the applicant at the end of account creation. Must be in a whitelisted domain
    1. prod: vt.edu
    2. pprd: vt.edu, technolutions.net
    3. dev: vt.edu, technolutions.net
  2. admission type: Admission type (a) set to one of the following types:
    1. agtech to skip address and contact email address set to agtech@vt.edu: URL?a=agtech
    2. grad to skip address page and contact email address set to grads@vt.edu : URL?a=grad
    3. none provided. Default behavior is to skip address page and contact email address set to admissions@vt.edu

To add to the whitelisted domains, please open a ticket at 4help for SIS Identity Strategy & Solutions.

2. 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. A typical known use case is graduate students creating Guest ID for login at Slate to apply to Virgina Tech.

Optional query params

  1. return_uri: URL where Onboard will return the user at the end of account creation. Must be in a whitelisted domain
    1. prod: vt.edu
    2. pprd: vt.edu, technolutions.net
    3. dev: vt.edu, technolutions.net
  2. admission type: Admission type (a) set to one of the following types:
    1. agtech to skip address and contact email address set to agtech@vt.edu: URL?a=agtech
    2. grad to skip address page and contact email address set to grads@vt.edu : URL?a=grad
    3. none provided. Default behavior is to skip address page and contact email address set to admissions@vt.edu

To add to the whitelisted domains, please open a ticket at 4help for SIS Identity Strategy & Solutions.

3. 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 query params

  1. return_uri: 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_uri=https://example.vt.edu”.
    Must be in a whitelisted domain.
    1. prod: vt.edu
    2. pprd: vt.edu, technolutions.net
    3. dev: vt.edu, technolutions.net

4. 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 a Guest ID to create VT Username. The applicant must authenticate to Onboard by logging in with their Guest ID.

5. 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