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 teams 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 teams

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": [
    ]
}

/{teamuuid}

Authorizations:
BasicInfinite_Directory_Api_KeyBearerInfinite_Directory_Admin
path Parameters
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"
}

/{teamuuid}

Authorizations:
BasicInfinite_Directory_Api_KeyBearerInfinite_Directory_Admin
path Parameters
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
{
  • "accessrights": {
    },
  • "teamname": "admin",
  • "teamuuid": "string"
}

/{teamuuid}

Create/edit a team

Authorizations:
BasicInfinite_Directory_Api_KeyBearerInfinite_Directory_Admin
path Parameters
teamuuid
required
string [ 1 .. 128 ] characters ^[\{\}\-0-9a-fA-F]+$

the (unique) internal id of the team

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

teamname
required
string [ 1 .. 128 ] characters ^[a-zA-Z0-9_\-\. ]+$

the (unique) name of the team

Responses

Request samples

Content type
application/json; charset=utf-8
{
  • "accessrights": {
    },
  • "teamname": "admin"
}

Response samples

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