Auth source ldaps

>>>

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
403
{
  "error": {
    "message": "Access denied",
    "details": "Missing one of the required permissions: view_authenticators",
    "missing_permissions": [
      "view_authenticators"
    ]
  }
}

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

Page number, starting at 1

Validations:

  • Must be a number.
per_page
optional

Number of results per page to return, ‘all’ to return all results

Validations:

  • Must match regular expression /\A([1-9]\d|all)\Z$/.

Search fields

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

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

Examples

GET /api/auth_source_ldaps/980190962-ldap-server
200
{
  "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": "jpegPhoto",
  "onthefly_register": true,
  "usergroup_sync": true,
  "tls": true,
  "server_type": "posix",
  "groups_base": null,
  "use_netgroups": false,
  "created_at": "2021-05-19 07:30:49 UTC",
  "updated_at": "2021-05-19 07:30:49 UTC",
  "id": 980190962,
  "type": "AuthSourceLdap",
  "name": "ldap-server",
  "external_usergroups": [],
  "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

Set the current location context for the request

Validations:

  • Must be a Integer
organization_id
optional

Set the current organization context for the request

Validations:

  • Must be a Integer
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

Examples

POST /api/auth_source_ldaps
{
  "auth_source_ldap": {
    "name": "ldap2",
    "host": "ldap2",
    "server_type": "posix"
  }
}
201
{
  "host": "ldap2",
  "port": 389,
  "account": null,
  "base_dn": null,
  "ldap_filter": null,
  "attr_login": "uid",
  "attr_firstname": "givenName",
  "attr_lastname": "sn",
  "attr_mail": "mail",
  "attr_photo": "jpegPhoto",
  "onthefly_register": false,
  "usergroup_sync": true,
  "tls": false,
  "server_type": "posix",
  "groups_base": null,
  "use_netgroups": false,
  "created_at": "2021-05-19 08:00:13 UTC",
  "updated_at": "2021-05-19 08:00:13 UTC",
  "id": 980190965,
  "type": "AuthSourceLdap",
  "name": "ldap2",
  "external_usergroups": [],
  "locations": [],
  "organizations": []
}

Params

Param name Description
location_id
optional

Set the current location context for the request

Validations:

  • Must be a Integer
organization_id
optional

Set the current organization context for the request

Validations:

  • Must be a Integer
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 , nil allowed

defaults to 389

Validations:

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

Validations:

  • Must be a String
auth_source_ldap[base_dn]
optional , nil allowed

Validations:

  • Must be a String
auth_source_ldap[account_password]
optional , nil allowed

required if onthefly_register is true

Validations:

  • Must be a String
auth_source_ldap[attr_login]
optional , nil allowed

required if onthefly_register is true

Validations:

  • Must be a String
auth_source_ldap[attr_firstname]
optional , nil allowed

required if onthefly_register is true

Validations:

  • Must be a String
auth_source_ldap[attr_lastname]
optional , nil allowed

required if onthefly_register is true

Validations:

  • Must be a String
auth_source_ldap[attr_mail]
optional , nil allowed

required if onthefly_register is true

Validations:

  • Must be a String
auth_source_ldap[attr_photo]
optional , nil allowed

Validations:

  • Must be a String
auth_source_ldap[onthefly_register]
optional , nil allowed

Validations:

  • Must be one of: true, false, 1, 0.
auth_source_ldap[usergroup_sync]
optional , nil allowed

sync external user groups on login

Validations:

  • Must be one of: true, false, 1, 0.
auth_source_ldap[tls]
optional , nil allowed

Validations:

  • Must be one of: true, false, 1, 0.
auth_source_ldap[groups_base]
optional , nil allowed

groups base DN

Validations:

  • Must be a String
auth_source_ldap[use_netgroups]
optional , nil allowed

use NIS netgroups instead of posix groups, applicable only when server_type is posix or free_ipa

Validations:

  • Must be one of: true, false, 1, 0.
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 a String
auth_source_ldap[location_ids]
optional , nil allowed

REPLACE locations with given ids

Validations:

  • Must be an array of any type
auth_source_ldap[organization_ids]
optional , nil allowed

REPLACE organizations with given ids.

Validations:

  • Must be an array of any type
>>>

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

Examples

PUT /api/auth_source_ldaps/980190962-ldap-server
{
  "auth_source_ldap": {
    "name": "ldap2",
    "host": "ldap2",
    "server_type": "posix"
  }
}
200
{
  "host": "ldap2",
  "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": "jpegPhoto",
  "onthefly_register": true,
  "usergroup_sync": true,
  "tls": true,
  "server_type": "posix",
  "groups_base": null,
  "use_netgroups": false,
  "created_at": "2021-05-19 07:59:51 UTC",
  "updated_at": "2021-05-19 08:00:13 UTC",
  "id": 980190962,
  "type": "AuthSourceLdap",
  "name": "ldap2",
  "external_usergroups": [],
  "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

Set the current location context for the request

Validations:

  • Must be a Integer
organization_id
optional

Set the current organization context for the request

Validations:

  • Must be a Integer
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 , nil allowed

defaults to 389

Validations:

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

Validations:

  • Must be a String
auth_source_ldap[base_dn]
optional , nil allowed

Validations:

  • Must be a String
auth_source_ldap[account_password]
optional , nil allowed

required if onthefly_register is true

Validations:

  • Must be a String
auth_source_ldap[attr_login]
optional , nil allowed

required if onthefly_register is true

Validations:

  • Must be a String
auth_source_ldap[attr_firstname]
optional , nil allowed

required if onthefly_register is true

Validations:

  • Must be a String
auth_source_ldap[attr_lastname]
optional , nil allowed

required if onthefly_register is true

Validations:

  • Must be a String
auth_source_ldap[attr_mail]
optional , nil allowed

required if onthefly_register is true

Validations:

  • Must be a String
auth_source_ldap[attr_photo]
optional , nil allowed

Validations:

  • Must be a String
auth_source_ldap[onthefly_register]
optional , nil allowed

Validations:

  • Must be one of: true, false, 1, 0.
auth_source_ldap[usergroup_sync]
optional , nil allowed

sync external user groups on login

Validations:

  • Must be one of: true, false, 1, 0.
auth_source_ldap[tls]
optional , nil allowed

Validations:

  • Must be one of: true, false, 1, 0.
auth_source_ldap[groups_base]
optional , nil allowed

groups base DN

Validations:

  • Must be a String
auth_source_ldap[use_netgroups]
optional , nil allowed

use NIS netgroups instead of posix groups, applicable only when server_type is posix or free_ipa

Validations:

  • Must be one of: true, false, 1, 0.
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 a String
auth_source_ldap[location_ids]
optional , nil allowed

REPLACE locations with given ids

Validations:

  • Must be an array of any type
auth_source_ldap[organization_ids]
optional , nil allowed

REPLACE organizations with given ids.

Validations:

  • Must be an array of any type
>>>

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

Examples

PUT /api/auth_source_ldaps/980190962-ldap-server/test
{
  "auth_source_ldap": {}
}
200
{
  "id": 980190962,
  "type": "AuthSourceLdap",
  "name": "ldap-server",
  "success": true,
  "message": "success"
}

Params

Param name Description
location_id
optional

Set the current location context for the request

Validations:

  • Must be a Integer
organization_id
optional

Set the current organization context for the request

Validations:

  • Must be a Integer
id
required

Validations:

  • Must be a String
>>>

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

Examples

DELETE /api/auth_source_ldaps/980190962
{
  "auth_source_ldap": {}
}
200
{
  "id": 980190962,
  "name": "ldap-server",
  "host": "ldap",
  "port": 123,
  "account": null,
  "account_password": null,
  "base_dn": "dn=x,dn=y",
  "attr_login": "uid",
  "attr_firstname": "givenName",
  "attr_lastname": "sn",
  "attr_mail": "mail",
  "onthefly_register": true,
  "tls": true,
  "created_at": "2021-05-19T07:59:51.425Z",
  "updated_at": "2021-05-19T07:59:51.425Z",
  "ldap_filter": null,
  "attr_photo": "jpegPhoto",
  "server_type": "posix",
  "groups_base": null,
  "usergroup_sync": true,
  "use_netgroups": false
}

Params

Param name Description
location_id
optional

Set the current location context for the request

Validations:

  • Must be a Integer
organization_id
optional

Set the current organization context for the request

Validations:

  • Must be a Integer
id
required

Validations:

  • Must be a String