Documentation Powered by ReDoc

Infinite Directory session (1.0.0)

Download OpenAPI specification:Download

E-mail: support@realfusio.com License: Close Source

Infinite Directory session api

Authentication

Basic

Security Scheme Type HTTP
HTTP Authorization Scheme basic

Bearer

Security Scheme Type HTTP
HTTP Authorization Scheme bearer
Bearer format "JWT"

Infinite_Data_Session

a data session bearer

Security Scheme Type API Key
Header parameter name: x-infinite-bearer

Infinite_Directory_Session

a directory session bearer

Security Scheme Type API Key
Header parameter name: x-infinite-bearer

Infinite_Internal

an internal bearer used to protect license reporting

Security Scheme Type API Key
Header parameter name: x-infinite-bearer

Infinite_No_Auth

Security Scheme Type API Key
Header parameter name: x-infinite-no-auth

/applications

list applications available for this user

Authorizations:
BearerInfinite_Directory_Session

Responses

Response samples

Content type
application/json; charset=utf-8
[
  • {
    }
]

/authenticate

Initiates new directory session

query Parameters
nativetoken
string non-empty

n/a

claims
required
string
Enum: "access:client" "access:frontend" "access:client-dev"

n/a

appclaims
Array of strings

claims requested by third party app. They should match user thirdpartyscopes access rights.

needextendedbearer
boolean
Default: false

if set directory will deliver an extended bearer containing user oidc, team list and tags allowing to manage user data access in a third party backend, or to use the asset store

appdata
string

application data that will be delivered on final redirect to redirecturl

redirecturl
required
string <url> ^http(s)?://.*$

final redirect url were caller will be redirected at the end of authentication process

cookie Parameters
directory_sso
string

Responses

/borrowlicense

Notifies backend about a LMX borrow operation. Used only by the native client.

Authorizations:
BearerInfinite_Directory_Session
query Parameters
action
required
string
Enum: "checkin" "checkout" "renew"

borrow action

nativetoken
required
string non-empty

n/a

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "code": "E_UnknownError",
  • "error": true,
  • "uuid": "string"
}

/close

Closes a directory session

Authorizations:
BearerInfinite_Directory_Session
query Parameters
forceuserconsentonnextlogin
required
boolean

tells if the user should be completely logged out (if true, user must reconnect to the openid server (no SSO))

Responses

/heartbeat

Maintains directory session alive and renew token

Authorizations:
BearerInfinite_Directory_Session

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "buildrentsec": 0,
  • "claims": "string",
  • "clientmaxidledurationsec": 0,
  • "directory_access_token": "string",
  • "displayname": "string",
  • "heartbeat_before": 0,
  • "http_access_token": "string",
  • "lmxborrowsec": 0,
  • "lmxfeature": "string",
  • "lmxserver": "string",
  • "session_eol": 0,
  • "subinfo": { }
}

/onauthenticated

Processes OpenId Connect server response. Any unexpected query parameter will be ignored and silently discarded.

query Parameters
code
string non-empty

code returned by the OpenId Connect server

error
string non-empty

error code returned by the open id connect

error_description
string >= 0 characters

error description returned by the open id connect

error_uri
string >= 0 characters

error page returned by the open id connect

state
required
string

internal state

Responses

/onauthenticationdone Deprecated

Returns final redirect page used for native client authentication, deprecated, nows redirect to /directory/api/static/onauthenticationdone.html

Responses

/registerfrontenduserandredirecturl

Initiates registration of a user to use directory front end

Authorizations:
BasicInfinite_No_Auth
query Parameters
redirecturl
required
string

the url to register for allowing redirects

Responses

/userinfo

returns user informations

Authorizations:
BearerInfinite_Directory_Session

Responses

Response samples

Content type
application/json; charset=utf-8
{ }

/waitforauthentication

Waits for the authentication rountrip, only used by the native client

Authorizations:
Infinite_Internal
query Parameters
timeoutsec
integer [ 0 .. 60 ]

how many time should we wait for backend response in seconds

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "buildrentsec": 0,
  • "claims": "string",
  • "clientmaxidledurationsec": 0,
  • "directory_access_token": "string",
  • "displayname": "string",
  • "heartbeat_before": 0,
  • "http_access_token": "string",
  • "lmxborrowsec": 0,
  • "lmxfeature": "string",
  • "lmxserver": "string",
  • "session_eol": 0,
  • "subinfo": { }
}