GET /api/auth_source_ldaps
List all LDAP authentication sources

GET /api/locations/:location_id/auth_source_ldaps
List LDAP authentication sources per location

GET /api/organizations/:organization_id/auth_source_ldaps
List LDAP authentication sources per organization

Examples

GET /api/auth_source_ldaps
200
{
  "total": 1,
  "subtotal": 1,
  "page": 1,
  "per_page": 20,
  "search": null,
  "sort": {
    "by": null,
    "order": null
  },
  "results": [
    {
      "host": "ldap",
      "port": 123,
      "account": null,
      "base_dn": "dn=x,dn=y",
      "ldap_filter": null,
      "attr_login": "uid",
      "attr_firstname": "givenName",
      "attr_lastname": "sn",
      "attr_mail": "mail",
      "attr_photo": null,
      "onthefly_register": true,
      "usergroup_sync": true,
      "tls": true,
      "server_type": "posix",
      "groups_base": null,
      "use_netgroups": false,
      "created_at": "2018-07-24 12:43:14 UTC",
      "updated_at": "2018-07-24 12:43:14 UTC",
      "id": 980190962,
      "type": "AuthSourceLdap",
      "name": "ldap-server",
      "locations": [
        {
          "id": 255093256,
          "name": "Location 1",
          "title": "Location 1",
          "description": null
        }
      ],
      "organizations": [
        {
          "id": 447626438,
          "name": "Organization 1",
          "title": "Organization 1",
          "description": null
        }
      ]
    }
  ]
}

Params

Param name Description
location_id
optional

Scope by locations

Validations:

  • Must be a Integer
organization_id
optional

Scope by organizations

Validations:

  • Must be a Integer
search
optional

filter results

Validations:

  • Must be a String
order
optional

Sort field and order, eg. ‘id DESC’

Validations:

  • Must be a String
page
optional

paginate results

Validations:

  • Must be a String
per_page
optional

number of entries per request

Validations:

  • Must be a String

Search fields

Field name Type Possible values
location string
location_id integer
name string
organization string
organization_id integer