tvpl.api

<back to all web services

AuthenticateWithKeycloak

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

public class AuthenticateWithKeycloak : Codable
{
    public var accessToken:String

    required public init(){}
}

public class AuthenticateWithKeycloakResponse : Codable
{
    public var bearerToken:String
    public var refreshToken:String
    public var sessionId:String
    public var userName:String
    public var displayName:String
    public var responseStatus:ResponseStatus

    required public init(){}
}


Swift AuthenticateWithKeycloak DTOs

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

HTTP + XML

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: application/xml
Content-Type: application/xml
Content-Length: length

<AuthenticateWithKeycloak xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/tvpl.api.ServiceInterface">
  <AccessToken>String</AccessToken>
</AuthenticateWithKeycloak>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<AuthenticateWithKeycloakResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/tvpl.api.ServiceInterface">
  <BearerToken>String</BearerToken>
  <DisplayName>String</DisplayName>
  <RefreshToken>String</RefreshToken>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
  <SessionId>String</SessionId>
  <UserName>String</UserName>
</AuthenticateWithKeycloakResponse>