GET /api/auth_source_ldaps
List all authsource ldaps

Params

Param name Description
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 authsource ldap.

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 auth_source_ldap.

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

defaults to 389


Value:

Must be a number.

auth_source_ldap[account]
optional

Value:

Must be String

auth_source_ldap[base_dn]
optional

Value:

Must be String

auth_source_ldap[account_password]
optional

required if onthefly_register is true


Value:

Must be String

auth_source_ldap[attr_login]
optional

required if onthefly_register is true


Value:

Must be String

auth_source_ldap[attr_firstname]
optional

required if onthefly_register is true


Value:

Must be String

auth_source_ldap[attr_lastname]
optional

required if onthefly_register is true


Value:

Must be String

auth_source_ldap[attr_mail]
optional

required if onthefly_register is true


Value:

Must be String

auth_source_ldap[attr_photo]
optional

Value:

Must be String

auth_source_ldap[onthefly_register]
optional

Value:

Must be 'true' or 'false'

auth_source_ldap[usergroup_sync]
optional

sync external user groups on login


Value:

Must be 'true' or 'false'

auth_source_ldap[tls]
optional

Value:

Must be 'true' or 'false'


PUT /api/auth_source_ldaps/:id
Update an auth_source_ldap.

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

defaults to 389


Value:

Must be a number.

auth_source_ldap[account]
optional

Value:

Must be String

auth_source_ldap[base_dn]
optional

Value:

Must be String

auth_source_ldap[account_password]
optional

required if onthefly_register is true


Value:

Must be String

auth_source_ldap[attr_login]
optional

required if onthefly_register is true


Value:

Must be String

auth_source_ldap[attr_firstname]
optional

required if onthefly_register is true


Value:

Must be String

auth_source_ldap[attr_lastname]
optional

required if onthefly_register is true


Value:

Must be String

auth_source_ldap[attr_mail]
optional

required if onthefly_register is true


Value:

Must be String

auth_source_ldap[attr_photo]
optional

Value:

Must be String

auth_source_ldap[onthefly_register]
optional

Value:

Must be 'true' or 'false'

auth_source_ldap[usergroup_sync]
optional

sync external user groups on login


Value:

Must be 'true' or 'false'

auth_source_ldap[tls]
optional

Value:

Must be 'true' or 'false'


DELETE /api/auth_source_ldaps/:id
Delete an auth_source_ldap.

Params

Param name Description
id
required

Value:

Must be String