API docs by Redocly

LemonLDAP::NG Manager API (2.17)

Download OpenAPI specification:Download

The Manager API allows an administrator to modify the LemonLDAP::NG configuration programmatically. It is not meant to be accessed by end users. The client libraries mentionned in examples can be generated from doc/sources/manager-api/openapi-spec.yaml

samlsp

SAML Service Providers

Create a new SAML Service provider

Request Body schema: application/json

SAML Service provider to add

confKey
required
string (confKey) ^\w[\w\.\-]*$
metadata
required
string
exportedAttributes
object
macros
object
object (samlOptions)

Responses

Request samples

Content type
application/json
{
  • "confKey": "string",
  • "metadata": "<?xml version=\"1.0\"?><EntityDescriptor...",
  • "exportedAttributes": { },
  • "macros": {
    },
  • "options": {
    }
}

Response samples

Content type
application/json
{
  • "error": "string"
}

Finds SAML Service providers by configuration key

Takes a search pattern to be tested against existing service providers

query Parameters
pattern
required
string
Examples:
  • pattern=* - Any value
  • pattern=zone1-* - Given prefix
  • pattern=something - Substring

Search pattern

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Finds SAML Service Provider by Entity ID

query Parameters
entityId
required
string
Example: entityId=http://mysp.example.com/saml/metadata

Entity ID to search

Responses

Response samples

Content type
application/json
{
  • "confKey": "string",
  • "metadata": "<?xml version=\"1.0\"?><EntityDescriptor...",
  • "exportedAttributes": { },
  • "macros": {
    },
  • "options": {
    }
}

Get SAML Service Provider by configuration key

Returns a single Service Provider

path Parameters
confKey
required
string (confKey) ^\w[\w\.\-]*$

Configuration key of SAML Service Provider

Responses

Response samples

Content type
application/json
{
  • "confKey": "string",
  • "metadata": "<?xml version=\"1.0\"?><EntityDescriptor...",
  • "exportedAttributes": { },
  • "macros": {
    },
  • "options": {
    }
}

Replaces a SAML Service

path Parameters
confKey
required
string (confKey) ^\w[\w\.\-]*$

Configuration key of SAML Service Provider that needs to be replaced

Request Body schema: application/json
metadata
required
string
macros
object
exportedAttributes
object
object (samlOptions)

Responses

Request samples

Content type
application/json
{
  • "metadata": "<?xml version=\"1.0\"?><EntityDescriptor...",
  • "macros": {
    },
  • "exportedAttributes": { },
  • "options": {
    }
}

Response samples

Content type
application/json
{
  • "error": "string"
}

Updates a SAML Service.

path Parameters
confKey
required
string (confKey) ^\w[\w\.\-]*$

Configuration key of SAML Service Provider that needs to be updated

Request Body schema: application/json
metadata
string
macros
object
exportedAttributes
object
object (samlOptions)

Responses

Request samples

Content type
application/json
{
  • "metadata": "<?xml version=\"1.0\"?><EntityDescriptor...",
  • "macros": {
    },
  • "exportedAttributes": { },
  • "options": {
    }
}

Response samples

Content type
application/json
{
  • "error": "string"
}

Deletes a SAML Service Provider

path Parameters
confKey
required
string (confKey) ^\w[\w\.\-]*$

Configuration key of SAML Service Provider to delete

Responses

Response samples

Content type
application/json
{
  • "error": "string"
}

oidcrp

OpenID Connect Relaying Parties

Create a new OpenID Connect Relaying Party

Request Body schema: application/json

OpenID Connect Relaying Party to add

confKey
required
string (confKey) ^\w[\w\.\-]*$
clientId
required
string
redirectUris
required
Array of strings <uri> [ items <uri > non-empty ]
exportedVars
object
extraClaims
object
macros
object
object (OidcOptions)
scopeRules
object

Responses

Request samples

Content type
application/json
{
  • "confKey": "string",
  • "clientId": "string",
  • "redirectUris": [],
  • "exportedVars": {
    },
  • "extraClaims": {
    },
  • "macros": {
    },
  • "options": {
    },
  • "scopeRules": {
    }
}

Response samples

Content type
application/json
{
  • "error": "string"
}

Finds OpenID Connect Relaying Partys by configuration key

Takes a search pattern to be tested against existing service providers

query Parameters
pattern
required
string (confKey) ^\w[\w\.\-]*$
Examples:
  • pattern=* - Any value
  • pattern=zone1-* - Given prefix
  • pattern=something - Substring

Search pattern

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Finds OpenID Connect Relaying Party by Client ID

query Parameters
clientId
required
string
Example: clientId=my_client_id

Client ID to search

Responses

Response samples

Content type
application/json
{
  • "confKey": "string",
  • "clientId": "string",
  • "redirectUris": [],
  • "exportedVars": {
    },
  • "extraClaims": {
    },
  • "macros": {
    },
  • "options": {
    },
  • "scopeRules": {
    }
}

Get OpenID Connect Relaying Party by configuration key

Returns a single Service Provider

path Parameters
confKey
required
string (confKey) ^\w[\w\.\-]*$

Configuration key of OpenID Connect Relaying Party

Responses

Response samples

Content type
application/json
{
  • "confKey": "string",
  • "clientId": "string",
  • "redirectUris": [],
  • "exportedVars": {
    },
  • "extraClaims": {
    },
  • "macros": {
    },
  • "options": {
    },
  • "scopeRules": {
    }
}

Updates an OpenID Connect Relaying Party

path Parameters
confKey
required
string (confKey) ^\w[\w\.\-]*$

Configuration key of OpenID Connect Relaying Party that needs to be updated

Request Body schema: application/json
clientId
string
exportedVars
object
extraClaims
object
macros
object
object (OidcOptions)
scopeRules
object

Responses

Request samples

Content type
application/json
{
  • "clientId": "string",
  • "exportedVars": {
    },
  • "extraClaims": {
    },
  • "macros": {
    },
  • "options": {
    },
  • "scopeRules": {
    }
}

Response samples

Content type
application/json
{
  • "error": "string"
}

Replaces an OpenID Connect Relaying Party

path Parameters
confKey
required
string (confKey) ^\w[\w\.\-]*$

Configuration key of OpenID Connect Relaying Party that needs to be replaced

Request Body schema: application/json
clientId
required
string
exportedVars
object
extraClaims
object
macros
object
object (OidcOptions)
scopeRules
object

Responses

Request samples

Content type
application/json
{
  • "clientId": "string",
  • "exportedVars": {
    },
  • "extraClaims": {
    },
  • "macros": {
    },
  • "options": {
    },
  • "scopeRules": {
    }
}

Response samples

Content type
application/json
{
  • "error": "string"
}

Deletes a OpenID Connect Relaying Party

path Parameters
confKey
required
string (confKey) ^\w[\w\.\-]*$

Configuration key of OpenID Connect Relaying Party to delete

Responses

Response samples

Content type
application/json
{
  • "error": "string"
}

2fa

Registered Second Factors

List second factors for a user

path Parameters
uid
required
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Delete all second factors for a user

path Parameters
uid
required
string

Responses

Response samples

Content type
application/json
{
  • "error": "string"
}

List second factors for a user given its type

path Parameters
uid
required
string
type
required
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Delete all second factors of a given type for a user

path Parameters
uid
required
string
type
required
string

Responses

Response samples

Content type
application/json
{
  • "error": "string"
}

Get second factors for a user given its ID

path Parameters
uid
required
string
id
required
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Delete a second factors for a user

path Parameters
uid
required
string
id
required
string

Responses

Response samples

Content type
application/json
{
  • "error": "string"
}

history

Login history

Get the login history for a user

path Parameters
uid
required
string
query Parameters
result
string
Enum: "success" "failed" "any"

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get the last history event for a user

path Parameters
uid
required
string
query Parameters
result
string
Enum: "success" "failed" "any"

Responses

Response samples

Content type
application/json
{
  • "date": "string",
  • "ipAddr": "string",
  • "result": "success",
  • "error": 0
}

Check the status of the API

Responses

Response samples

Content type
application/json
{
  • "name": "string",
  • "version": "string",
  • "status_sessions": "ok",
  • "status_psessions": "ok",
  • "status_config": "ok",
  • "status": "ok"
}

casapp

Create a new CAS Application

Request Body schema: application/json

CAS Application to add

confKey
required
string (confKey) ^\w[\w\.\-]*$
exportedVars
object
Default: {"cn":"cn","mail":"mail","uid":"uid"}
macros
object
object (casOptions)

Responses

Request samples

Content type
application/json
{
  • "confKey": "string",
  • "exportedVars": {
    },
  • "macros": {
    },
  • "options": {}
}

Response samples

Content type
application/json
{
  • "error": "string"
}

Finds CAS applications by configuration key

Takes a search pattern to be tested against existing applications

query Parameters
pattern
required
string
Examples:
  • pattern=* - Any value
  • pattern=zone1-* - Given prefix
  • pattern=something - Substring

Search pattern

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get CAS Application by Service URL

query Parameters
serviceUrl
required
string
Example: serviceUrl=http://mycasapp.example.com/

Service URL to search

Responses

Response samples

Content type
application/json
{
  • "confKey": "string",
  • "exportedVars": {
    },
  • "macros": {
    },
  • "options": {}
}

Get CAS Application by configuration key

Returns a single Application

path Parameters
confKey
required
string (confKey) ^\w[\w\.\-]*$

Configuration key of CAS Application

Responses

Response samples

Content type
application/json
{
  • "confKey": "string",
  • "exportedVars": {
    },
  • "macros": {
    },
  • "options": {}
}

Replaces a CAS Application

path Parameters
confKey
required
string (confKey) ^\w[\w\.\-]*$

Configuration key of CAS Application that needs to be replaced

Request Body schema: application/json
macros
object
exportedVars
object
Default: {"cn":"cn","mail":"mail","uid":"uid"}
object (casOptions)

Responses

Request samples

Content type
application/json
{
  • "macros": {
    },
  • "exportedVars": {
    },
  • "options": {}
}

Response samples

Content type
application/json
{
  • "error": "string"
}

Updates a CAS Application.

path Parameters
confKey
required
string (confKey) ^\w[\w\.\-]*$

Configuration key of CAS Application that needs to be updated

Request Body schema: application/json
macros
object
exportedVars
object
Default: {"cn":"cn","mail":"mail","uid":"uid"}
object (casOptions)

Responses

Request samples

Content type
application/json
{
  • "macros": {
    },
  • "exportedVars": {
    },
  • "options": {}
}

Response samples

Content type
application/json
{
  • "error": "string"
}

Deletes a CAS Application

path Parameters
confKey
required
string (confKey) ^\w[\w\.\-]*$

Configuration key of CAS Application to delete

Responses

Response samples

Content type
application/json
{
  • "error": "string"
}

menucat

Create a new Menu Category

Request Body schema: application/json

Menu Category to add

confKey
required
string (confKey) ^\w[\w\.\-]*$
catname
required
string
order
integer

Responses

Request samples

Content type
application/json
{
  • "confKey": "string",
  • "catname": "string",
  • "order": 0
}

Response samples

Content type
application/json
{
  • "error": "string"
}

Finds Menu Categories by configuration key

Takes a search pattern to be tested against existing categories

query Parameters
pattern
required
string
Examples:
  • pattern=* - Any value
  • pattern=zone1-* - Given prefix
  • pattern=something - Substring

Search pattern

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get Menu Category by configuration key

Returns a single Category

path Parameters
confKey
required
string (confKey) ^\w[\w\.\-]*$

Configuration key of Menu Category

Responses

Response samples

Content type
application/json
{
  • "confKey": "string",
  • "catname": "string",
  • "order": 0
}

Replaces a Menu Category

path Parameters
confKey
required
string (confKey) ^\w[\w\.\-]*$

Configuration key of Menu Category that needs to be replaced

Request Body schema: application/json
confKey
required
string (confKey) ^\w[\w\.\-]*$
catname
required
string
order
integer

Responses

Request samples

Content type
application/json
{
  • "confKey": "string",
  • "catname": "string",
  • "order": 0
}

Response samples

Content type
application/json
{
  • "error": "string"
}

Updates a Menu Category

path Parameters
confKey
required
string (confKey) ^\w[\w\.\-]*$

Configuration key of Menu Category that needs to be updated

Request Body schema: application/json
catname
string
order
integer

Responses

Request samples

Content type
application/json
{
  • "catname": "string",
  • "order": 0
}

Response samples

Content type
application/json
{
  • "error": "string"
}

Deletes a Menu Category

path Parameters
confKey
required
string (confKey) ^\w[\w\.\-]*$

Configuration key of Menu Category to delete

Responses

Response samples

Content type
application/json
{
  • "error": "string"
}

menuapp

Get Menu Applications within a Menu Category

Return existing applications within a menu category

path Parameters
cat
required
string (menuCatConfKey) ^\w[\w\.\-]*$

Configuration key of Menu Category to work with

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a new Menu Application within a Menu Category

path Parameters
cat
required
string (menuCatConfKey) ^\w[\w\.\-]*$

Configuration key of Menu Category to work with

Request Body schema: application/json

Menu Application to add

confKey
required
string (confKey) ^\w[\w\.\-]*$
order
integer
object (MenuAppOptions)

Responses

Request samples

Content type
application/json
{
  • "confKey": "string",
  • "order": 0,
  • "options": {
    }
}

Response samples

Content type
application/json
{
  • "error": "string"
}

Finds Menu Applications by configuration key within a Menu Category

Takes a search pattern to be tested against existing applications within a menu category

path Parameters
cat
required
string (menuCatConfKey) ^\w[\w\.\-]*$

Configuration key of Menu Category to work with

query Parameters
pattern
required
string
Examples:
  • pattern=* - Any value
  • pattern=zone1-* - Given prefix
  • pattern=something - Substring

Search pattern

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get Menu Application within a Menu Category by configuration key

Returns a single application

path Parameters
cat
required
string (menuCatConfKey) ^\w[\w\.\-]*$

Configuration key of Menu Category to work with

confKey
required
string (confKey) ^\w[\w\.\-]*$

Configuration key of Menu Application

Responses

Response samples

Content type
application/json
{
  • "confKey": "string",
  • "order": 0,
  • "options": {
    }
}

Replaces a Menu Application

path Parameters
cat
required
string (menuCatConfKey) ^\w[\w\.\-]*$

Configuration key of Menu Category to work with

confKey
required
string (confKey) ^\w[\w\.\-]*$

Configuration key of Menu Application that needs to be replaced

Request Body schema: application/json
confKey
required
string (confKey) ^\w[\w\.\-]*$
order
integer
object (MenuAppOptions)

Responses

Request samples

Content type
application/json
{
  • "confKey": "string",
  • "order": 0,
  • "options": {
    }
}

Response samples

Content type
application/json
{
  • "error": "string"
}

Updates a Menu Application

path Parameters
cat
required
string (menuCatConfKey) ^\w[\w\.\-]*$

Configuration key of Menu Category to work with

confKey
required
string (confKey) ^\w[\w\.\-]*$

Configuration key of Menu Application that needs to be updated

Request Body schema: application/json
order
integer
object (MenuAppOptions)

Responses

Request samples

Content type
application/json
{
  • "order": 0,
  • "options": {
    }
}

Response samples

Content type
application/json
{
  • "error": "string"
}

Deletes a Menu Application

path Parameters
cat
required
string (menuCatConfKey) ^\w[\w\.\-]*$

Configuration key of Menu Category to work with

confKey
required
string (confKey) ^\w[\w\.\-]*$

Configuration key of Menu Application to delete

Responses

Response samples

Content type
application/json
{
  • "error": "string"
}