regis

PersonAuthRequest

**Requires Authentication**
Required role:	REGISUserRole

The following routes are available for this service:
POST	/person/{uuid}/auth

"use strict";
export class PersonAuthResponse {
    /** @param {{responseStatus?:ResponseStatus,regent_id?:number,uuid?:string,first_name?:string,last_name?:string,preferred_name?:string,roles?:string[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ResponseStatus} */
    responseStatus;
    /** @type {number} */
    regent_id;
    /** @type {string} */
    uuid;
    /** @type {string} */
    first_name;
    /** @type {string} */
    last_name;
    /** @type {string} */
    preferred_name;
    /** @type {string[]} */
    roles;
}
export class PersonAuthRequest {
    /** @param {{uuid?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    uuid;
}

JavaScript PersonAuthRequest DTOs

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

HTTP + JSV

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/jsv
Content-Type: text/jsv
Content-Length: length

{
	uuid: String
}

HTTP/1.1 200 OK
Content-Type: text/jsv
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
	]
}