LemonLDAP::NG Manager API (2.0.9)

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

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":