GET /api/auth_source_ldaps
List all LDAP authentication sources

Params

Param name Description
search
optional

filter results

Validations:

  • Must be String

order
optional

sort results

Validations:

  • Must be String

page
optional

paginate results

Validations:

  • Must be String

per_page
optional

number of entries per request

Validations:

  • Must be 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 String

auth_source_ldap[host]
required

Validations:

  • Must be String

auth_source_ldap[port]
optional , nil allowed

defaults to 389

Validations:

  • Must be a number.

auth_source_ldap[account]
optional , nil allowed

Validations:

  • Must be String

auth_source_ldap[base_dn]
optional , nil allowed

Validations:

  • Must be String

auth_source_ldap[account_password]
optional , nil allowed

required if onthefly_register is true

Validations:

  • Must be String

auth_source_ldap[attr_login]
optional , nil allowed

required if onthefly_register is true

Validations:

  • Must be String

auth_source_ldap[attr_firstname]
optional , nil allowed

required if onthefly_register is true

Validations:

  • Must be String

auth_source_ldap[attr_lastname]
optional , nil allowed

required if onthefly_register is true

Validations:

  • Must be String

auth_source_ldap[attr_mail]
optional , nil allowed

required if onthefly_register is true

Validations:

  • Must be String

auth_source_ldap[attr_photo]
optional , nil allowed

Validations:

  • Must be String

auth_source_ldap[onthefly_register]
optional , nil allowed

Validations:

  • Must be ‘true’ or ‘false’ or ‘1’ or ‘0’

auth_source_ldap[usergroup_sync]
optional , nil allowed

sync external user groups on login

Validations:

  • Must be ‘true’ or ‘false’ or ‘1’ or ‘0’

auth_source_ldap[tls]
optional , nil allowed

Validations:

  • Must be ‘true’ or ‘false’ or ‘1’ or ‘0’

auth_source_ldap[groups_base]
optional , nil allowed

groups base DN

Validations:

  • Must be String

auth_source_ldap[server_type]
optional , nil allowed

type of the LDAP server

Validations:

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

auth_source_ldap[ldap_filter]
optional , nil allowed

LDAP filter

Validations:

  • Must be String


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

Params

Param name Description
id
required

Validations:

  • Must be String

auth_source_ldap
required

Validations:

  • Must be a Hash

auth_source_ldap[name]
optional

Validations:

  • Must be String

auth_source_ldap[host]
optional

Validations:

  • Must be String

auth_source_ldap[port]
optional , nil allowed

defaults to 389

Validations:

  • Must be a number.

auth_source_ldap[account]
optional , nil allowed

Validations:

  • Must be String

auth_source_ldap[base_dn]
optional , nil allowed

Validations:

  • Must be String

auth_source_ldap[account_password]
optional , nil allowed

required if onthefly_register is true

Validations:

  • Must be String

auth_source_ldap[attr_login]
optional , nil allowed

required if onthefly_register is true

Validations:

  • Must be String

auth_source_ldap[attr_firstname]
optional , nil allowed

required if onthefly_register is true

Validations:

  • Must be String

auth_source_ldap[attr_lastname]
optional , nil allowed

required if onthefly_register is true

Validations:

  • Must be String

auth_source_ldap[attr_mail]
optional , nil allowed

required if onthefly_register is true

Validations:

  • Must be String

auth_source_ldap[attr_photo]
optional , nil allowed

Validations:

  • Must be String

auth_source_ldap[onthefly_register]
optional , nil allowed

Validations:

  • Must be ‘true’ or ‘false’ or ‘1’ or ‘0’

auth_source_ldap[usergroup_sync]
optional , nil allowed

sync external user groups on login

Validations:

  • Must be ‘true’ or ‘false’ or ‘1’ or ‘0’

auth_source_ldap[tls]
optional , nil allowed

Validations:

  • Must be ‘true’ or ‘false’ or ‘1’ or ‘0’

auth_source_ldap[groups_base]
optional , nil allowed

groups base DN

Validations:

  • Must be String

auth_source_ldap[server_type]
optional , nil allowed

type of the LDAP server

Validations:

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

auth_source_ldap[ldap_filter]
optional , nil allowed

LDAP filter

Validations:

  • Must be String


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

Params

Param name Description
id
required

Validations:

  • Must be String


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

Params

Param name Description
id
required

Validations:

  • Must be String