regis

<back to all web services

PersonAuthRequest

Requires Authentication
Required role:REGISUserRole
The following routes are available for this service:
POST/person/{uuid}/auth

export class PersonAuthResponse
{
    public responseStatus: ResponseStatus;
    public regent_id: number;
    public uuid: string;
    public first_name: string;
    public last_name: string;
    public preferred_name: string;
    public roles: string[];

    public constructor(init?: Partial<PersonAuthResponse>) { (Object as any).assign(this, init); }
}

export class PersonAuthRequest
{
    public uuid: string;

    public constructor(init?: Partial<PersonAuthRequest>) { (Object as any).assign(this, init); }
}

TypeScript PersonAuthRequest DTOs

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

HTTP + CSV

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

{"uuid":"String"}
HTTP/1.1 200 OK
Content-Type: text/csv
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"]}