GET /api/auth_source_ldaps
List all LDAP authentication sources

Params

Param name Description
search
optional

filter results


Value: Must be String
order
optional

sort results


Value: Must be String
page
optional

paginate results


Value: Must be String
per_page
optional

number of entries per request


Value: Must be String

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

Params

Param name Description
id
required

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

Value: Must be a Hash
auth_source_ldap[name]
required

Value: Must be String
auth_source_ldap[host]
required

Value: Must be String
auth_source_ldap[port]
optional , nil allowed

defaults to 389


Value: Must be a number.
auth_source_ldap[account]
optional , nil allowed

Value: Must be String
auth_source_ldap[base_dn]
optional , nil allowed

Value: Must be String
auth_source_ldap[account_password]
optional , nil allowed

required if onthefly_register is true


Value: Must be String
auth_source_ldap[attr_login]
optional , nil allowed

required if onthefly_register is true


Value: Must be String
auth_source_ldap[attr_firstname]
optional , nil allowed

required if onthefly_register is true


Value: Must be String
auth_source_ldap[attr_lastname]
optional , nil allowed

required if onthefly_register is true


Value: Must be String
auth_source_ldap[attr_mail]
optional , nil allowed

required if onthefly_register is true


Value: Must be String
auth_source_ldap[attr_photo]
optional , nil allowed

Value: Must be String
auth_source_ldap[onthefly_register]
optional , nil allowed

Value: Must be 'true' or 'false'
auth_source_ldap[usergroup_sync]
optional , nil allowed

sync external user groups on login


Value: Must be 'true' or 'false'
auth_source_ldap[tls]
optional , nil allowed

Value: Must be 'true' or 'false'
auth_source_ldap[groups_base]
optional , nil allowed

groups base DN


Value: Must be String
auth_source_ldap[server_type]
optional , nil allowed

type of the LDAP server


Value: Must be one of: free_ipa, active_directory, posix.
auth_source_ldap[ldap_filter]
optional , nil allowed

LDAP filter


Value: Must be String

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

Params

Param name Description
id
required

Value: Must be String
auth_source_ldap
required

Value: Must be a Hash
auth_source_ldap[name]
optional

Value: Must be String
auth_source_ldap[host]
optional

Value: Must be String
auth_source_ldap[port]
optional , nil allowed

defaults to 389


Value: Must be a number.
auth_source_ldap[account]
optional , nil allowed

Value: Must be String
auth_source_ldap[base_dn]
optional , nil allowed

Value: Must be String
auth_source_ldap[account_password]
optional , nil allowed

required if onthefly_register is true


Value: Must be String
auth_source_ldap[attr_login]
optional , nil allowed

required if onthefly_register is true


Value: Must be String
auth_source_ldap[attr_firstname]
optional , nil allowed

required if onthefly_register is true


Value: Must be String
auth_source_ldap[attr_lastname]
optional , nil allowed

required if onthefly_register is true


Value: Must be String
auth_source_ldap[attr_mail]
optional , nil allowed

required if onthefly_register is true


Value: Must be String
auth_source_ldap[attr_photo]
optional , nil allowed

Value: Must be String
auth_source_ldap[onthefly_register]
optional , nil allowed

Value: Must be 'true' or 'false'
auth_source_ldap[usergroup_sync]
optional , nil allowed

sync external user groups on login


Value: Must be 'true' or 'false'
auth_source_ldap[tls]
optional , nil allowed

Value: Must be 'true' or 'false'
auth_source_ldap[groups_base]
optional , nil allowed

groups base DN


Value: Must be String
auth_source_ldap[server_type]
optional , nil allowed

type of the LDAP server


Value: Must be one of: free_ipa, active_directory, posix.
auth_source_ldap[ldap_filter]
optional , nil allowed

LDAP filter


Value: Must be String

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

Params

Param name Description
id
required

Value: Must be String