GET /api/auth_source_ldaps
列出所有 LDAP 的認證來源

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

示例

GET /api/auth_source_ldaps
200
{
  "total": 1,
  "subtotal": 1,
  "page": 1,
  "per_page": 20,
  "search": null,
  "sort": {
    "by": null,
    "order": null
  },
  "results": [
    {
      "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": null,
      "onthefly_register": true,
      "usergroup_sync": true,
      "tls": true,
      "server_type": "posix",
      "groups_base": null,
      "use_netgroups": false,
      "created_at": "2019-11-07 08:51:03 UTC",
      "updated_at": "2019-11-07 08:51:03 UTC",
      "id": 980190962,
      "type": "AuthSourceLdap",
      "name": "ldap-server",
      "locations": [
        {
          "id": 255093256,
          "name": "Location 1",
          "title": "Location 1",
          "description": null
        }
      ],
      "organizations": [
        {
          "id": 447626438,
          "name": "Organization 1",
          "title": "Organization 1",
          "description": null
        }
      ]
    }
  ]
}

參數

參數名字 描述
location_id
選填

位置範圍

Validations:

  • Must be a Integer

organization_id
選填

組織範圍

Validations:

  • Must be a Integer

search
選填

篩選結果

Validations:

  • Must be a String

order
選填

Sort field and order, eg. ‘id DESC’

Validations:

  • Must be a String

page
選填

頁數,從 1 開始

Validations:

  • Must be a number.

per_page
選填

每頁要傳回的結果數量

Validations:

  • Must be a number.

Search fields

Field name 類型 Possible values
location string
location_id integer
name string
organization string
organization_id integer

GET /api/auth_source_ldaps/:id
顯示一項 LDAP 認證來源

示例

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": null,
  "onthefly_register": true,
  "usergroup_sync": true,
  "tls": true,
  "server_type": "posix",
  "groups_base": null,
  "use_netgroups": false,
  "created_at": "2019-11-07 08:51:03 UTC",
  "updated_at": "2019-11-07 08:51:03 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
    }
  ]
}

參數

參數名字 描述
location_id
選填

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
選填

Set the current organization context for the request

Validations:

  • Must be a Integer

id
必填

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
建立 LDAP 認證來源

示例

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": null,
  "attr_firstname": null,
  "attr_lastname": null,
  "attr_mail": null,
  "attr_photo": null,
  "onthefly_register": false,
  "usergroup_sync": true,
  "tls": false,
  "server_type": "posix",
  "groups_base": null,
  "use_netgroups": false,
  "created_at": "2019-11-07 08:51:15 UTC",
  "updated_at": "2019-11-07 08:51:15 UTC",
  "id": 980190964,
  "type": "AuthSourceLdap",
  "name": "ldap2",
  "external_usergroups": [],
  "locations": [],
  "organizations": []
}

參數

參數名字 描述
location_id
選填

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
選填

Set the current organization context for the request

Validations:

  • Must be a Integer

auth_source_ldap
必填

Validations:

  • Must be a Hash

auth_source_ldap[name]
必填

Validations:

  • Must be a String

auth_source_ldap[host]
必填

Validations:

  • Must be a String

auth_source_ldap[port]
選填 , 允許空值

預設為 389

Validations:

  • Must be a number.

auth_source_ldap[account]
選填 , 允許空值

Validations:

  • Must be a String

auth_source_ldap[base_dn]
選填 , 允許空值

Validations:

  • Must be a String

auth_source_ldap[account_password]
選填 , 允許空值

若 onthefly_register 為 true 的話便需要

Validations:

  • Must be a String

auth_source_ldap[attr_login]
選填 , 允許空值

若 onthefly_register 為 true 的話便需要

Validations:

  • Must be a String

auth_source_ldap[attr_firstname]
選填 , 允許空值

若 onthefly_register 為 true 的話便需要

Validations:

  • Must be a String

auth_source_ldap[attr_lastname]
選填 , 允許空值

若 onthefly_register 為 true 的話便需要

Validations:

  • Must be a String

auth_source_ldap[attr_mail]
選填 , 允許空值

若 onthefly_register 為 true 的話便需要

Validations:

  • Must be a String

auth_source_ldap[attr_photo]
選填 , 允許空值

Validations:

  • Must be a String

auth_source_ldap[onthefly_register]
選填 , 允許空值

Validations:

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

auth_source_ldap[usergroup_sync]
選填 , 允許空值

登入時同步外部使用者群組

Validations:

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

auth_source_ldap[tls]
選填 , 允許空值

Validations:

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

auth_source_ldap[groups_base]
選填 , 允許空值

群組基礎 DN

Validations:

  • Must be a String

auth_source_ldap[use_netgroups]
選填 , 允許空值

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]
選填 , 允許空值

LDAP 伺服器類型

Validations:

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

auth_source_ldap[ldap_filter]
選填 , 允許空值

LDAP過濾器

Validations:

  • Must be a String

auth_source_ldap[location_ids]
選填 , 允許空值

將位置取代為特定 ID

Validations:

  • Must be an array of any type

auth_source_ldap[organization_ids]
選填 , 允許空值

將組織取代為特定 ID。

Validations:

  • Must be an array of any type


PUT /api/auth_source_ldaps/:id
更新 LDAP 認證來源

示例

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": null,
  "onthefly_register": true,
  "usergroup_sync": true,
  "tls": true,
  "server_type": "posix",
  "groups_base": null,
  "use_netgroups": false,
  "created_at": "2019-11-07 08:51:03 UTC",
  "updated_at": "2019-11-07 08:51:15 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
    }
  ]
}

參數

參數名字 描述
location_id
選填

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
選填

Set the current organization context for the request

Validations:

  • Must be a Integer

id
必填

Validations:

  • Must be a String

auth_source_ldap
必填

Validations:

  • Must be a Hash

auth_source_ldap[name]
選填

Validations:

  • Must be a String

auth_source_ldap[host]
選填

Validations:

  • Must be a String

auth_source_ldap[port]
選填 , 允許空值

預設為 389

Validations:

  • Must be a number.

auth_source_ldap[account]
選填 , 允許空值

Validations:

  • Must be a String

auth_source_ldap[base_dn]
選填 , 允許空值

Validations:

  • Must be a String

auth_source_ldap[account_password]
選填 , 允許空值

若 onthefly_register 為 true 的話便需要

Validations:

  • Must be a String

auth_source_ldap[attr_login]
選填 , 允許空值

若 onthefly_register 為 true 的話便需要

Validations:

  • Must be a String

auth_source_ldap[attr_firstname]
選填 , 允許空值

若 onthefly_register 為 true 的話便需要

Validations:

  • Must be a String

auth_source_ldap[attr_lastname]
選填 , 允許空值

若 onthefly_register 為 true 的話便需要

Validations:

  • Must be a String

auth_source_ldap[attr_mail]
選填 , 允許空值

若 onthefly_register 為 true 的話便需要

Validations:

  • Must be a String

auth_source_ldap[attr_photo]
選填 , 允許空值

Validations:

  • Must be a String

auth_source_ldap[onthefly_register]
選填 , 允許空值

Validations:

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

auth_source_ldap[usergroup_sync]
選填 , 允許空值

登入時同步外部使用者群組

Validations:

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

auth_source_ldap[tls]
選填 , 允許空值

Validations:

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

auth_source_ldap[groups_base]
選填 , 允許空值

群組基礎 DN

Validations:

  • Must be a String

auth_source_ldap[use_netgroups]
選填 , 允許空值

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]
選填 , 允許空值

LDAP 伺服器類型

Validations:

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

auth_source_ldap[ldap_filter]
選填 , 允許空值

LDAP過濾器

Validations:

  • Must be a String

auth_source_ldap[location_ids]
選填 , 允許空值

將位置取代為特定 ID

Validations:

  • Must be an array of any type

auth_source_ldap[organization_ids]
選填 , 允許空值

將組織取代為特定 ID。

Validations:

  • Must be an array of any type


PUT /api/auth_source_ldaps/:id/test
測試 LDAP 連線

示例

PUT /api/auth_source_ldaps/980190962-ldap-server/test
{
  "auth_source_ldap": {}
}
500
{
  "error": {
    "message": "wrong number of arguments (given 0, expected 1+)"
  }
}

參數

參數名字 描述
location_id
選填

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
選填

Set the current organization context for the request

Validations:

  • Must be a Integer

id
必填

Validations:

  • Must be a String


DELETE /api/auth_source_ldaps/:id
刪除 LDAP 認證來源

示例

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": "2019-11-07T08:51:03.056Z",
  "updated_at": "2019-11-07T08:51:03.056Z",
  "ldap_filter": null,
  "attr_photo": null,
  "server_type": "posix",
  "groups_base": null,
  "usergroup_sync": true,
  "use_netgroups": false
}

參數

參數名字 描述
location_id
選填

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
選填

Set the current organization context for the request

Validations:

  • Must be a Integer

id
必填

Validations:

  • Must be a String