Documentation Powered by ReDoc

Infinite Directory manage (1.0.0)

Download OpenAPI specification:Download

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

The API allows to access the users collection.

Authentication

Basic

Security Scheme Type HTTP
HTTP Authorization Scheme basic

Bearer

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

Infinite_Directory_Admin

a directory session bearer with access rights to the frontend

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

Infinite_Directory_Api_Key

an api key allowing 'admin' access on the directory

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

/

list users

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

json body is limited to 1MB

Request Body schema: application/json; charset=utf-8

Non documented. Do not use.

Array of objects

a list of filter objects or compound filters

limit
integer
offset
integer
operator
string
Enum: "AND" "OR"
resultfields
Array of strings

list of fields to retrieve (if implemented), if empty all fields are returned

object

Responses

Request samples

Content type
application/json; charset=utf-8
{
  • "filters": [
    ],
  • "limit": 100,
  • "offset": 200,
  • "operator": "AND",
  • "resultfields": [
    ],
  • "sort": {
    }
}

Response samples

Content type
application/json; charset=utf-8
{
  • "count": 2,
  • "data": [
    ]
}

/{oidcsub}

Authorizations:
BasicInfinite_Directory_Api_KeyBearerInfinite_Directory_Admin
path Parameters
oidcsub
required
string non-empty
Example: auth0|5ccc073f90af3710f269d988

Responses

Response samples

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

/{oidcsub}

get user information

Authorizations:
BasicInfinite_Directory_Api_KeyBearerInfinite_Directory_Admin
path Parameters
oidcsub
required
string non-empty
Example: auth0|5ccc073f90af3710f269d988

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "accessrights": {
    },
  • "displayname": "string",
  • "enabled": true,
  • "frontendaccess": true,
  • "oidcsub": "auth0|5ccc073f90af3710f269d988",
  • "teams": [
    ],
  • "teamuuids": [
    ],
  • "userinfo": {}
}

/{oidcsub}

Authorizations:
BasicInfinite_Directory_Api_KeyBearerInfinite_Directory_Admin
path Parameters
oidcsub
required
string non-empty
Example: auth0|5ccc073f90af3710f269d988
query Parameters
onconflict
string
Default: "upsert"
Enum: "upsert" "update" "insert"

specifies the behaviour of an update/insert request, when a conflict arises with an existing object

header Parameters
content-length
required
integer <= 1048576

json body is limited to 1MB

Request Body schema: application/json; charset=utf-8
object

a list of tags within namespaces

email
string

an optionnal email that will be returned as userinfo until the first connection of user, this field will be ignored if user info are already known

enabled
boolean
frontendaccess
boolean
teamuuids
Array of strings

Responses

Request samples

Content type
application/json; charset=utf-8
{
  • "accessrights": {
    },
  • "email": "string",
  • "enabled": true,
  • "frontendaccess": true,
  • "teamuuids": [
    ]
}

Response samples

Content type
application/json; charset=utf-8
{
  • "status": "upserted"
}

/{oidcsub}/delete_teams

Authorizations:
BasicInfinite_Directory_Api_KeyBearerInfinite_Directory_Admin
path Parameters
oidcsub
required
string non-empty
Example: auth0|5ccc073f90af3710f269d988
header Parameters
content-length
required
integer <= 1048576

json body is limited to 1MB

Request Body schema: application/json; charset=utf-8
Array ()
string [ 1 .. 128 ] characters ^[\{\}\-0-9a-fA-F]+$

the (unique) internal id of the team

Responses

Request samples

Content type
application/json; charset=utf-8
[
  • "string"
]

Response samples

Content type
application/json; charset=utf-8
{
  • "info": [
    ],
  • "ok": 1,
  • "total": 1
}

/{oidcsub}/teams

Authorizations:
BasicInfinite_Directory_Api_KeyBearerInfinite_Directory_Admin
path Parameters
oidcsub
required
string non-empty
Example: auth0|5ccc073f90af3710f269d988
header Parameters
content-length
required
integer <= 1048576

json body is limited to 1MB

Request Body schema: application/json; charset=utf-8
Array ()
string [ 1 .. 128 ] characters ^[\{\}\-0-9a-fA-F]+$

the (unique) internal id of the team

Responses

Request samples

Content type
application/json; charset=utf-8
[
  • "string"
]

Response samples

Content type
application/json; charset=utf-8
{
  • "info": [
    ],
  • "ok": 1,
  • "total": 1
}

/{oidcsub}/teams/{teamuuid}

Authorizations:
BasicInfinite_Directory_Api_KeyBearerInfinite_Directory_Admin
path Parameters
oidcsub
required
string non-empty
Example: auth0|5ccc073f90af3710f269d988
teamuuid
required
string [ 1 .. 128 ] characters ^[\{\}\-0-9a-fA-F]+$

the (unique) internal id of the team

Responses

Response samples

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

/{oidcsub}/teams/{teamuuid}

Authorizations:
BasicInfinite_Directory_Api_KeyBearerInfinite_Directory_Admin
path Parameters
oidcsub
required
string non-empty
Example: auth0|5ccc073f90af3710f269d988
teamuuid
required
string [ 1 .. 128 ] characters ^[\{\}\-0-9a-fA-F]+$

the (unique) internal id of the team

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "status": "added"
}