regis

<back to all web services

PersonAuthRequest

Requires Authentication
Required role:REGISUserRole
The following routes are available for this service:
POST/person/{uuid}/auth
PersonAuthRequest Parameters:
NameParameterData TypeRequiredDescription
uuidpathstringNo
PersonAuthResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
regent_idformintNo
uuidformstringNo
first_nameformstringNo
last_nameformstringNo
preferred_nameformstringNo
rolesformList<string>No

To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other

HTTP + OTHER

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /person/{uuid}/auth HTTP/1.1 
Host: data.regent-college.edu 
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length

{"uuid":"String"}
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

{"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}},"regent_id":0,"uuid":"String","first_name":"String","last_name":"String","preferred_name":"String","roles":["String"]}