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 organisation

Params

Param Name Description
location_id
Optional

Scope by locations

Validations:

  • Must be a Integer

organization_id
Optional

Scope by organisations

Validations:

  • Must be a Integer

search
Optional

filter results

Validations:

  • Must be a String

order
Optional

sort results

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


GET /api/auth_source_ldaps/:id
Show an LDAP authentication source

Params

Param Name Description
id
Required

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.


POST /api/auth_source_ldaps
Create an LDAP authentication source

Params

Param Name Description
auth_source_ldap
Required

Validations:

  • Must be a Hash

auth_source_ldap[name]
Required

Validations:

  • Must be a String

auth_source_ldap[host]
Required

Validations:

  • Must be a String

auth_source_ldap[port]
Optional , <span class="translation_missing" title="translation missing: en-GB.apipie.nil_allowed">Nil Allowed</span>

defaults to 389

Validations:

  • Must be a number.

auth_source_ldap[account]
Optional , <span class="translation_missing" title="translation missing: en-GB.apipie.nil_allowed">Nil Allowed</span>

Validations:

  • Must be a String

auth_source_ldap[base_dn]
Optional , <span class="translation_missing" title="translation missing: en-GB.apipie.nil_allowed">Nil Allowed</span>

Validations:

  • Must be a String

auth_source_ldap[account_password]
Optional , <span class="translation_missing" title="translation missing: en-GB.apipie.nil_allowed">Nil Allowed</span>

required if onthefly_register is true

Validations:

  • Must be a String

auth_source_ldap[attr_login]
Optional , <span class="translation_missing" title="translation missing: en-GB.apipie.nil_allowed">Nil Allowed</span>

required if onthefly_register is true

Validations:

  • Must be a String

auth_source_ldap[attr_firstname]
Optional , <span class="translation_missing" title="translation missing: en-GB.apipie.nil_allowed">Nil Allowed</span>

required if onthefly_register is true

Validations:

  • Must be a String

auth_source_ldap[attr_lastname]
Optional , <span class="translation_missing" title="translation missing: en-GB.apipie.nil_allowed">Nil Allowed</span>

required if onthefly_register is true

Validations:

  • Must be a String

auth_source_ldap[attr_mail]
Optional , <span class="translation_missing" title="translation missing: en-GB.apipie.nil_allowed">Nil Allowed</span>

required if onthefly_register is true

Validations:

  • Must be a String

auth_source_ldap[attr_photo]
Optional , <span class="translation_missing" title="translation missing: en-GB.apipie.nil_allowed">Nil Allowed</span>

Validations:

  • Must be a String

auth_source_ldap[onthefly_register]
Optional , <span class="translation_missing" title="translation missing: en-GB.apipie.nil_allowed">Nil Allowed</span>

Validations:

  • Must be one of: true, false, 1, 0

auth_source_ldap[usergroup_sync]
Optional , <span class="translation_missing" title="translation missing: en-GB.apipie.nil_allowed">Nil Allowed</span>

sync external user groups on login

Validations:

  • Must be one of: true, false, 1, 0

auth_source_ldap[tls]
Optional , <span class="translation_missing" title="translation missing: en-GB.apipie.nil_allowed">Nil Allowed</span>

Validations:

  • Must be one of: true, false, 1, 0

auth_source_ldap[groups_base]
Optional , <span class="translation_missing" title="translation missing: en-GB.apipie.nil_allowed">Nil Allowed</span>

groups base DN

Validations:

  • Must be a String

auth_source_ldap[server_type]
Optional , <span class="translation_missing" title="translation missing: en-GB.apipie.nil_allowed">Nil Allowed</span>

type of the LDAP server

Validations:

  • Must be one of: free_ipa, active_directory, posix.

auth_source_ldap[ldap_filter]
Optional , <span class="translation_missing" title="translation missing: en-GB.apipie.nil_allowed">Nil Allowed</span>

LDAP filter

Validations:

  • Must be a String

auth_source_ldap[location_ids]
Optional , <span class="translation_missing" title="translation missing: en-GB.apipie.nil_allowed">Nil Allowed</span>

REPLACE locations with given ids

Validations:

  • Must be an array of any type

auth_source_ldap[organization_ids]
Optional , <span class="translation_missing" title="translation missing: en-GB.apipie.nil_allowed">Nil Allowed</span>

REPLACE organisations with given ids.

Validations:

  • Must be an array of any type


PUT /api/auth_source_ldaps/:id
Update an LDAP authentication source

Params

Param Name Description
id
Required

Validations:

  • Must be a String

auth_source_ldap
Required

Validations:

  • Must be a Hash

auth_source_ldap[name]
Optional

Validations:

  • Must be a String

auth_source_ldap[host]
Optional

Validations:

  • Must be a String

auth_source_ldap[port]
Optional , <span class="translation_missing" title="translation missing: en-GB.apipie.nil_allowed">Nil Allowed</span>

defaults to 389

Validations:

  • Must be a number.

auth_source_ldap[account]
Optional , <span class="translation_missing" title="translation missing: en-GB.apipie.nil_allowed">Nil Allowed</span>

Validations:

  • Must be a String

auth_source_ldap[base_dn]
Optional , <span class="translation_missing" title="translation missing: en-GB.apipie.nil_allowed">Nil Allowed</span>

Validations:

  • Must be a String

auth_source_ldap[account_password]
Optional , <span class="translation_missing" title="translation missing: en-GB.apipie.nil_allowed">Nil Allowed</span>

required if onthefly_register is true

Validations:

  • Must be a String

auth_source_ldap[attr_login]
Optional , <span class="translation_missing" title="translation missing: en-GB.apipie.nil_allowed">Nil Allowed</span>

required if onthefly_register is true

Validations:

  • Must be a String

auth_source_ldap[attr_firstname]
Optional , <span class="translation_missing" title="translation missing: en-GB.apipie.nil_allowed">Nil Allowed</span>

required if onthefly_register is true

Validations:

  • Must be a String

auth_source_ldap[attr_lastname]
Optional , <span class="translation_missing" title="translation missing: en-GB.apipie.nil_allowed">Nil Allowed</span>

required if onthefly_register is true

Validations:

  • Must be a String

auth_source_ldap[attr_mail]
Optional , <span class="translation_missing" title="translation missing: en-GB.apipie.nil_allowed">Nil Allowed</span>

required if onthefly_register is true

Validations:

  • Must be a String

auth_source_ldap[attr_photo]
Optional , <span class="translation_missing" title="translation missing: en-GB.apipie.nil_allowed">Nil Allowed</span>

Validations:

  • Must be a String

auth_source_ldap[onthefly_register]
Optional , <span class="translation_missing" title="translation missing: en-GB.apipie.nil_allowed">Nil Allowed</span>

Validations:

  • Must be one of: true, false, 1, 0

auth_source_ldap[usergroup_sync]
Optional , <span class="translation_missing" title="translation missing: en-GB.apipie.nil_allowed">Nil Allowed</span>

sync external user groups on login

Validations:

  • Must be one of: true, false, 1, 0

auth_source_ldap[tls]
Optional , <span class="translation_missing" title="translation missing: en-GB.apipie.nil_allowed">Nil Allowed</span>

Validations:

  • Must be one of: true, false, 1, 0

auth_source_ldap[groups_base]
Optional , <span class="translation_missing" title="translation missing: en-GB.apipie.nil_allowed">Nil Allowed</span>

groups base DN

Validations:

  • Must be a String

auth_source_ldap[server_type]
Optional , <span class="translation_missing" title="translation missing: en-GB.apipie.nil_allowed">Nil Allowed</span>

type of the LDAP server

Validations:

  • Must be one of: free_ipa, active_directory, posix.

auth_source_ldap[ldap_filter]
Optional , <span class="translation_missing" title="translation missing: en-GB.apipie.nil_allowed">Nil Allowed</span>

LDAP filter

Validations:

  • Must be a String

auth_source_ldap[location_ids]
Optional , <span class="translation_missing" title="translation missing: en-GB.apipie.nil_allowed">Nil Allowed</span>

REPLACE locations with given ids

Validations:

  • Must be an array of any type

auth_source_ldap[organization_ids]
Optional , <span class="translation_missing" title="translation missing: en-GB.apipie.nil_allowed">Nil Allowed</span>

REPLACE organisations with given ids.

Validations:

  • Must be an array of any type


PUT /api/auth_source_ldaps/:id/test
Test LDAP connection

Params

Param Name Description
id
Required

Validations:

  • Must be a String


DELETE /api/auth_source_ldaps/:id
Delete an LDAP authentication source

Params

Param Name Description
id
Required

Validations:

  • Must be a String