Dartmouth API Developer Portal
Netid Generator API
Generates new netids from an underlying sequence generator. This function will only be made available to systems that generate netids for identity management.
Rating
| Attribute | Value |
|---|---|
| Highly Available | No; direct Oracle connection |
| Cache Refresh Interval | N/A |
| Filtering | No |
POST
The POST call creates/consumes the next netid available from the sequence and returns it to the consumer.
Required Scopes
| Scope | Description |
|---|---|
| api:identity:netid:write | This scope is required to access this API. Granting of this scope is restricted to only applications having to generate netids. |
Request
POST /api/identity/netid
Required Headers
Authorization: Bearer {jwt}
POST Body
{
"posting_type":"TRIAL"
}
Notes on usage
The call can operate in a testing mode (called TRIAL) or production mode (called COMMIT). The testing mode allows the endpoint to be tested including a call to the database without consuming a new netid. In TRIAL mode the string "testing" is returned as the netid in the payload. Use the posting_type attribute to specify either TRIAL or COMMIT. Only those two values are allowed.
Returns
| Status Code | Description |
|---|---|
| 200 | The URI parameter {netid} passed in is a valid identity |
| 403 | Correct scope was not supplied |
Sample Return
{
"netid": "testing"
}