tvpl.api

<back to all web services

AuthenticateWithKeycloak

The following routes are available for this service:
POST/auth/keycloak
Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports tvpl.api.ServiceInterface

Namespace Global

    Namespace tvpl.api.ServiceInterface

        Public Partial Class AuthenticateWithKeycloak
            Public Overridable Property AccessToken As String
        End Class

        Public Partial Class AuthenticateWithKeycloakResponse
            Public Sub New()
                Roles = New List(Of String)
                Permissions = New List(Of String)
            End Sub

            Public Overridable Property UserId As String
            Public Overridable Property SessionId As String
            Public Overridable Property UserName As String
            Public Overridable Property DisplayName As String
            Public Overridable Property ReferrerUrl As String
            Public Overridable Property BearerToken As String
            Public Overridable Property ProfileUrl As String
            Public Overridable Property DepartmentId As Nullable(Of Integer)
            Public Overridable Property Roles As List(Of String)
            Public Overridable Property Permissions As List(Of String)
            Public Overridable Property ResponseStatus As ResponseStatus
        End Class
    End Namespace
End Namespace

VB.NET 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>
  <DepartmentId>0</DepartmentId>
  <DisplayName>String</DisplayName>
  <Permissions xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </Permissions>
  <ProfileUrl>String</ProfileUrl>
  <ReferrerUrl>String</ReferrerUrl>
  <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>
  <Roles xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </Roles>
  <SessionId>String</SessionId>
  <UserId>String</UserId>
  <UserName>String</UserName>
</AuthenticateWithKeycloakResponse>