tvpl.api

<back to all web services

AuthenticateWithKeycloak

The following routes are available for this service:
POST/auth/keycloak

export class AuthenticateWithKeycloakResponse
{
    public userId: string;
    public sessionId: string;
    public userName: string;
    public displayName: string;
    public referrerUrl: string;
    public bearerToken: string;
    public profileUrl: string;
    public departmentId?: number;
    public roles: string[];
    public permissions: string[];
    public responseStatus: ResponseStatus;

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

export class AuthenticateWithKeycloak
{
    public accessToken: string;

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

TypeScript AuthenticateWithKeycloak 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 /auth/keycloak HTTP/1.1 
Host: etc-api.vsmlab.vn 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"accessToken":"String"}

HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"userId":"String","sessionId":"String","userName":"String","displayName":"String","referrerUrl":"String","bearerToken":"String","profileUrl":"String","departmentId":0,"roles":["String"],"permissions":["String"],"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}