Identity System API

This API provides Identity Data from Registry

NOTE: Shanghai data is not available in this version._**

NOTE:

dept_code = Workday Supervisory Org for employee

dept_code = SIS Academic Org for student

dept_code = School code (for eg. PY code is Tandon School of Engineering) for alumni

Access to this API is strictly governed by the respective data stewards and their approval. There are multiple steps for gaining access to this API. Please follow the order as follows

1. Submit a request through the API access form and follow instructions as stated.
2. On completion and approval of the API access form, Logout of this API portal and Login as the "Service Account/Special purpose ID" as stated by you in the API access form and click on the "Request Access" button on the top right corner of this page. Create a new application and name it to reflect your client application and is identifiable to the API team (please do not use spaces or special characters). Once the application is created and you have submitted the access request, you will receive a client_id and client_secret
3. Follow the instructions for getting an OAuth2.0 access token.

Please refer to the NYU Developer Portal for more information on APIs, tools, testing etc.

In case of any questions please feel free to reachout to us at api-team@nyu.edu

How to Access the API:

To gain access to the API, please follow these steps:

• Complete the API Access Approval Form:
  • Visit https://approval.api.it.nyu.edu.
  • Click on “API Access.”
  • Fill out the form to the best of your knowledge.
• Approval Process:
  • Architecture Review Board (ARB) Review:
    • After receiving your request, we will contact you to schedule an ARB Review meeting. During this review, ARB will evaluate your technical implementation to ensure it meets technology requirements and security standards. This step includes producing a set of supporting documents that will be used for final Data Steward Approval. Expect this process to take approximately two to three weeks.
  • Data Steward Approval:
    • Upon completion of the ARB Review, your request will be forwarded to Data Stewards for final approval. This step may take up to three weeks to complete.