Documentation Powered by ReDoc

Infinite Directory (1.0.0)

Download OpenAPI specification:Download

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

Infinite Directory api

Authentication

Basic

Security Scheme Type HTTP
HTTP Authorization Scheme basic

Bearer

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

Infinite_Directory_Api_Key

an api key allowing 'admin' access on the directory

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

Infinite_Directory_Session

a directory session bearer

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

/.well-known/jwks.json

return the Json Web Key Set to validate Directory and Data sessions bearers. RFC7517

Responses

Response samples

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

/getversion

return version of the api

query Parameters
timebasechallenge
string 32 characters ^[0-9a-f]{32}$
Example: timebasechallenge=6177a9051e304cf69357fe3e96c97ec1

find

status
boolean
Default: false

checks and returns the status of the directory in the 'status' field

html
boolean
Default: false

returns an html page instead of json

Responses

Response samples

Content type
application/json; charset=utf-8
application/json; charset=utf-8
text/html; charset=utf-8
{
  • "comment": "string",
  • "status": "green",
  • "timebase": "string",
  • "type": "proxyapi",
  • "version": {
    }
}

/getversionprotected

same as getversion but with credentials, used for measuring performances

Authorizations:
BasicInfinite_Directory_Api_KeyBearerInfinite_Directory_Session
query Parameters
timebasechallenge
string 32 characters ^[0-9a-f]{32}$
Example: timebasechallenge=6177a9051e304cf69357fe3e96c97ec1

find

status
boolean
Default: false

checks and returns the status of the directory in the 'status' field

html
boolean
Default: false

returns an html page instead of json

Responses

Response samples

Content type
application/json; charset=utf-8
application/json; charset=utf-8
text/html; charset=utf-8
{
  • "comment": "string",
  • "status": "green",
  • "timebase": "string",
  • "type": "proxyapi",
  • "version": {
    }
}

/getwebapi

redirect to the web api js file

query Parameters
version
required
string
Enum: "3.3" "3.2" "3.1"

Responses

Response samples

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

/introspect

This endpoint implements OAuth 2.0 Token Introspection. It allows third party backends to validate a Directory or Data session access token delivered by an ∞Directory. The access token should be sent in a POST request with Content-Type: application/x-www-form-urlencoded.\n This endpoint is protected by the ∞Directory postgres admin credentials Authorization: Basic cG9zdGdyZXM6cHdk.\n Note that you should add a time based cache system on your backend to avoid saturating this endpoint.\n

Authorizations:
BasicInfinite_Directory_Api_Key
header Parameters
content-length
required
integer <= 1048576

url encoded body is limited to 1MB

Request Body schema: application/x-www-form-urlencoded; charset=utf-8
token
required
string <jwt> >= 6 characters

token that should be validated

Responses

Request samples

Content type
application/x-www-form-urlencoded; charset=utf-8
token=eyJhbGciOiJIUzI1NiJ9.e30.ZRrHA1JJJW8opsbCGfG_HACGpVUMN_a9IV7pAx_Zmeo

Response samples

Content type
application/json; charset=utf-8
{
  • "active": false,
  • "error": "string"
}